source: products/quintagroup.plonegooglesitemaps/tags/1.5/docs/INSTALL.txt

Last change on this file was 2426, checked in by mylan, 9 years ago

#131: Updated README, INSTALL files

  • Property svn:eol-style set to native
File size: 2.9 KB
Line 
1quintagroup.plonegooglesitemaps Installation
2============================================
3
4Buildout
5--------
6
7To install quintagroup.plonegooglesitemaps to your buildout-based project:
8
9* Add ``quintagroup.plonegooglesitemaps`` to the list of eggs to install::
10
11    [buildout]
12    ...
13    eggs =
14        ...
15        quintagroup.plonegooglesitemaps
16       
17* Tell the plone.recipe.zope2instance recipe to install a ZCML slug::
18
19    [instance]
20    recipe = plone.recipe.zope2instance
21    ...
22    zcml =
23        quintagroup.plonegooglesitemaps
24        quintagroup.plonegooglesitemaps-overrides
25
26* Re-run buildout, e.g. with::
27
28    $ ./bin/buildout
29
30* Restart the Zope server, e.g with the following command in the terminal::
31
32   $ ./bin/instance restart
33   
34* Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products)
35
36
37Traditional Zope 2 instance
38---------------------------
39
40To install quintagroup.plonegooglesitemaps into the global Python environment (or a workingenv),
41using a traditional Zope 2 instance, you can do this:
42
43* Copy ``quintagroup`` folder to your instance's ``/lib/python`` directory.
44
45* Create a file called ``quintagroup.plonegooglesitemaps-configure.zcml`` in your instance's ``/etc/package-includes`` directory. The file
46should only contain this::
47
48    <include package="quintagroup.plonegooglesitemaps" />
49
50* Create a file called ``quintagroup.plonegooglesitemaps-overrides.zcml`` in your instance's ``/etc/package-includes`` directory. The file
51should only contain this::
52
53    <include package="quintagroup.plonegooglesitemaps" file="overrides.zcml" />
54
55* Restart the Zope server, for example with the following command in the terminal::
56
57   $ ./bin/zopectl restart
58
59* Install ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products)
60
61
62IMPORTANT
63---------
64
65* *If you migrate* to quintagroup.plonegooglesitemaps >= v.1.2 - you MUST ADD overrides.zcml
66  slug to instance/buildout configuration, as mentioned in previous sections.
67
68* If you want to upgrade to newer version:
69  * Perform all steps but last one from *Buildout* or *Traditional Zope 2 instance* sections
70  * *Reinstall* ``Plone Google Sitemaps`` with Quickinstaller in Plone (Site Setup -> Add/Remove Products)
71
72* Catalog rebuilding:
73  ------------------
74  * For quintagroup.plonegooglesitemaps >= v.1.2:
75    catalog rebuilding will be made automatically, with updating *canonical_link*
76    metadata *only*.
77  * For quintagroup.plonegooglesitemaps < v.1.2:
78    after installation portal_catalog rebuild needed.
79    By default catalog NOT rebuilded. You may rebuild catalog in 2 ways:
80     ** by hand: go to /<plone instance id>/portal_catalog/manage_catalogAdvanced
81         and push *Update* button.
82     ** allow catalog rebuilding on quintagroup.plonegooglesitemap installation.
83        For that - set *UPDATE_CATALOG* property to *True* in
84        quintagroup.plonegooglesitemaps.config python module.
85
86
Note: See TracBrowser for help on using the repository browser.