[ADD] Website KeyCDN integration guide

diff --git a/doc/guides.rst b/doc/guides.rst
index 00fea8d..bf80711 100644 (file)
--- a/doc/guides.rst
+++ b/doc/guides.rst
@@ -8,5 +8,6 @@ Guides
     guides/forms
     guides/themes
     guides/snippets
+    guides/website_keycdn
     guides/workflows
     guides/deployment

diff --git a/doc/guides/cdn/keycdn_create_a_pull_zone.png b/doc/guides/cdn/keycdn_create_a_pull_zone.png
new file mode 100644 (file)
index 0000000..ae8d8e2
Binary files /dev/null and b/doc/guides/cdn/keycdn_create_a_pull_zone.png differ

diff --git a/doc/guides/cdn/keycdn_enable_CORS.png b/doc/guides/cdn/keycdn_enable_CORS.png
new file mode 100644 (file)
index 0000000..f95c240
Binary files /dev/null and b/doc/guides/cdn/keycdn_enable_CORS.png differ

diff --git a/doc/guides/cdn/keycdn_progressbar.png b/doc/guides/cdn/keycdn_progressbar.png
new file mode 100644 (file)
index 0000000..e40c819
Binary files /dev/null and b/doc/guides/cdn/keycdn_progressbar.png differ

diff --git a/doc/guides/cdn/odoo_cdn_base_url.png b/doc/guides/cdn/odoo_cdn_base_url.png
new file mode 100644 (file)
index 0000000..e5c7c18
Binary files /dev/null and b/doc/guides/cdn/odoo_cdn_base_url.png differ

diff --git a/doc/guides/cdn/odoo_check_your_html.png b/doc/guides/cdn/odoo_check_your_html.png
new file mode 100644 (file)
index 0000000..542afe9
Binary files /dev/null and b/doc/guides/cdn/odoo_check_your_html.png differ

diff --git a/doc/guides/cdn/odoo_font_file_not_loaded.png b/doc/guides/cdn/odoo_font_file_not_loaded.png
new file mode 100644 (file)
index 0000000..e695261
Binary files /dev/null and b/doc/guides/cdn/odoo_font_file_not_loaded.png differ

diff --git a/doc/guides/cdn/odoo_security_message.png b/doc/guides/cdn/odoo_security_message.png
new file mode 100644 (file)
index 0000000..68b860f
Binary files /dev/null and b/doc/guides/cdn/odoo_security_message.png differ

diff --git a/doc/guides/website_keycdn.rst b/doc/guides/website_keycdn.rst
new file mode 100644 (file)
index 0000000..383c16a
--- /dev/null
+++ b/doc/guides/website_keycdn.rst
@@ -0,0 +1,73 @@
+.. _keycdn-setup:
+
+How to use KeyCDN with Odoo
+===========================
+
+.. 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 `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 that an URL has been generated for your Zone.
+In this test case, the URL is `http://pulltest-b49.kxcdn.com`.
+
+
+Step 2: Configure the odoo instance with your zone
+--------------------------------------------------
+
+In the Odoo back end, go to the `Website Settings` menu, then activate the CDN
+support and copy/paste your zone URL in the `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 `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.