.. contents:: Table of Contents
:depth: 2
CDN Support for Plone: Multiple Hostnames
*******************************************
Overview
========
This package provides support for a multiple hostnames CDN config for
Plone sites.
Acting in a similar way to AlternateHostname provider, MultipleHostnames allows
you to type in multiple values for hostname.
When the absolute_url method from a resource registry is called, we select one
of the available hostnames and return it to the browser.
Using MultipleHostnames allows you to serve content from a hostname while
resources will be called from up to n other addresses.
Requirements
=============
* Plone 3.3.x (http://plone.org/products/plone)
* Plone 4.0.x (http://plone.org/products/plone)
* Plone 4.1.x (http://plone.org/products/plone)
* Plone 4.2.x (http://plone.org/products/plone)
* collective.cdn.core (http://pypi.python.org/pypi/collective.cdn.core)
Installation
=============
To enable this product,on a buildout based installation:
1. Edit your buildout.cfg and add ``collective.cdn.multiplehostnames``
to the list of eggs to install ::
[buildout]
...
eggs =
collective.cdn.multiplehostnames
If another package depends on the collective.cdn.multiplehostnames egg or
includes its zcml directly you do not need to specify anything in the
buildout configuration: buildout will detect this automatically.
After updating the configuration you need to run the ''bin/buildout'',
which will take care of updating your system.
Go to the 'Site Setup' page in the Plone interface and click on the
'Add/Remove Products' link.
Choose the CDN Support for Plone (check its checkbox) and click the 'Install' button.
Uninstall -- This can be done from the same management screen, but only
if you installed it from the quick installer.
Note: You may have to empty your browser cache and save your resource
registries in order to see the effects of the product installation.
Usage
============
CDN settings
----------------
After installing this package, go to the 'Site Setup' page in the
Plone interface and click on the 'CDN Configuration' link.
In this page you can choose which registries will use the CDN settings
by clicking the respective checkboxes.
Choose the MultipleHostnames provider, add few hostnames, port number
and additional path --if needed -- then save the settings.
How it works
--------------
Using the hostname provided in the settings page, we simply replace our
Plone site root's url with the provided information.
For example, let's add two hostnames to our configs:
* cache01.simplesconsultoria.com.br
* cache02.simplesconsultoria.com.br
With port number 80 and an empty path, the link to
portal_css/beyondskins_simples/simplesconsultoria_site-cachekey0549.css
file would change from::
http://www.simplesconsultoria.com.br/portal_css/beyondskins_simples/simplesconsultoria_site-cachekey0549.css
to::
http://cache01.simplesconsultoria.com.br/portal_css/beyondskins_simples/simplesconsultoria_site-cachekey0549.css
This is due to the algorithm used to choose between the available hostnames. If
the file was portal_css/beyondskins_simples/base-cachekey3443.css, the provider
would choose the second hostname.
If we inform a port number different from 80, it will be appended to the
hostname, so with a port number of 8080, the above example would
return::
http://cache01.simplesconsultoria.com.br:8080/portal_css/beyondskins_simples/simplesconsultoria_site-cachekey0549.css
The same will happen if we inform a path in our settings. Using 'simples' as
our path, the first example would return::
http://cache01.simplesconsultoria.com.br/simples/portal_css/beyondskins_simples/simplesconsultoria_site-cachekey0549.css
Advanced Usage
================
Using a different path offers you the possibility of creating a simple
caching/cdn server for multiple sites. As an example we will consider we
have two Plone sites, www.simplesconsultoria.com.br and www.simplesnet.com.br,
and we setup cache01.simples.srv.br and cache02.simples.srv.br as
hostnames in both Plone sites.
In order to differentiate one site from the other we will set different paths
in each of them:
* simples in www.simplesconsultoria.com.br
* simplesnet in www.simplesnet.com.br
So each site will have the following settings:
* www.simplesconsultoria.com.br
* Provider: MultipleHostnames
* Hostname: cache01.simples.srv.br, cache02.simples.srv.br
* Port: 80
* Path: simples
* www.simplesnet.com.br
* Provider: MultipleHostnames
* Hostname: cache01.simples.srv.br, cache02.simples.srv.br
* Port: 80
* Path: simplesnet
And a link to a file portal_css/beyondskins_simples/base-cachekey3443.css,
would return for www.simplesconsultoria.com.br::
http://cache02.simples.srv.br/simples/portal_css/beyondskins_simples/base-cachekey3443.css
And for www.simplesnet.com.br::
http://cache02.simples.srv.br/simplesnet/portal_css/beyondskins_simples/base-cachekey3443.css
So, our frontend server must rewrite calls to **simples/** to
www.simplesconsultoria.com.br server and calls to **simplesnet/** to the
www.simplesnet.com.br server.
Sponsoring
===========
Development of this product was sponsored by `Simples Consultoria
<http://www.simplesconsultoria.com.br/>`_.
Credits
========
* Simples Consultoria (products at simplesconsultoria dot com dot br) -
Implementation
* Dorneles Treméa for the invaluable talks about how to implement this
provider.
Changelog
=========
0.6 (2012-08-01)
----------------
* Refactor tests to use plone.app.testing [ericof]
0.5 (2011-02-21)
----------------
* Implementation of multiple hostnames provider [ericof]
* Initial release [ericof]