| 15 | | <div class="section" id="installation"> |
| 16 | | <h1>Installation</h1> |
| 17 | | <p>This section describes how to install a server based instance of eduCommons on |
| 18 | | a UNIX based platform (linux, OSX).</p> |
| 19 | | <p>Installation involves the following packages:</p> |
| 20 | | <blockquote> |
| 21 | | <ul class="simple"> |
| 22 | | <li>Python-2.4.4.tar.gz (<a class="reference external" href="http://python.org/2.4.4/">http://python.org/2.4.4/</a>)</li> |
| 23 | | <li>Zope-2.10.5-final.tar.gz (<a class="reference external" href="http://www.zope.org/Products/Zope/2.10.5">http://www.zope.org/Products/Zope/2.10.5</a>)</li> |
| 24 | | </ul> |
| 25 | | </blockquote> |
| 26 | | <p>Python library packages:</p> |
| 27 | | <blockquote> |
| 28 | | <ul class="simple"> |
| 29 | | <li>Imaging-1.1.6.tar.gz (<a class="reference external" href="http://www.pythonware.com/products/pil/">http://www.pythonware.com/products/pil/</a>)</li> |
| 30 | | <li>PyXML-0.8.4.tar.gz (<a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=6473">http://sourceforge.net/project/showfiles.php?group_id=6473</a>)</li> |
| 31 | | <li>elementtree-1.2.6.tar.gz (<a class="reference external" href="http://effbot.org/downloads/#elementtree">http://effbot.org/downloads/#elementtree</a>)</li> |
| 32 | | <li>libxml2-python-2.6.15.tar.gz (<a class="reference external" href="ftp://xmlsoft.org/libxml2/python/">ftp://xmlsoft.org/libxml2/python/</a>)</li> |
| 33 | | <li>Beautiful Soup 3.0.4 (<a class="reference external" href="http://www.crummy.com/software/BeautifulSoup/download/">http://www.crummy.com/software/BeautifulSoup/download/</a>)</li> |
| 34 | | </ul> |
| 35 | | </blockquote> |
| 36 | | <p>Plone package:</p> |
| 37 | | <blockquote> |
| 38 | | <ul class="simple"> |
| 39 | | <li>Plone-3.0.6.tar.gz (<a class="reference external" href="http://plone.org/products/plone/releases/3.0.6">http://plone.org/products/plone/releases/3.0.6</a>)</li> |
| 40 | | </ul> |
| 41 | | </blockquote> |
| 42 | | <p>eduCommons-related Packages:</p> |
| 43 | | <p>(Correct versions of these products are shipped in the eduCommons archive unless ohterwise noted)</p> |
| 44 | | <blockquote> |
| 45 | | <ul class="simple"> |
| 46 | | <li>eduCommons (3.1.0-final)</li> |
| 47 | | <li>leftskin (1.0.2-final)</li> |
| 48 | | <li>ContentLicensing (2.0.0)</li> |
| 49 | | <li>ZipFileTransport (2.0.1)</li> |
| 50 | | <li>IMSTransport (2.0.1)</li> |
| 51 | | <li>PloneBookmarklets (2.0.0)</li> |
| 52 | | <li>ProxyIndex (1.2.1)</li> |
| 53 | | <li>FileSystemStorage (2.6.2)</li> |
| 54 | | <li>LinguaPlone (2.0)</li> |
| 55 | | <li>easy_install (download here: <a class="reference external" href="http://peak.telecommunity.com/dist/ez_setup.py">http://peak.telecommunity.com/dist/ez_setup.py</a>)</li> |
| 56 | | <li>collective.captcha (installed via easy_install)</li> |
| 57 | | </ul> |
| 58 | | </blockquote> |
| 59 | | <div class="section" id="i-installation-steps"> |
| 60 | | <h2>I. Installation Steps</h2> |
| 61 | | <ol class="arabic"> |
| 62 | | <li><p class="first">Installing Python:</p> |
| 63 | | <p>It is likely that the Python programming language is already installed on |
| 64 | | your server. Try typing:</p> |
| | 14 | <p>Download the eduCommons 3.2.1 release, available at:</p> |
| 139 | | tar -zxvf libxml2-python-2.6.15.tar.gz |
| 140 | | cd libxml2-python-2.6.15 |
| 141 | | /usr/local/bin/python setup.py build |
| 142 | | sudo /usr/local/bin/python setup.py install |
| 143 | | </pre> |
| 144 | | </li> |
| 145 | | <li><p class="first">Install Beautiful Soup</p> |
| 146 | | <p>Unpack and install Beautiful Soup 3.0.4 into your python library.</p> |
| 147 | | <pre class="literal-block"> |
| 148 | | tar -zxvf BeautifulSoup-3.0.4.tar.gz |
| 149 | | cd BeautifulSoup-3.0.4 |
| 150 | | /usr/local/bin/python setup.py build |
| 151 | | sudo /usr/local/bin/python setup.py install |
| 152 | | </pre> |
| 153 | | </li> |
| 154 | | </ol> |
| 155 | | </li> |
| 156 | | </ol> |
| 157 | | <blockquote> |
| 158 | | <ol class="loweralpha" start="6"> |
| 159 | | <li><p class="first">Install Easy Install</p> |
| 160 | | <blockquote> |
| 161 | | <p>Easy Install (easy_install) is a python module bundled with setuptools |
| 162 | | that lets you automatically download, build, install, and manage Python packages.</p> |
| 163 | | <p>Download <a class="reference external" href="http://peak.telecommunity.com/dist/ez_setup.py">http://peak.telecommunity.com/dist/ez_setup.py</a> and install it using the |
| 164 | | correct version of python:</p> |
| 165 | | <pre class="literal-block"> |
| 166 | | /usr/local/bin/python ez_setup.py |
| 167 | | </pre> |
| 168 | | </blockquote> |
| 169 | | </li> |
| 170 | | </ol> |
| 171 | | <blockquote> |
| 172 | | <ol class="loweralpha" start="7"> |
| 173 | | <li><p class="first">Install collective.captcha</p> |
| 174 | | <p>collective.captcha is a Python package that is installable via Easy Install</p> |
| 175 | | <pre class="literal-block"> |
| 176 | | /usr/local/bin/easy_install collective.captcha |
| 177 | | </pre> |
| 178 | | </li> |
| 179 | | </ol> |
| 180 | | </blockquote> |
| 181 | | </blockquote> |
| 182 | | <ol class="arabic" start="3"> |
| 183 | | <li><p class="first">Installing Zope</p> |
| 184 | | <p>Unpack, build and install Zope:</p> |
| 185 | | <pre class="literal-block"> |
| 186 | | tar -zxvf Zope-2.10.5-final.tar.gz |
| 187 | | cd Zope-2.10.5-final |
| 188 | | ./configure --with-python=/usr/local/bin/python --prefix /opt/Zope-2.10.5 |
| 189 | | make |
| 190 | | sudo make install |
| 191 | | </pre> |
| 192 | | </li> |
| 193 | | <li><p class="first">Create a Zope instance</p> |
| 194 | | <p>Create an instance in your Zope install:</p> |
| 195 | | <pre class="literal-block"> |
| 196 | | sudo /opt/Zope-2.10.5/bin/mkzopeinstance.py |
| 197 | | </pre> |
| 198 | | <p>When prompted for a directory enter in the following:</p> |
| 199 | | <pre class="literal-block"> |
| 200 | | /opt/Zope-2.10.5/web |
| 201 | | </pre> |
| 202 | | <p>You can substitute the <em>web</em> directory for a name that better describes your site. |
| 203 | | The documentation will assume that you have chosen web as your instance directory.</p> |
| 204 | | <p>When prompted for a username and password, enter in the username/password you will |
| 205 | | use for managing your Zope instance.</p> |
| 206 | | </li> |
| 207 | | <li><p class="first">Install Zope Products</p> |
| 208 | | <p>eduCommons relies on several Zope products in order to run. You will need to install |
| 209 | | the following packages in the following order. The commands listed below assume that |
| 210 | | you have the source tarballs in the root of your home account:</p> |
| 211 | | <ol class="loweralpha"> |
| 212 | | <li><p class="first">Plone-3.0.6</p> |
| 213 | | <p>Install Plone into your Zope instance Products folder.lib/python directory</p> |
| 214 | | <pre class="literal-block"> |
| 215 | | cd /opt/Zope-2.10.5/web/Products |
| 216 | | sudo tar -zxvf ~/Plone-3.0.6.tar.gz |
| 217 | | </pre> |
| 218 | | <p>Once you have unpacked Plone you need to move the products back up to the Products |
| 219 | | directory as follows:</p> |
| 220 | | <pre class="literal-block"> |
| 221 | | cd /opt/Zope-2.10.5/web/Products |
| 222 | | sudo su |
| 223 | | cd Plone-3.0.6 |
| 224 | | mv * .. |
| 225 | | cd .. |
| 226 | | sudo rm -rf Plone-3.0.6 |
| 227 | | </pre> |
| 228 | | <p>The Plone tarball came with a lib/python directory. The contents of it need to go |
| 229 | | up one level, into the lib/python of your Zope install.</p> |
| 230 | | <pre class="literal-block"> |
| 231 | | cd /opt/Zope-2.10.5/web/Products |
| 232 | | cp -r lib/* ../lib/ |
| 233 | | sudo rm -rf /opt/Zope-2.10.5/web/Products/lib |
| 234 | | </pre> |
| 235 | | <p>The Plone tarball also contains a Products directory. The contents of it need to go |
| 236 | | up one level, into the web/Products directory of your Zope install.</p> |
| 237 | | <pre class="literal-block"> |
| 238 | | cd /opt/Zope-2.10.5/web/Products |
| 239 | | cp -r Products/* ../Products/ |
| 240 | | sudo rm -rf /opt/Zope-2.10.5/web/Products/Products |
| 241 | | </pre> |
| 242 | | </li> |
| 243 | | <li><p class="first">eduCommons</p> |
| 244 | | <p>This is the eduCommons product source package. To install use the following:</p> |
| 245 | | <pre class="literal-block"> |
| 246 | | cd /opt/Zope-2.10.5/web/Products |
| 247 | | sudo tar -zxvf ~/eduCommons-3.2.1.tar.gz |
| 248 | | </pre> |
| 249 | | <p>eduCommons includes a number of products which need to be put in the root |
| 250 | | of the Products folder. To do this use the following:</p> |
| 251 | | <pre class="literal-block"> |
| 252 | | cd /opt/Zope-2.10.5/web/Products |
| 253 | | sudo mv eduCommons-3.2.1/* . |
| 254 | | sudo rm -rf eduCommons-3.2.1 |
| 255 | | </pre> |
| 256 | | <p>The products that now ship with eduCommons are as follows:</p> |
| 257 | | <ol class="arabic"> |
| 258 | | <li><p class="first">eduCommons</p> |
| 259 | | <p>A Plone product which implements the core functionality of eduCommons.</p> |
| 260 | | </li> |
| 261 | | <li><p class="first">leftskin</p> |
| 262 | | <p>A Plone product which customizes the Plone layout.</p> |
| 263 | | </li> |
| 264 | | <li><p class="first">ContentLicensing</p> |
| 265 | | <p>A Plone product that adds the ability to set copyright licenses on content |
| 266 | | objects. Auto installed with the eduCommons product.</p> |
| 267 | | </li> |
| 268 | | <li><p class="first">ZipFileTransport</p> |
| 269 | | <p>A Plone product that adds the ability to import and export content via |
| 270 | | ZIP archives. Auto installed with the eduCommons product.</p> |
| 271 | | </li> |
| 272 | | <li><p class="first">IMSTransport</p> |
| 273 | | <p>A Plone product that imports and exports contents in IMS content packages. |
| 274 | | Auto installed with the eduCommons product.</p> |
| 275 | | </li> |
| 276 | | <li><p class="first">PloneBookmarklets</p> |
| 277 | | <p>A Plone product that adds the ability to integrate documents with popular social |
| 278 | | bookmarking sites.</p> |
| 279 | | </li> |
| 280 | | <li><p class="first">ProxyIndex</p> |
| 281 | | <p>ProxyIndex is a plugin to zope catalog index.</p> |
| 282 | | </li> |
| 283 | | <li><p class="first">FileSystemStorage</p> |
| 284 | | <p>FileSystemStorage is a product that provides the framework for content types to store data |
| 285 | | directly on the filesystem, rather than in the ZODB.</p> |
| 286 | | </li> |
| 287 | | <li><p class="first">LinguaPlone</p> |
| 288 | | <p>A tool to manage and maintain multilingual Plone content.</p> |
| 289 | | </li> |
| 290 | | </ol> |
| 291 | | </li> |
| 292 | | </ol> |
| 293 | | </li> |
| 294 | | <li><p class="first">Configure your Zope site</p> |
| 295 | | <p>Now that all the necessary Zope products are installed it is time to clean up and |
| 296 | | configure the site. The first task is to create a zope user and group in which |
| 297 | | zope can run under. This can be done via the following:</p> |
| 298 | | <pre class="literal-block"> |
| 299 | | sudo /usr/sbin/groupadd zope |
| 300 | | sudo /usr/sbin/adduser -g zope -s /bin/false -d /opt/Zope-2.10.5 zope |
| 301 | | </pre> |
| 302 | | <p>Once that is done we can now set the proper permissions needed for Zope to run |
| 303 | | securely. This can be done via the following:</p> |
| 304 | | <pre class="literal-block"> |
| 305 | | cd /opt/Zope-2.10.5/web/Products |
| 306 | | sudo chgrp -R zope * |
| 307 | | sudo chmod go-w * |
| 308 | | </pre> |
| 309 | | <p>FileSystemStorage comes with its own documentation and we recommend you read it |
| 310 | | (/opt/Zope-2.10.5/web/Products/FileSystemStorage/README.txt). Create folders for |
| 311 | | storage and backup. We suggest setting things up in the following way:</p> |
| 312 | | <pre class="literal-block"> |
| 313 | | cd /opt/Zope-2.10.5/web/var |
| 314 | | mkdir fss_storage |
| 315 | | mkdir fss_backup |
| 316 | | </pre> |
| 317 | | <p>Now edit the filesystemstorage.conf.in configuration file for FileSystemStorage located |
| 318 | | in /opt/Zope-2.10.5/web/Products/FileSystemStorage/etc. There are several configuration |
| 319 | | options here (see README.txt), but most can be left at the default. We suggest a |
| 320 | | hierarchical file structure, which can be set up by uncommenting and editing this line:</p> |
| 321 | | <pre class="literal-block"> |
| 322 | | # storage-strategy flat |
| 323 | | change to: |
| 324 | | storage-strategy site1 |
| 325 | | </pre> |
| 326 | | <p>Zope needs to be able to write to the log directory, and its database files. To |
| 327 | | enable this enter the following:</p> |
| 328 | | <pre class="literal-block"> |
| 329 | | cd /opt/Zope-2.10.5/web |
| 330 | | sudo chgrp -R zope log var |
| 331 | | sudo chmod -R g+w log var |
| 332 | | </pre> |
| 333 | | <p>The last bit of configuration that needs to be done is to edit the zope.conf file. |
| 334 | | found in the <em>etc/</em> directory of your Zope Instance. Uncomment and edit the |
| 335 | | following settings:</p> |
| 336 | | <pre class="literal-block"> |
| 337 | | effective-user zope |
| 338 | | </pre> |
| 339 | | <p>And set the default port you want the Zope server to run on:</p> |
| 340 | | <pre class="literal-block"> |
| 341 | | <http-server> |
| 342 | | # valid keys are "address and "force-connection-close" |
| 343 | | address 8080 |
| 344 | | # force-connection-close on |
| 345 | | </http-server> |
| 346 | | </pre> |
| 347 | | </li> |
| 348 | | <li><p class="first">Apply Security Patch</p> |
| 349 | | <p>Plone's Security Panel is broken for Products that add Roles that come alphabetically |
| 350 | | before 'Anonymous'. eduCommons adds the Administrator Role, which breaks the Security |
| 351 | | Panel. This is a documented bug (<a class="reference external" href="http://dev.plone.org/plone/ticket/7690">http://dev.plone.org/plone/ticket/7690</a>).</p> |
| 352 | | <p>In order to remedy this problem, apply the patch found in the eduCommons/extras folder. |
| 353 | | Copy the patch to /opt/Zope-2.10.5/web/lib/python/plone/app/controlpanel.</p> |
| 354 | | <pre class="literal-block"> |
| 355 | | cd /opt/Zope-2.10.5/web/lib/python/plone/app/controlpanel |
| 356 | | cp /opt/Zope-2.10.5/web/Products/eduCommons/extras/plone.app.controlpanel.security.py.patch . |
| 357 | | </pre> |
| 358 | | <p>Apply the patch by running the following command:</p> |
| 359 | | <pre class="literal-block"> |
| 360 | | patch -p0 < plone.app.controlpanel.security.py.patch |
| 361 | | </pre> |
| 362 | | <p>You may get this message: "can't find file to patch at input line 1 Perhaps you used |
| 363 | | the wrong -p or --strip option? File to patch:" Enter the following:</p> |
| 364 | | <pre class="literal-block"> |
| 365 | | security.py |
| 366 | | </pre> |
| 367 | | </li> |
| 368 | | <li><p class="first">Overwrite Kupu's html2captioned transform</p> |
| 369 | | <p>Kupu allows for dynamically generated captions on inserted images. eduCommons utilizes |
| 370 | | this feature to provide license and copyright holder information for embedded images |
| 371 | | in documents. In order for this functionality to occur, the default transformation |
| 372 | | must be customized</p> |
| 373 | | <pre class="literal-block"> |
| 374 | | cp /opt/Zope-2.10.5/web/Products/eduCommons/extras/html2captioned.py /opt/Zope-2.10.5/web/Products/kupu/plone |
| 375 | | </pre> |
| 376 | | </li> |
| 377 | | </ol> |
| 378 | | </div> |
| 379 | | <div class="section" id="ii-configuration-steps"> |
| 380 | | <h2>II. Configuration Steps</h2> |
| 381 | | <ol class="arabic"> |
| 382 | | <li><p class="first">Launch Zope</p> |
| 383 | | <p>Once Zope has been properly configured it can then be launched via the following |
| 384 | | commands:</p> |
| 385 | | <pre class="literal-block"> |
| 386 | | cd /opt/Zope-2.10.5/web |
| 387 | | sudo bin/zopectl start |
| | 43 | bin/instance fg |
| 401 | | places within the eduCommons install, and should be based on your group or institution.</p> |
| 402 | | <p>Under "Extension Profiles" you need to do a multi-select (hold down the CTRL or the |
| 403 | | Apple key). Select Working Copy Support (Iterate), ContentLicensing, IMSTransport, LinguaPlone, |
| 404 | | PloneBookmarklets, Zip File Transport, eduCommons, and Left Skin so they are all highlighted. |
| 405 | | Then click "Add Plone Site."</p> |
| 406 | | <p>Once the eduCommons instance has been created, you will need to QuickInstall the FileSystemStorage Product. |
| | 57 | places within the eduCommons install, and should be based on your group or institution.</p> |
| | 58 | Under "Extension Profiles" you need to do a multi-select (hold down the CTRL or the |
| | 59 | Command key). Select the following so they are all highlighted:</p> |
| | 60 | <ol class="arabic simple"> |
| | 61 | <li>Working Copy Support (Iterate)</li> |
| | 62 | <li>ContentLicensing</li> |
| | 63 | <li>IMSTransport</li> |
| | 64 | <li>LinguaPlone</li> |
| | 65 | <li>PloneBookmarklets</li> |
| | 66 | <li>Zip File Transport</li> |
| | 67 | <li>eduCommons</li> |
| | 68 | <li>Left Skin</li> |
| | 69 | </ol> |
| | 70 | <p>Then click "Add Plone Site." Once the eduCommons instance has been created, you will need to QuickInstall the FileSystemStorage Product.</p> |
| | 71 | <p>In the ZMI:</p> |
| | 72 | <ol class="arabic simple"> |
| | 73 | <li>Navigate to your eduCommons instance</li> |
| | 74 | <li>Navigate to portal_quickinstaller</li> |
| | 75 | <li>Select the checkbox to the left of FileSystemStorage</li> |
| | 76 | <li>Click Install</li> |
| | 77 | </ol> |
| | 78 | <p>If you wish to localize content in other languages you will need to QuickInstall install LinguaPlone. |
| | 79 | This can be done either now from the ZMI or later, via Site Setup --> Add-on Products.</p> |
| | 80 | <p>In the ZMI:</p> |
| | 81 | <ol class="arabic simple"> |
| | 82 | <li>Navigate to your eduCommons instance</li> |
| | 83 | <li>Navigate to portal_quickinstaller</li> |
| | 84 | <li>Select the checkbox to the left of LinguPlone</li> |
| | 85 | <li>Click Install</li> |
| | 86 | </ol> |
| | 87 | <p>If you have installed LinguaPlone you will also need to select your supported languages.</p> |
| | 88 | <p>In the ZMI:</p> |
| | 89 | <ol class="arabic simple"> |
| | 90 | <li>Navigate to your eduCommons instance</li> |
| | 91 | <li>Navigate to portal_languages</li> |
| | 92 | <li>Select one or more Allowed languages (use the control or apple key to multi-select)</li> |
| | 93 | <li>Click Save</li> |
| | 94 | </ol> |
| | 95 | <p>Additional instructions for localizing content using LinguaPlone are available in LOCALIZATION.txt. |
| | 96 | Finally, you need to reorder the Layers in your eduCommons Skins Selections. |
| 408 | | <pre class="literal-block"> |
| 409 | | 1. Navigate to your eduCommons instance |
| 410 | | 2. Navigate to portal_quickinstaller |
| 411 | | 3. Select the checkbox to the left of FileSystemStorage |
| 412 | | 4. Click Install |
| 413 | | </pre> |
| 414 | | <p>If you wish to localize content in other languages you will need to QuickInstall install LinguaPlone. |
| 415 | | This can be done either now from the ZMI or later, via Site Setup --> Add-on Products. |
| 416 | | In the ZMI:</p> |
| 417 | | <pre class="literal-block"> |
| 418 | | 1. Navigate to your eduCommons instance |
| 419 | | 2. Navigate to portal_quickinstaller |
| 420 | | 3. Select the checkbox to the left of LinguPlone |
| 421 | | 4. Click Install |
| 422 | | </pre> |
| 423 | | <p>If you have installed LinguaPlone you will also need to select your supported languages. |
| 424 | | In the ZMI:</p> |
| 425 | | <pre class="literal-block"> |
| 426 | | 1. Navigate to your eduCommons instance |
| 427 | | 2. Navigate to portal_languages |
| 428 | | 3. Select one or more Allowed languages (use the control or apple key to multi-select) |
| 429 | | 4. Click Save |
| 430 | | </pre> |
| 431 | | <p>Additional instructions for localizing content using LinguaPlone are available in LOCALIZATION.txt.</p> |
| 432 | | <p>Finally, you need to reorder the Layers in your eduCommons Skins Selections. |
| 433 | | In the ZMI:</p> |
| 434 | | <pre class="literal-block"> |
| 435 | | 1. Navigate to your eduCommons instance |
| 436 | | 2. Navigate to portal_skins |
| 437 | | 3. Click on the Properties tab |
| 438 | | 4. Under the Skins Selections, in the Layers textbox for LeftSkin, cut the LinguaPlone entry |
| 439 | | and paste it one a new line below the eduCommons entry |
| 440 | | 5. Click Save (be sure to click the Save button for the Skins selection section) |
| 441 | | </pre> |
| 442 | | </li> |
| 443 | | <li><p class="first">Configure eduCommons</p> |
| 444 | | <p>Additional configuration information is provided in SETUP.txt (or online at |
| 445 | | <a class="reference external" href="http://cosl.usu.edu/projects/educommons/documentation/how-to/educommons-setup-instructions">http://cosl.usu.edu/projects/educommons/documentation/how-to/educommons-setup-instructions</a>). |
| 446 | | This will help you to further customize eduCommons.</p> |
| 447 | | </li> |
| | 98 | <ol class="arabic simple"> |
| | 99 | <li>Navigate to your eduCommons instance</li> |
| | 100 | <li>Navigate to portal_skins</li> |
| | 101 | <li>Click on the Properties tab</li> |
| | 102 | <li>Under the Skins Selections, in the Layers textbox for LeftSkin, cut the LinguaPlone entry and paste it one a new line below the eduCommons entry</li> |
| | 103 | <li>Click Save (be sure to click the Save button for the Skins selection section)</li> |
