source: products/quintagroup.plonegooglesitemaps/trunk/docs/INSTALL.txt @ 2541

quintagroup.plonegooglesitemaps Installation
============================================

Buildout
--------

To install quintagroup.plonegooglesitemaps to your buildout-based project:

* Add ``quintagroup.plonegooglesitemaps`` to the list of eggs to install::

    [buildout]
    ...
    eggs =
        ...
        quintagroup.plonegooglesitemaps
       
* Tell the plone.recipe.zope2instance recipe to install a ZCML slug::

    [instance]
    recipe = plone.recipe.zope2instance
    ...
    zcml =
        quintagroup.plonegooglesitemaps
        quintagroup.plonegooglesitemaps-overrides

* Re-run buildout, e.g. with::

    $ ./bin/buildout

* Restart the Zope server, e.g with the following command in the terminal::

   $ ./bin/instance restart
   
* Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 


Traditional Zope 2 instance
---------------------------

To install quintagroup.plonegooglesitemaps into the global Python environment (or a workingenv),
using a traditional Zope 2 instance, you can do this:

* Copy ``quintagroup`` folder to your instance's ``/lib/python`` directory.

* Create a file called ``quintagroup.plonegooglesitemaps-configure.zcml`` in your instance's ``/etc/package-includes`` directory. The file
should only contain this::

    <include package="quintagroup.plonegooglesitemaps" />

* Create a file called ``quintagroup.plonegooglesitemaps-overrides.zcml`` in your instance's ``/etc/package-includes`` directory. The file
should only contain this::

    <include package="quintagroup.plonegooglesitemaps" file="overrides.zcml" />

* Restart the Zope server, for example with the following command in the terminal::

   $ ./bin/zopectl restart

* Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products) 


IMPORTANT
---------

* *If you migrate* to quintagroup.plonegooglesitemaps >= v.1.2 - you MUST ADD overrides.zcml
  slug to instance/buildout configuration, as mentioned in previous sections.

* If you want to upgrade to newer version:
  * Perform all steps but last one from *Buildout* or *Traditional Zope 2 instance* sections
  * *Reinstall* ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products)

* Catalog rebuilding:
  ------------------
  * For quintagroup.plonegooglesitemaps >= v.1.2:
    catalog rebuilding will be made automatically, with updating *canonical_link*
    metadata *only*.
  * For quintagroup.plonegooglesitemaps < v.1.2:
    after installation portal_catalog rebuild needed.
    By default catalog NOT rebuilded. You may rebuild catalog in 2 ways:
     ** by hand: go to /<plone instance id>/portal_catalog/manage_catalogAdvanced
         and push *Update* button.
     ** allow catalog rebuilding on quintagroup.plonegooglesitemap installation.
        For that - set *UPDATE_CATALOG* property to *True* in
        quintagroup.plonegooglesitemaps.config python module.