File: INSTALL.txt

package info (click to toggle)
zope-cmfplone 2.5.1-4etch3
  • links: PTS
  • area: main
  • in suites: etch
  • size: 7,752 kB
  • ctags: 5,237
  • sloc: python: 28,264; xml: 3,723; php: 129; makefile: 99; sh: 2
file content (281 lines) | stat: -rw-r--r-- 9,386 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
Installing Plone manually, step by step instructions.

==============================================================================


**SUMMARY**

  1) Download and install Zope
  2) Find your instance's Products directory
  3) Download and install CMFPlone
  4) Download and install optional products

  For alternative install docs, try http://plone.org/documentation. They may be
  more up to date, and have useful illustrations to go with them.


===============================================================================


**ASSUMPTIONS**

  1) You are running a *nix server
  2) You are comfortable with standard Unix commands, including
     * wget or cvs
     * tar
     * symlinking
  3) You are familiar with logging into the Zope Management Interface


===============================================================================


**REQUIREMENTS**

  **MANDATORY**

  - Zope 2.9.4+ (does not run natively on Zope 3)
     http://www.zope.org/Products/Zope/2.9.4
     **If you are running Zope 2.9.5+ you should consider removing the ``Five``
     Product included with Plone**
   or
    Zope 2.8.7+
     http://www.zope.org/Products/Zope/2.8.7
     **To use Plone 2.5 with Zope 2.8, you must remove the included ``Five``
     package and replace it with Five 1.2.6+ from
     http://codespeak.net/z3/five/release/Five-1.2.6.tgz**

  - CMF 1.6.2+ (neither 1.5 nor 2.x+ will work)
     Included in the Plone tarball

  - CMFQuickInstallerTool 1.5.9 or newer
     Included in the Plone tarball

  - GroupUserFolder 3.54 or newer
     Included in the Plone tarball

  - CMFFormController 2.0.5 or newer
     Included in the Plone tarball

  - SecureMailHost 1.0.4 or newer
     Included in the Plone tarball

  - Archetypes 1.4.1 or newer
     Included in the Plone tarball

  - ATContentTypes 1.1.3 or newer
     Included in the Plone tarball

  - ATReferenceBrowserWidget 1.5 or newer
     Included in the Plone tarball

  - ResourceRegistries 1.3.2 or newer
     Included in the Plone tarball

  - ExtendedPathIndex 2.4 or newer
     Included in the Plone tarball

  - CMFDynamicViewFTI 2.1 or newer
     Included in the Plone tarball

  - Python Imaging Library 1.1.5 or newer
     Not included in the Plone tarball
     http://effbot.org/downloads/#Imaging
     Note: You have to build PIL with jpeg and png support. See the README
     of PIL for more information.

  - Python ElementTree
     Not included in the Plone tarball
     http://effbot.org/downloads/#elementtree

  - Placeless Translation Service 1.3.2 or newer
     Included in the Plone tarball

  - PloneTranslations 2.6.0
     Included in the Plone tarball

  - PloneLanguageTool 1.4 or newer
     Included in the Plone tarball

  - CMFPlacefulWorkflow 1.0.2 or newer
     Included in the Plone tarball

  - PlonePAS 2.1 or newer
     Included in the Plone tarball

  - PasswordResetTool 0.4 or newer
     Included in the Plone tarball

  - PluggableAuthService 1.4 or newer
     Included in the Plone tarball

  - PluginRegistry 1.1 or newer
     Included in the Plone tarball

  - ExternalEditor 0.9.2 or newer
     Included in the Plone tarball

  - kupu 1.3.8 or newer
     Included in the Plone tarball

  **OPTIONAL**

  - CacheFu 1.0.1 or newer
     Included in the Plone tarball
     In order to use CacheFu, you must copy or link the directories
     ``CacheSetup``, ``CMFSquidTool``, ``PageCacheManager``, and
     ``PolicyHTTPCacheManager`` into your Products directory and carefully
     read the instructions included with the product.

===============================================================================


**INSTALLATION PROCEDURE:**

-------------------------------------------------------------------------------

1. Download and install Zope

  Install Zope and start it. Check that it's running.

  *****************************************************************************
  * If you want to run Plone on FreeBSD, you'll need to up the thread stack   *
  * size of your python interpreter or else Zope will repeatedly crash!       *
  * Compile python with 'make WANT_HUGE_STACK_SIZE=yes' or use the compiler   *
  * option CFLAG: -DTHREAD_STACK_SIZE=0x100000                                *
  *****************************************************************************
-------------------------------------------------------------------------------

2. Find your instance's Products directory

   The location of this varies from system to system, so to avoid hunting for it,
   go to the Zope Management Interface (ZMI) Control Panel in your Zope's root,
   which will likely be at one of the following URLs:

   http://yourhost:8080/Control_Panel/manage_main
   http://yourhost:9673/Control_Panel/manage_main (if you're using Debian)
   http://yourhost/Control_Panel/manage_main (if you're proxying through a front
   end webserver)

   This page will tell you your INSTANCE_HOME. There is a Products folder in each
   site's INSTANCE_HOME folder. This is the best place to install add-on Products
   for a site.

      $SOFTWARE_HOME/Products folder

   Sometimes a Product's documentation will instruct you to install it in
   SOFTWARE_HOME/Products.  SOFTWARE_HOME refers to the lib/python sub-folder of
   the Zope folder. We strongly discourage installing packages in these places for
   two reasons:

    * These folders affect all Plone 2 sites using that version of Zope.
    * If you reinstall Plone 2 or a newer version of Plone 2, Zope will
      be replaced.

   Any time you're asked to place packages into a Products folder, choose
   the INSTANCE_HOME/Products folder instead. Thank you!

-------------------------------------------------------------------------------

3. Download and install CMFPlone

   Unpack the Plone tarball

   The results will be a directory named CMFPlone-xxxx where
   xxxx is the version. This should contain the following subdirectories:

   Archetypes
   ATContentTypes
   ATReferenceBrowserWidget
   CacheFu
   CMFActionIcons
   CMFCalendar
   CMFCore
   CMFDefault
   CMFDynamicViewFTI
   CMFFormController
   CMFPlacefulWorkflow
   CMFPlone
   CMFQuickInstallerTool
   CMFSetup
   CMFTopic
   CMFUid
   DCWorkflow
   ExtendedPathIndex
   ExternalEditor
   Five -
        replace this with a 1.2.x version from codespeak.net/z3/five
        to run with Zope 2.8, or optionally remove it if running with
        Zope 2.9.5+
   GenericSetup
   GroupUserFolder
   kupu
   MimetypesRegistry
   PasswordResetTool
   PlacelessTranslationService
   PloneErrorReporting
   PloneLanguageTool
   PlonePAS
   PloneTranslations
   PluggableAuthService
   PluginRegistry
   PortalTransforms
   ResourceRegistries
   SecureMailHost
   statusmessages
   validation

   Move (or symlink) each of these subdirectories into your
   $INSTANCE_HOME/Products
   directory. If it does not exist, create it.  If you are running Zope 2.9.x
   do not place Five in your Products directory, or Zope will not start.

  *****************************************************************************
  * Note that each of these is a Product in its own right and *must* be       *
  * directly within $INSTANCE_HOME/Products. If you just move the entire CMF  *
  * directory into $INSTANCE_HOME/Products, your Zope Instance will *not* be  *
  * able to find these required products, and you will not be able to run     *
  * Plone.                                                                    *
  *****************************************************************************

  It's probably A Good Idea at this point to restart your Zope to load these
  Products, then test that they have installed correctly. You can do this by
  logging into the ZMI - you should have

    1) The Plone Products (BTreeFolder2 etc.) listed in the Products section of
       the Control_Panel
    2) "Plone Site" as one of the options in the "Add" dropdown in the ZMI Root
       Folder

  Complete the install test by adding a Plone Site from the pulldown in the root
  folder.

  *****************************************************************************
  * Make sure this is not done inside the Control Panel, but in the root of   *
  * the Zope site.                                                            *
  *****************************************************************************

  When you do this, it asks you to complete a form, specifying the site's Id,
  Title, Description and where your members' user folder should be. Complete
  these fields and hit the "Add Plone Site" button. After a short while, you
  should be looking at a basic Plone site containing the details you entered.

-------------------------------------------------------------------------------

4. Download and install optional products

  The above steps install the "mandatory" products.

  Use Plone Setup's "Add/Remove Products" to install optional products bundled
  with Plone: PloneErrorReporting

  For optional products not bundled with Plone:  Download the product, unpack the
  product into your instance's Products directory, restart Zope, and install them
  in Plone using Plone Setup's "Add/Remove Products."

===============================================================================
Have fun, and don't forget to report any bugs or inconsistencies in the
Plone bug tracker: http://dev.plone.org/plone/

Thank you for using Plone!