summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorXavier Morel <xmo@openerp.com>2014-11-06 11:42:02 +0100
committerXavier Morel <xmo@openerp.com>2014-11-06 11:42:02 +0100
commit4bc8f086af456a4ab6b4e7b7605687c4e3a52d22 (patch)
treeddf75cdb9f87fbbc0731d4128c5d3d8bcdcad994 /doc/reference
parent812c257094a80abbafc7c6bbd88c99af7251aa62 (diff)
[FIX] doc: guides section was removed, move CDN to reference
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/cdn.rst79
-rw-r--r--doc/reference/cdn/keycdn_create_a_pull_zone.pngbin0 -> 53723 bytes
-rw-r--r--doc/reference/cdn/keycdn_enable_CORS.pngbin0 -> 12282 bytes
-rw-r--r--doc/reference/cdn/keycdn_progressbar.pngbin0 -> 46540 bytes
-rw-r--r--doc/reference/cdn/odoo_cdn_base_url.pngbin0 -> 13193 bytes
-rw-r--r--doc/reference/cdn/odoo_check_your_html.pngbin0 -> 35812 bytes
-rw-r--r--doc/reference/cdn/odoo_font_file_not_loaded.pngbin0 -> 6786 bytes
-rw-r--r--doc/reference/cdn/odoo_security_message.pngbin0 -> 7891 bytes
8 files changed, 79 insertions, 0 deletions
diff --git a/doc/reference/cdn.rst b/doc/reference/cdn.rst
new file mode 100644
index 00000000000..76678a140d3
--- /dev/null
+++ b/doc/reference/cdn.rst
@@ -0,0 +1,79 @@
+========================================
+Deploying with Content Delivery Networks
+========================================
+
+.. _reference/cdn/keycdn:
+
+Deploying with KeyCDN_
+======================
+
+.. sectionauthor:: Fabien Meghazi
+
+This document will guide you through the setup of a KeyCDN_ account with your
+Odoo powered website.
+
+Step 1: Create a pull zone in the KeyCDN dashboard
+--------------------------------------------------
+
+.. image:: cdn/keycdn_create_a_pull_zone.png
+ :class: img-responsive
+
+When creating the zone, enable the CORS option in the
+:guilabel:`advanced features` submenu. (more on that later)
+
+.. image:: cdn/keycdn_enable_CORS.png
+ :class: img-responsive
+
+Once done, you'll have to wait a bit while KeyCDN is crawling your website.
+
+.. image:: cdn/keycdn_progressbar.png
+ :class: img-responsive
+
+.. note:: a new URL has been generated for your Zone, in this case it is
+ ``http://pulltest-b49.kxcdn.com``
+
+Step 2: Configure the odoo instance with your zone
+--------------------------------------------------
+
+In the Odoo back end, go to the :guilabel:`Website Settings`: menu, then
+activate the CDN support and copy/paste your zone URL in the
+:guilabel:`CDN Base URL` field.
+
+.. image:: cdn/odoo_cdn_base_url.png
+ :class: img-responsive
+
+Now your website is using the CDN for the resources matching the
+:guilabel:`CDN filters` regular expressions.
+
+You can have a look to the HTML of your website in order to check if the CDN
+integration is properly working.
+
+.. image:: cdn/odoo_check_your_html.png
+ :class: img-responsive
+
+
+Why should I activate CORS?
+---------------------------
+
+A security restriction in some browsers (Firefox and Chrome at time of writing)
+prevents a remotely linked CSS file to fetch relative resources on this same
+external server.
+
+If you don't activate the CORS option in the CDN zone, the more obvious
+resulting problem on a default Odoo website will be the lack of font-awesome
+icons because the font file declared in the font-awesome CSS won't be loaded on
+the remote server.
+
+Here's what you would see on your homepage in such a case:
+
+.. image:: cdn/odoo_font_file_not_loaded.png
+ :class: img-responsive
+
+A security error message will also appear in the browser's console:
+
+.. image:: cdn/odoo_security_message.png
+ :class: img-responsive
+
+Enabling the CORS option in the CDN fixes this issue.
+
+.. _KeyCDN: https://www.keycdn.com
diff --git a/doc/reference/cdn/keycdn_create_a_pull_zone.png b/doc/reference/cdn/keycdn_create_a_pull_zone.png
new file mode 100644
index 00000000000..ae8d8e2936e
--- /dev/null
+++ b/doc/reference/cdn/keycdn_create_a_pull_zone.png
Binary files differ
diff --git a/doc/reference/cdn/keycdn_enable_CORS.png b/doc/reference/cdn/keycdn_enable_CORS.png
new file mode 100644
index 00000000000..f95c240657f
--- /dev/null
+++ b/doc/reference/cdn/keycdn_enable_CORS.png
Binary files differ
diff --git a/doc/reference/cdn/keycdn_progressbar.png b/doc/reference/cdn/keycdn_progressbar.png
new file mode 100644
index 00000000000..e40c819dc63
--- /dev/null
+++ b/doc/reference/cdn/keycdn_progressbar.png
Binary files differ
diff --git a/doc/reference/cdn/odoo_cdn_base_url.png b/doc/reference/cdn/odoo_cdn_base_url.png
new file mode 100644
index 00000000000..e5c7c185a26
--- /dev/null
+++ b/doc/reference/cdn/odoo_cdn_base_url.png
Binary files differ
diff --git a/doc/reference/cdn/odoo_check_your_html.png b/doc/reference/cdn/odoo_check_your_html.png
new file mode 100644
index 00000000000..542afe943e8
--- /dev/null
+++ b/doc/reference/cdn/odoo_check_your_html.png
Binary files differ
diff --git a/doc/reference/cdn/odoo_font_file_not_loaded.png b/doc/reference/cdn/odoo_font_file_not_loaded.png
new file mode 100644
index 00000000000..e695261fddc
--- /dev/null
+++ b/doc/reference/cdn/odoo_font_file_not_loaded.png
Binary files differ
diff --git a/doc/reference/cdn/odoo_security_message.png b/doc/reference/cdn/odoo_security_message.png
new file mode 100644
index 00000000000..68b860f2ee9
--- /dev/null
+++ b/doc/reference/cdn/odoo_security_message.png
Binary files differ