Changeset 522

Show
Ignore:
Timestamp:
08/06/09 13:03:56 (3 years ago)
Author:
david
Message:

updating docs

Location:
enpraxis.educommons/trunk/enpraxis/educommons
Files:
2 added
5 modified

Legend:

Unmodified
Added
Removed

  • enpraxis.educommons/trunk/enpraxis/educommons/IMSContentPackaging.txt

    r395 r522  
    1 IMS Content Packaging and eduCommons 3.1.1-final 
     1IMS Content Packaging and eduCommons 3.2.1 
    22================================================ 
    33 
    44This document details how to write IMS Content packages that are compatible with 
    5 eduCommons 3.1.1-final.  
     5eduCommons 3.2.1.  
    66 
    77eduCommons uses version 1.2 of the IMS Content Packaging Specification. XML Schemas 
    … …  
    3434    xmlns:imsmd="http://www.imsglobal.org/xsd/imsmd_v1p2"  
    3535    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    36     xsi:schemaLocation="http://www.imsglobal.org/xsd/imscp_v1p1 http://www.imsglobal.org/xsd/imscp_v1p2.xsd 
    37         http://www.imsglobal.org/xsd/imsmd_v1p2 http://www.imsglobal.org/xsd/imsmd_v1p2p4.xsd 
    38         http://cosl.usu.edu/xsd/eduCommonsv1.2 http://cosl.usu.edu/xsd/eduCommonsv1.2.xsd" 
     36    xsi:schemaLocation="http://www.imsglobal.org/xsd/imscp_v1p1 imscp_v1p2.xsd  
     37                        http://www.imsglobal.org/xsd/imsmd_v1p2 imsmd_v1p2p4.xsd  
     38                        http://cosl.usu.edu/xsd/eduCommonsv1.2 eduCommonsv1.2.xsd"> 
     39 
     40 
    3941 
    4042Specifying and Using eduCommons Namespaces 

  • enpraxis.educommons/trunk/enpraxis/educommons/INSTALL.txt

    r8 r522  
    1 =================================== 
    2 eduCommons 3.1.1-final Installation 
    3 =================================== 
     1================================== 
     2Installing eduCommons 3.2.1 
     3================================== 
    44 
    5 ------------------------- 
    6 Installation Instructions 
    7 ------------------------- 
     5Download the eduCommons 3.2.1 release, available at: 
    86 
    9 Installation 
    10 ============ 
     7:: 
    118 
    12 This section describes how to install a server based instance of eduCommons on  
    13 a UNIX based platform (linux, OSX).  
    14  
    15 Installation involves the following packages: 
    16  
    17    * Python-2.4.4.tar.gz (http://python.org/2.4.4/)  
    18    * Zope-2.10.5-final.tar.gz (http://www.zope.org/Products/Zope/2.10.5) 
    19  
    20 Python library packages: 
    21  
    22    * Imaging-1.1.6.tar.gz (http://www.pythonware.com/products/pil/) 
    23    * PyXML-0.8.4.tar.gz (http://sourceforge.net/project/showfiles.php?group_id=6473) 
    24    * elementtree-1.2.6.tar.gz (http://effbot.org/downloads/#elementtree) 
    25    * libxml2-python-2.6.15.tar.gz (ftp://xmlsoft.org/libxml2/python/) 
    26    * Beautiful Soup 3.0.4 (http://www.crummy.com/software/BeautifulSoup/download/) 
    27  
    28 Plone package: 
    29  
    30    * Plone-3.0.6.tar.gz (http://plone.org/products/plone/releases/3.0.6) 
    31  
    32 eduCommons-related Packages: 
    33  
    34 (Correct versions of these products are shipped in the eduCommons archive unless ohterwise noted) 
    35  
    36    * eduCommons (3.1.0-final) 
    37    * leftskin (1.0.2-final) 
    38    * ContentLicensing (2.0.0) 
    39    * ZipFileTransport (2.0.1) 
    40    * IMSTransport (2.0.1) 
    41    * PloneBookmarklets (2.0.0) 
    42    * ProxyIndex (1.2.1) 
    43    * FileSystemStorage (2.6.2) 
    44    * LinguaPlone (2.0) 
    45    * easy_install (download here: http://peak.telecommunity.com/dist/ez_setup.py) 
    46    * collective.captcha (installed via easy_install) 
    47  
    48 I. Installation Steps 
    49 --------------------- 
    50  
    51 1. Installing Python: 
    52  
    53    It is likely that the Python programming language is already installed on  
    54    your server. Try typing: 
    55    :: 
    56  
    57       $ python 
    58  
    59    on the command line to see what version you have installed (Ctrl-D will exit).  
    60    You should see something like the following: 
    61    :: 
    62  
    63       Python 2.4.4 (#1, Oct  7 2006, 21:17:24)  
    64       [GCC 3.4.6 20060404 (Red Hat 3.4.6-3)] on linux2 
    65       Type "help", "copyright", "credits" or "license" for more information. 
    66       >>> 
    67  
    68    eduCommons and its supporting software requires version 2.4.4. If your server  
    69    does not have Python, or if the version of Python installed is not 2.4.4, you  
    70    will have to install a new version. 
    71  
    72    Some platforms may have an updated version of Python available through their 
    73    package managers (yum, apt, fink). If you can not find a suitable version, or  
    74    if you prefer to build Python from source, simply download the source package 
    75    and use a command line interface to type in the following instructions: 
    76    :: 
    77  
    78       tar -zxvf Python-2.4.4.tar.gz 
    79       cd Python-2.4.4 
    80       ./configure 
    81       make 
    82       sudo make install 
    83  
    84    By default this will install a new version of Python in the /usr/local directory 
    85    on your server. 
    86  
    87 2. Installing Python library packages 
    88  
    89    Once you have Python installed it will be necessary to include a number of 
    90    libraries that extend the functionality of your Python installation. If you  
    91    have installed Python using a package manager, it may be likely that some 
    92    (or all) of these packages may also be available for installation. As long 
    93    as suitable library versions can be found, it should be fine to use them. In 
    94    cases where it is not possible to load prebuilt packages, use the following 
    95    instructions below: 
    96  
    97    a. Installing Python Imaging Libary (PIL) 
    98  
    99       PIL is now a required package for the latest version of Plone. 
    100  
    101       Unpack and install Imaging-1.1.6: 
    102       :: 
    103  
    104          tar -zxvf Imaging-1.1.6.tar.gz 
    105          cd Imaging 
    106          /usr/local/bin/python setup.py build 
    107          sudo /usr/local/bin/python setup.py install 
    108  
    109       You may require additional packages to build the imaging library. See 
    110       the PIL website for additional installation instructions. 
    111  
    112    b. Installing PyXML 
    113  
    114       Unpack and install PyXML: 
    115       :: 
    116  
    117          tar -zxvf PyXML-0.8.4.tar.gz 
    118          cd PyXML-0.8.4 
    119          /usr/local/bin/python setup.py build 
    120          sudo /usr/local/bin/python setup.py install 
    121  
    122    c. Installing elementtree 
    123  
    124       elementtree is now a required dependency for the latest version of Plone. 
    125  
    126       Unpack and install elementtree: 
    127       :: 
    128  
    129          tar -zxvf elementtree-1.2.6.tar.gz 
    130          cd elementtree-1.2.6 
    131          /usr/local/bin/python setup.py build 
    132          sudo /usr/local/bin/python setup.py install 
    133  
    134    d. Installing libxml2-python 
    135  
    136       If your target platform includes binary only distributions of libxml2 and 
    137       libxslt, you may need to also include the development packages in order for 
    138       the following to work.  
    139  
    140       Unpack and install libxml2-python: 
    141       :: 
    142  
    143          tar -zxvf libxml2-python-2.6.15.tar.gz 
    144          cd libxml2-python-2.6.15 
    145          /usr/local/bin/python setup.py build 
    146          sudo /usr/local/bin/python setup.py install 
    147  
    148    e. Install Beautiful Soup 
    149  
    150       Unpack and install Beautiful Soup 3.0.4 into your python library. 
    151       :: 
    152  
    153          tar -zxvf BeautifulSoup-3.0.4.tar.gz 
    154          cd BeautifulSoup-3.0.4 
    155          /usr/local/bin/python setup.py build 
    156          sudo /usr/local/bin/python setup.py install 
    157  
    158   f. Install Easy Install 
    159  
    160       Easy Install (easy_install) is a python module bundled with setuptools 
    161       that lets you automatically download, build, install, and manage Python packages. 
    162  
    163       Download http://peak.telecommunity.com/dist/ez_setup.py and install it using the  
    164       correct version of python: 
    165       :: 
    166  
    167          /usr/local/bin/python ez_setup.py 
    168  
    169    g. Install collective.captcha 
    170  
    171       collective.captcha is a Python package that is installable via Easy Install 
    172       :: 
    173  
    174          /usr/local/bin/easy_install collective.captcha 
    175  
    176 3. Installing Zope 
    177  
    178    Unpack, build and install Zope: 
    179    :: 
    180  
    181       tar -zxvf Zope-2.10.5-final.tar.gz  
    182       cd Zope-2.10.5-final 
    183       ./configure --with-python=/usr/local/bin/python --prefix /opt/Zope-2.10.5 
    184       make 
    185       sudo make install 
    186  
    187 4. Create a Zope instance 
    188  
    189    Create an instance in your Zope install: 
    190    :: 
    191  
    192       sudo /opt/Zope-2.10.5/bin/mkzopeinstance.py 
    193  
    194    When prompted for a directory enter in the following: 
    195    :: 
    196   
    197       /opt/Zope-2.10.5/web 
    198  
    199    You can substitute the *web* directory for a name that better describes your site.  
    200    The documentation will assume that you have chosen web as your instance directory. 
    201  
    202    When prompted for a username and password, enter in the username/password you will  
    203    use for managing your Zope instance. 
    204  
    205 5. Install Zope Products 
    206  
    207    eduCommons relies on several Zope products in order to run. You will need to install 
    208    the following packages in the following order. The commands listed below assume that 
    209    you have the source tarballs in the root of your home account: 
    210  
    211    a. Plone-3.0.6 
    212  
    213       Install Plone into your Zope instance Products folder.lib/python directory  
    214       :: 
    215  
    216          cd /opt/Zope-2.10.5/web/Products 
    217          sudo tar -zxvf ~/Plone-3.0.6.tar.gz 
    218  
    219       Once you have unpacked Plone you need to move the products back up to the Products  
    220       directory as follows: 
    221       :: 
    222  
    223          cd /opt/Zope-2.10.5/web/Products 
    224          sudo su 
    225          cd Plone-3.0.6 
    226          mv * .. 
    227          cd .. 
    228          sudo rm -rf Plone-3.0.6 
    229        
    230       The Plone tarball came with a lib/python directory. The contents of it need to go  
    231       up one level, into the lib/python of your Zope install. 
    232       :: 
    233  
    234          cd /opt/Zope-2.10.5/web/Products 
    235          cp -r lib/* ../lib/ 
    236          sudo rm -rf /opt/Zope-2.10.5/web/Products/lib 
    237  
    238       The Plone tarball also contains a Products directory. The contents of it need to go 
    239       up one level, into the web/Products directory of your Zope install. 
    240       :: 
    241  
    242          cd /opt/Zope-2.10.5/web/Products 
    243          cp -r Products/* ../Products/ 
    244          sudo rm -rf /opt/Zope-2.10.5/web/Products/Products 
    245  
    246    b. eduCommons 
    247  
    248       This is the eduCommons product source package. To install use the following: 
    249       :: 
    250  
    251          cd /opt/Zope-2.10.5/web/Products 
    252          sudo tar -zxvf ~/eduCommons-3.1.1-final.tar.gz 
    253  
    254       eduCommons includes a number of products which need to be put in the root 
    255       of the Products folder. To do this use the following: 
    256       :: 
    257           
    258          cd /opt/Zope-2.10.5/web/Products 
    259          sudo mv eduCommons-3.1.1-final/* . 
    260          sudo rm -rf eduCommons-3.1.1-final 
    261  
    262       The products that now ship with eduCommons are as follows: 
    263           
    264       1. eduCommons 
    265  
    266          A Plone product which implements the core functionality of eduCommons. 
    267  
    268       2. leftskin 
    269  
    270          A Plone product which customizes the Plone layout. 
    271  
    272       3. ContentLicensing 
    273  
    274          A Plone product that adds the ability to set copyright licenses on content 
    275          objects. Auto installed with the eduCommons product. 
    276  
    277       4. ZipFileTransport 
    278  
    279          A Plone product that adds the ability to import and export content via 
    280          ZIP archives. Auto installed with the eduCommons product. 
    281  
    282       5. IMSTransport 
    283  
    284          A Plone product that imports and exports contents in IMS content packages.  
    285          Auto installed with the eduCommons product. 
    286  
    287       6. PloneBookmarklets 
    288  
    289          A Plone product that adds the ability to integrate documents with popular social 
    290          bookmarking sites. 
    291  
    292       7. ProxyIndex 
    293  
    294          ProxyIndex is a plugin to zope catalog index. 
    295  
    296       8. FileSystemStorage 
    297  
    298          FileSystemStorage is a product that provides the framework for content types to store data 
    299          directly on the filesystem, rather than in the ZODB.   
    300  
    301       9. LinguaPlone 
    302  
    303          A tool to manage and maintain multilingual Plone content. 
    304  
    305 6. Configure your Zope site 
    306  
    307    Now that all the necessary Zope products are installed it is time to clean up and 
    308    configure the site. The first task is to create a zope user and group in which  
    309    zope can run under. This can be done via the following: 
    310    :: 
    311  
    312       sudo /usr/sbin/groupadd zope 
    313       sudo /usr/sbin/adduser -g zope -s /bin/false -d /opt/Zope-2.10.5 zope 
    314  
    315    Once that is done we can now set the proper permissions needed for Zope to run 
    316    securely. This can be done via the following: 
    317    :: 
    318  
    319       cd /opt/Zope-2.10.5/web/Products 
    320       sudo chgrp -R zope * 
    321       sudo chmod go-w * 
    322  
    323    FileSystemStorage comes with its own documentation and we recommend you read it  
    324    (/opt/Zope-2.10.5/web/Products/FileSystemStorage/README.txt). Create folders for 
    325    storage and backup. We suggest setting things up in the following way: 
    326    :: 
    327  
    328       cd /opt/Zope-2.10.5/web/var 
    329       mkdir fss_storage 
    330       mkdir fss_backup 
    331  
    332    Now edit the filesystemstorage.conf.in configuration file for FileSystemStorage located  
    333    in /opt/Zope-2.10.5/web/Products/FileSystemStorage/etc. There are several configuration  
    334    options here (see README.txt), but most can be left at the default. We suggest a  
    335    hierarchical file structure, which can be set up by uncommenting and editing this line: 
    336    :: 
    337  
    338       # storage-strategy flat 
    339       change to: 
    340       storage-strategy site1 
    341  
    342    Zope needs to be able to write to the log directory, and its database files. To 
    343    enable this enter the following: 
    344    :: 
    345  
    346       cd /opt/Zope-2.10.5/web 
    347       sudo chgrp -R zope log var 
    348       sudo chmod -R g+w log var 
    349  
    350    The last bit of configuration that needs to be done is to edit the zope.conf file. 
    351    found in the *etc/* directory of your Zope Instance. Uncomment and edit the  
    352    following settings: 
    353    :: 
    354  
    355       effective-user zope 
    356  
    357    And set the default port you want the Zope server to run on: 
    358    :: 
    359  
    360       <http-server> 
    361         # valid keys are "address and "force-connection-close" 
    362         address 8080 
    363         # force-connection-close on 
    364       </http-server> 
    365  
    366 7. Apply Security Patch 
    367  
    368    Plone's Security Panel is broken for Products that add Roles that come alphabetically 
    369    before 'Anonymous'. eduCommons adds the Administrator Role, which breaks the Security  
    370    Panel.  This is a documented bug (http://dev.plone.org/plone/ticket/7690). 
    371  
    372    In order to remedy this problem, apply the patch found in the eduCommons/extras folder. 
    373    Copy the patch to /opt/Zope-2.10.5/web/lib/python/plone/app/controlpanel.  
    374    :: 
    375  
    376       cd /opt/Zope-2.10.5/web/lib/python/plone/app/controlpanel 
    377       cp /opt/Zope-2.10.5/web/Products/eduCommons/extras/plone.app.controlpanel.security.py.patch . 
    378  
    379    Apply the patch by running the following command: 
    380    :: 
    381  
    382       patch -p0 < plone.app.controlpanel.security.py.patch 
    383  
    384    You may get this message: "can't find file to patch at input line 1 Perhaps you used  
    385    the wrong -p or --strip option? File to patch:" Enter the following: 
    386    :: 
    387  
    388       security.py 
    389  
    390 8. Overwrite Kupu's html2captioned transform 
    391  
    392    Kupu allows for dynamically generated captions on inserted images. eduCommons utilizes 
    393    this feature to provide license and copyright holder information for embedded images  
    394    in documents.  In order for this functionality to occur, the default transformation  
    395    must be customized 
    396    :: 
    397  
    398       cp /opt/Zope-2.10.5/web/Products/eduCommons/extras/html2captioned.py /opt/Zope-2.10.5/web/Products/kupu/plone 
     9  http://sourceforge.net/projects/educommons/files/educommons/eduCommons-3.2.1-final/educommons.buildout-3.2.1-final.tar.gz/download 
    39910 
    40011 
    401 II. Configuration Steps 
    402 ----------------------- 
    40312 
    404 1. Launch Zope 
     13Unarchive the package to a directory which will serve as your buildout directory. Change directories and run the bootstrap script: 
    40514 
    406    Once Zope has been properly configured it can then be launched via the following 
    407    commands: 
    408    :: 
     15:: 
    40916 
    410       cd /opt/Zope-2.10.5/web 
    411       sudo bin/zopectl start 
    412  
    413    You should now be able to open a browser and go to the ZMI with the following URL 
    414    (assuming that you configured Zope to run on port 8080) 
    415    :: 
    416  
    417       http://<server name>:8080/manage 
    418  
    419    You should then get a dialog prompt asking for your Zope admin username and password. 
    420  
    421 2. Install eduCommons Product 
    422  
    423    Once you have logged into the ZMI via the management interface, you are now ready  
    424    to create the site. Start by creating a plone site with the pull down menu in the  
    425    top right corner. Give the plone site an ID and title. The ID will be used in the  
    426    URL to access the site, so name it appropriately. The title will appear several  
    427    places within the eduCommons install, and should be based on your group or institution. 
    428  
    429    Under "Extension Profiles" you need to do a multi-select (hold down the CTRL or the  
    430    Apple key). Select Working Copy Support (Iterate), ContentLicensing, IMSTransport, LinguaPlone, 
    431    PloneBookmarklets, Zip File Transport, eduCommons, and Left Skin so they are all highlighted. 
    432    Then click "Add Plone Site." 
    433  
    434    Once the eduCommons instance has been created, you will need to QuickInstall the FileSystemStorage Product. 
    435    In the ZMI: 
    436    :: 
    437  
    438        1. Navigate to your eduCommons instance 
    439        2. Navigate to portal_quickinstaller 
    440        3. Select the checkbox to the left of FileSystemStorage 
    441        4. Click Install 
    442  
    443    If you wish to localize content in other languages you will need to QuickInstall install LinguaPlone. 
    444    This can be done either now from the ZMI or later, via Site Setup --> Add-on Products. 
    445    In the ZMI: 
    446    :: 
    447  
    448        1. Navigate to your eduCommons instance 
    449        2. Navigate to portal_quickinstaller 
    450        3. Select the checkbox to the left of LinguPlone 
    451        4. Click Install 
    452  
    453    If you have installed LinguaPlone you will also need to select your supported languages. 
    454    In the ZMI: 
    455    :: 
    456  
    457        1. Navigate to your eduCommons instance 
    458        2. Navigate to portal_languages 
    459        3. Select one or more Allowed languages (use the control or apple key to multi-select) 
    460        4. Click Save  
    461  
    462    Additional instructions for localizing content using LinguaPlone are available in LOCALIZATION.txt. 
    463  
    464    Finally, you need to reorder the Layers in your eduCommons Skins Selections. 
    465    In the ZMI: 
    466    :: 
    467  
    468        1. Navigate to your eduCommons instance 
    469        2. Navigate to portal_skins 
    470        3. Click on the Properties tab 
    471        4. Under the Skins Selections, in the Layers textbox for LeftSkin, cut the LinguaPlone entry  
    472           and paste it one a new line below the eduCommons entry  
    473        5. Click Save (be sure to click the Save button for the Skins selection section) 
    474  
    475 3. Configure eduCommons 
    476  
    477    Additional configuration information is provided in SETUP.txt (or online at 
    478    http://cosl.usu.edu/projects/educommons/documentation/how-to/educommons-setup-instructions). 
    479    This will help you to further customize eduCommons. 
     17  cd eduCommons 
     18  /usr/local/python2.4 bootstrap.py 
     19  (in some envoronments the command will be /usr/local/bin/python2.4 bootstrap.py) 
    48020 
    48121 
     22Then run the buildout script to download all the required packages and set up the eduCommons application: 
     23 
     24:: 
     25 
     26        bin/buildout 
     27 
     28 
     29Or run the same buildout script above, plus the Selenium test runner (needed to run acceptance tests): 
     30 
     31:: 
     32 
     33  bin/buildout -c tests.cfg 
     34  
     35 
     36Create two directories for file system storage: 
     37 
     38:: 
     39 
     40        mkdir parts/instance/var/fss_storage 
     41        mkdir parts/instance/var/fss_backup 
     42 
     43 
     44Once you have the buildout ready you can launch it using the following: 
     45 
     46:: 
     47 
     48        bin/instance start 
     49 
     50 
     51Or to launch in the foreground of your console: 
     52 
     53:: 
     54 
     55        bin/instance fg 
     56 
     57 
     58You should now be able to open a browser and go to the ZMI with the following URL 
     59(assuming that you configured Zope to run on port 8080) 
     60 
     61:: 
     62 
     63        http://<server name>:8080/manage 
     64 
     65 
     66You should then get a dialog prompt asking for your Zope admin username and password. The default username/password for the buildout is admin/test1234. 
     67 
     68Install eduCommons Product in Your Zope Instance 
     69================================================ 
     70 
     71Once you have logged into the ZMI via the management interface, you are now ready  
     72to create the site. Start by creating a plone site with the pull down menu in the  
     73top right corner. Give the plone site an ID and title. The ID will be used in the  
     74URL to access the site, so name it appropriately. The title will appear several  
     75places within the eduCommons install, and should be based on your group or institution.</p> 
     76Under "Extension Profiles" you need to do a multi-select (hold down the CTRL or the  
     77Command key). Select the following so they are all highlighted: 
     78 
     791. Working Copy Support (Iterate) 
     802. ContentLicensing 
     813. IMSTransport 
     824. LinguaPlone 
     835. PloneBookmarklets 
     846. Zip File Transport 
     857. eduCommons 
     868. Left Skin 
     87 
     88Then click "Add Plone Site." Once the eduCommons instance has been created, you will need to QuickInstall the FileSystemStorage Product. 
     89 
     90In the ZMI: 
     91 
     921. Navigate to your eduCommons instance 
     932. Navigate to portal_quickinstaller 
     943. Select the checkbox to the left of FileSystemStorage 
     954. Click Install 
     96 
     97If you wish to localize content in other languages you will need to QuickInstall install LinguaPlone. 
     98This can be done either now from the ZMI or later, via Site Setup --> Add-on Products. 
     99 
     100In the ZMI: 
     101 
     1021. Navigate to your eduCommons instance 
     1032. Navigate to portal_quickinstaller 
     1043. Select the checkbox to the left of LinguPlone 
     1054. Click Install 
     106 
     107If you have installed LinguaPlone you will also need to select your supported languages. 
     108 
     109In the ZMI: 
     110 
     1111. Navigate to your eduCommons instance 
     1122. Navigate to portal_languages 
     1133. Select one or more Allowed languages (use the control or apple key to multi-select) 
     1144. Click Save  
     115 
     116Additional instructions for localizing content using LinguaPlone are available in LOCALIZATION.txt. 
     117Finally, you need to reorder the Layers in your eduCommons Skins Selections. 
     118In the ZMI: 
     119 
     1201. Navigate to your eduCommons instance 
     1212. Navigate to portal_skins 
     1223. Click on the Properties tab 
     1234. 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  
     1245. Click Save (be sure to click the Save button for the Skins selection section) 
     125 
     126Configure eduCommons 
     127==================== 
     128 
     129Additional configuration information is provided in SETUP.txt or online_. This will help you to further customize eduCommons. 
     130 
     131.. _online: http://educommons.com/documentation/how-to/educommons-setup-instructions 
     132 
     133 

  • enpraxis.educommons/trunk/enpraxis/educommons/LOCALIZATION.txt

    r8 r522  
    1818 
    1919======================================== 
    20 Localization with eduCommons 3.1.1-final 
     20Localization with eduCommons 3.2.1 
    2121======================================== 
    2222 

  • enpraxis.educommons/trunk/enpraxis/educommons/MIGRATIONS_OLD.txt

    r8 r522  
     1=================================== 
     2Migrating to eduCommons 3.1.1 
     3=================================== 
     4 
     5 
     6Preparation 
     7----------- 
     8A few things you should do before beginning the migration: 
     9 
     10  1. VERY IMPORTANT: SAVE A BACKUP OF YOUR Data.fs FILE, which is located in the [old instance home]/var directory of your eduCommons site. This file contains all of the content for your site. (This way you will able to restore your file from this Data.fs file if anything goes wrong.) 
     11 
     12  2. Using the Zope Management Interface (ZMI), export any customizations you have made in your [old site] --> portal_skins --> custom folder and then delete all files in the custom folder. You can re-import these customizations once you have migrated the site. 
     13 
     14  3. Verify that your current instance is eduCommons-3.0.2-final. 
     15 
     16 
     17Migration of eduCommons 3.0.2-final to 3.1.1 
     18-------------------------------------------------- 
     19 
     20The migration eduCommons from version 3.0.2-final to version 3.1.1 
     21includes the following: 
     22 
     23  1. Movement of Data.fs file to a new 3.1.1 instance 
     24 
     25  2. Migration to Plone 3.0.6 
     26 
     27  3. Migration to the eduCommons 3.1.1 instance 
     28 
     29  4. Final steps 
     30 
     31Movement of Data.fs file to a new 3.1.1 instance 
     32------------------------------------------------------ 
     33 
     34For the first step, you will move the Data.fs file from the old instance to 
     35the new instance. First of all, install an eduCommons-3.1.1 
     36instance using the installations instructions found in [new instance home]/eduCommons/docs/. Stop both sites. Then 
     37copy the Data.fs file from the var directory of the old site to the 
     38var directory of the new site: 
     39:: 
     40 
     41  sudo cp -rvfp [old instance home]/var/Data.fs [new instance home]/var/ 
     42 
     43 
     44Migration of Plone 
     45------------------ 
     46The following steps need to be performed in the ZMI, as eduCommons-3.1.1 utlizes Plone 3.0.6, instead of 3.0.4: 
     47 
     48  1. Open your 3.1.1 eduCommons site in the ZMI. (click educommons setup, then click Zope Management Interface.) 
     49 
     50  2. Run portal_migration migration (click the upgrade button on the migrate tab) 
     51 
     52 
     53Installation of FileSystemStorage Product 
     54----------------------------------------- 
     55At this point in time, we need to ensure that the FileSystemStorage AddOn Product is installed: 
     56 
     57  1. Open your 3.1.1 eduCommons site in the ZMI. (click educommons setup, then click Zope Management Interface.) 
     58 
     59  2. Navigate to portal_quickinstaller 
     60  
     61  3. Select FileSystemStorage 
     62 
     63  4. Press Install 
     64 
     65Migration of the eduCommons 3.1.1 instance 
     66------------------------------------------------ 
     67eduCommons 3.1.1 uses the portal_setup tool to perform the necessary upgrade from 3.0.2 to 3.1.1: 
     68 
     69  1. Open your 3.1.1 eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
     70  2. Navigate to portal_setup 
     71  3. Press the 'Upgrades' tab 
     72  4. From the drop down menu, select 'Products.eduCommons:default' and click Choose Profile button. 
     73  5. Choose the 'Migration :: 3.0.2 to 3.1.0' option 
     74  6. Press Upgrade 
     75 
     76 
     77Final Steps 
     78----------- 
     79 
     80  Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated. 
     81 
     82 
    183=================================== 
    284Migrating to eduCommons 3.0.2 
    … …  
    18100-------------------------------------------------- 
    19101 
    20 The migration eduCommons from version 2.3.1-final to version 3.1.1-final 
     102The migration eduCommons from version 2.3.1-final to version 3.1.1 
    21103includes the following: 
    22104 
    … …  
    27109  3. Migration of Plone 3.0.4 
    28110 
    29   4. Migration of the eduCommons 3.1.1-final instance 
     111  4. Migration of the eduCommons 3.1.1 instance 
    30112 
    31113  5. Final steps 
    … …  
    34116----------------------------------------------- 
    35117 
    36 For this step, you will need to copy the migration source code found in version 3.1.1-final.  The file is located at eduCommons/extras/PreMigrate.py . 
     118For this step, you will need to copy the migration source code found in version 3.1.1.  The file is located at eduCommons/extras/PreMigrate.py . 
    37119Copy this into [old instance]/Products/eduCommons/Extensions. 
    38120 
    … …  
    74156Migration of Plone 
    75157------------------ 
    76 The following steps need to be performed in the ZMI, as eduCommons-3.1.1-final utlizes Plone 3.0.4, instead of 2.5.x: 
     158The following steps need to be performed in the ZMI, as eduCommons-3.1.1 utlizes Plone 3.0.4, instead of 2.5.x: 
    77159 
    78160  1. Open your 3.0.2 eduCommons site in the ZMI. (click educommons setup, then click Zope Management Interface.) 
    … …  
    83165Migration of the eduCommons 3.0.2 instance 
    84166------------------------------------------------ 
    85 Run the migration script included with the 3.1.1-final instance by following these steps: 
     167Run the migration script included with the 3.1.1 instance by following these steps: 
    86168 
    87169  1. Copy the migration script found in Products/eduCommons/extras/Migrate.py to [new_instance]/Extensions/ 
    88   2. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
     170  2. Open your 3.1.1 eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
    89171  3. Navigate to the root of the ZMI (click the Root Folder link located in the upper left portion of the page) 
    90172  4. From the drop down menu, select "External method" and click the Add button. 

  • enpraxis.educommons/trunk/enpraxis/educommons/MIGRATION.txt

    r8 r522  
    11=================================== 
    2 Migrating to eduCommons 3.1.1-final 
     2Migrating to eduCommons 3.2.1 
    33=================================== 
    44 
    … …  
    88A few things you should do before beginning the migration: 
    99 
    10   1. VERY IMPORTANT: SAVE A BACKUP OF YOUR Data.fs FILE, which is located in the [old instance home]/var directory of your eduCommons site. This file contains all of the content for your site. (This way you will able to restore your file from this Data.fs file if anything goes wrong.) 
     101. VERY IMPORTANT: SAVE A BACKUP OF YOUR Data.fs FILE, which is located in the [old instance home]/var directory of your eduCommons site. This file contains all of the content for your site. (This way you will able to restore your file from this Data.fs file if anything goes wrong.) 
    1111 
    12   2. Using the Zope Management Interface (ZMI), export any customizations you have made in your [old site] --> portal_skins --> custom folder and then delete all files in the custom folder. You can re-import these customizations once you have migrated the site. 
    13  
    14   3. Verify that your current instance is eduCommons-3.0.2-final. 
     122. Verify that your current instance is eduCommons-3.1.1-final. 
    1513 
    1614 
    17 Migration of eduCommons 3.0.2-final to 3.1.1-final 
     15Migration of eduCommons 3.1.1-final to 3.2.1 
    1816-------------------------------------------------- 
    1917 
    20 The migration eduCommons from version 3.0.2-final to version 3.1.1-final 
     18The migration eduCommons from version 3.1.1-final to version 3.2.1 
    2119includes the following: 
    2220 
    23   1. Movement of Data.fs file to a new 3.1.1-final instance 
     211. Pre-migration of Data.fs in version 3.1.1-final 
    2422 
    25   2. Migration to Plone 3.0.6 
     232. Movement of Data.fs file to a new 3.2.1 instance 
    2624 
    27   3. Migration to the eduCommons 3.1.1-final instance 
     253. Migration to the eduCommons 3.2.1 instance 
    2826 
    29   4. Final steps 
     274. Export/Import of eduCommons site to a new 3.2.1 instance 
    3028 
    31 Movement of Data.fs file to a new 3.1.1-final instance 
     295. Final steps 
     30 
     31Pre-migration of Data.fs in version 3.1.1-final 
     32----------------------------------------------- 
     33 
     34For this step, you will need: 
     35 
     36* contentmigration Plone Add-on Product, available at http://pypi.python.org/packages/source/P/Products.contentmigration/Products.contentmigration-1.1.zip        
     37  
     38* to copy the migration source code found in version 3.2.1.  The file is located at eduCommons/extras/PreMigrate.py 
     39 
     40  * Copy this into [old instance]/Products/eduCommons/Extensions 
     41 
     42Add contentmigration product by following these steps: 
     43 
     441. Download the product from the aforementioned URL 
     45 
     462. Unzip the product into [old_instance]/Products 
     47 
     483. Restart zope 
     49 
     50Run the migration script by following these steps: 
     51 
     521. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
     53 
     542. From the drop down menu, select "External method" and click the Add button. 
     55 
     563. Enter the following parameters: 
     57 
     58   * Id: PreMigrate 
     59   * Title: PreMigrate 
     60   * Module Name: PreMigrate 
     61   * Function Name: pre_migrate_3_1_1_to_3_2_1 
     62 
     634. Click Add 
     64 
     655. Click on the PreMigrate script you just added 
     66 
     676. Click the test tab. 
     68 
     697. Verify that the method ran successfully. (It should give you feedback.) 
     70 
     71 
     72Movement of Data.fs file to a new 3.2.1 instance 
    3273------------------------------------------------------ 
    3374 
    34 For the first step, you will move the Data.fs file from the old instance to 
    35 the new instance. First of all, install an eduCommons-3.1.1-final 
     75For this step, you will move the Data.fs file from the old instance to 
     76the new instance. First of all, install an eduCommons-3.2.1 
    3677instance using the installations instructions found in [new instance home]/eduCommons/docs/. Stop both sites. Then 
    3778copy the Data.fs file from the var directory of the old site to the 
    38 var directory of the new site: 
     79var/filestorage directory of the new site: 
    3980:: 
    4081 
    41   sudo cp -rvfp [old instance home]/var/Data.fs [new instance home]/var/ 
     82  sudo cp -rvfp [old instance home]/var/Data.fs [new instance home]/var/filestorage 
    4283 
    4384 
    44 Migration of Plone 
    45 ------------------ 
    46 The following steps need to be performed in the ZMI, as eduCommons-3.1.1-final utlizes Plone 3.0.6, instead of 3.0.4: 
     85Migration to eduCommons 3.2.1 instance 
     86------------------------------------------------ 
     87eduCommons 3.2.1 uses the portal_setup tool to perform the necessary upgrade from 3.1.1 to 3.2.1. Due to the fact that eduCommons and it's dependencies were moved to python eggs, we must start with a new eduCommons site. The migration script will then copy and past content and relevant settings to the new installation: 
    4788 
    48   1. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons setup, then click Zope Management Interface.) 
    49  
    50   2. Run portal_migration migration (click the upgrade button on the migrate tab) 
     891. Navigate to the root of your ZMI instance and create a new eduCommons site called eduCommons321 
     902. Open your new 3.2.1 eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
     913. Navigate to portal_setup 
     924. Press the 'Upgrades' tab 
     935. From the drop down menu, select 'Products.eduCommons:default' and click Choose Profile button. 
     946. Choose the 'Migration :: 3.1.1 to 3.2.1' option 
     957. Press Upgrade 
    5196 
    5297 
    53 Installation of FileSystemStorage Product 
    54 ----------------------------------------- 
    55 At this point in time, we need to ensure that the FileSystemStorage AddOn Product is installed: 
     98Export/Import of eduCommons site to a new 3.2.1 instance 
     99-------------------------------------------------------------- 
    56100 
    57   1. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons setup, then click Zope Management Interface.) 
     101You are now ready to transfer your migrated instance to the production environment.   
    58102 
    59   2. Navigate to portal_quickinstaller 
    60   
    61   3. Select FileSystemStorage 
    62  
    63   4. Press Install 
    64  
    65 Migration of the eduCommons 3.1.1-final instance 
    66 ------------------------------------------------ 
    67 eduCommons 3.1.1-final uses the portal_setup tool to perform the necessary upgrade from 3.0.2 to 3.1.1-final: 
    68  
    69   1. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.) 
    70   2. Navigate to portal_setup 
    71   3. Press the 'Upgrades' tab 
    72   4. From the drop down menu, select 'Products.eduCommons:default' and click Choose Profile button. 
    73   5. Choose the 'Migration :: 3.0.2 to 3.1.0' option 
    74   6. Press Upgrade 
    75  
     1031. Navigate to the root of your ZMI instance 
     1042. Select the checkbox next to your new 3.2.1 eduCommons site 
     1053. Press Import/Export 
     1064. If your production environment is on the same server as your migration environment, choose 'Save file to server', else 
     107   Download the file to your local machine. Dependent on the size of your site, this process may take a long time. 
     1085. Move the .zexp into the import directory of your production site [production_site]parts/instance/import 
     1096. Navigate to the ZMI of your production site 
     1107. Press Import/Export 
     1118. Select your .zexp from the drop down list, and press Import. Dependent on the size of your site, this process may take a long time. 
     1129. If desired, rename your imported eduCommons321 site. 
    76113 
    77114Final Steps 
    78115----------- 
    79116 
    80   Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated. 
     117Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated. 
    81118 
    82119