Context Navigation

Changeset 520

Timestamp:

08/06/09 10:50:39 (3 years ago)

Author:

david

Message:

updating docs

Location:

enpraxis.educommons/trunk/enpraxis/educommons/docs

Files:

: 13 modified

CHANGES.html (modified) (1 diff)
default.css (modified) (5 diffs)
IMSContentPackaging.html (modified) (1 diff)
INSTALL.html (modified) (3 diffs)
LOCALIZATION.html (modified) (1 diff)
MIGRATION.html (modified) (10 diffs)
MIGRATIONS_OLD.html (modified) (1 diff)
PORTLETS.html (modified) (1 diff)
SeleniumRCTests.html (modified) (1 diff)
SETUP.html (modified) (1 diff)
src/default.css (modified) (5 diffs)
src/INSTALL.txt (modified) (1 diff)
src/MIGRATION.txt (modified) (5 diffs)

Legend:

: Unmodified
: Added
: Removed

enpraxis.educommons/trunk/enpraxis/educommons/docs/CHANGES.html

r515	r520
253	253	<hr class="footer" />
254	254	<a class="reference external" href="CHANGES.txt">View document source</a>.
255		Generated on: 2009-08-0~~5 22:23~~ UTC.
	255	Generated on: 2009-08-06 16:49 UTC.
256	256	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
257	257

enpraxis.educommons/trunk/enpraxis/educommons/docs/default.css

r8	r520
17	17
18	18	body {
19
20		background: #B49F78;
21		margin-top: 0px;
22		font-family: Verdana, Arial, Helvetica, sans-serif;
	19
	20	background: #173682;
	21	font-size: .9em;
23	22	text-align:center;
	23	font-family: Arial, Helvetica, sans-serif;
	24	margin: 0;
	25	padding:0;
24	26	}
25	27
26	28	.document {
27		width: 800px;
	29	width: 960px;
28	30	margin:0 auto;
29	31	padding: 0 5px 0 5px;
30	32	color: #666;
31		~~background: #FFF;~~
32	33	border: 1px solid black;
33	34	text-align: left;
	35	background: #E8E8E8;
	36	}
	37
	38	.document h1 {
	39	padding: 0;
34	40	}
35	41
…	…
177	183	margin: 2em }
178	184
179		h1, h1, h3, h4, h5, h6 {
	185	h1, h2, h3, h4, h5, h6 {
180	186	font-size: 1em;
181	187	}
…	…
185	191	margin-top: 0.4em }
186	192
187		h1~~.title~~ {
	193	h1 {
188	194	text-align: center }
189	195
…	…
266	272	margin-left: 2em ;
267	273	margin-right: 2em ;
268		background-color: #eeeeee }
	274	padding: 5px;
	275	background-color: #D3D3D3;;
	276	color: black;
	277	}
269	278
270	279	span.classifier {
…	…
330	339	color: #FFF;
331	340	}
	341
	342
	343	h1 {
	344	border-bottom: 1px solid #173682;;
	345	}
	346
	347	h2 {
	348	border-bottom: 1px dashed #173682;
	349	}
	350
	351	blockquote {
	352	background: #D3D3D3;
	353	border: 1px solid black;
	354	padding: 0 5px;
	355	}
	356
	357	img {
	358	border: 1px solid black;
	359	vertical-align:text-top;
	360	}
	361
	362

enpraxis.educommons/trunk/enpraxis/educommons/docs/IMSContentPackaging.html

r515	r520
475	475	<hr class="footer" />
476	476	<a class="reference external" href="IMSContentPackaging.txt">View document source</a>.
477		Generated on: 2009-08-0~~5 22:23~~ UTC.
	477	Generated on: 2009-08-06 16:49 UTC.
478	478	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
479	479

enpraxis.educommons/trunk/enpraxis/educommons/docs/INSTALL.html

r515	r520
5	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6	6	<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
7		<title>~~eduCommons 3.2.1 Installation~~</title>
	7	<title>Installing eduCommons 3.2.1</title>
8	8	<link rel="stylesheet" href="./default.css" type="text/css" />
9	9	</head>
10	10	<body>
11		<div class="document" id="educommons-3-2-1-installation">
12		<h1 class="title">eduCommons 3.2.1 Installation</h1>
13		<h2 class="subtitle" id="installation-instructions">Installation Instructions</h2>
	11	<div class="document" id="installing-educommons-3-2-1">
	12	<h1 class="title">Installing eduCommons 3.2.1</h1>
14	13
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>
65	15	<pre class="literal-block">
66		$ python
	16	http://sourceforge.net/projects/educommons/files/educommons/eduCommons-3.2.1-final/educommons.buildout-3.2.1-final.tar.gz/download
67	17	</pre>
68		<p>on the command line to see what version you have installed (Ctrl-D will exit).
69		You should see something like the following:</p>
	18	<p>Unarchive the package to a directory which will serve as your buildout directory. Change directories and run the bootstrap script:</p>
70	19	<pre class="literal-block">
71		Python 2.4.4 (#1, Oct 7 2006, 21:17:24)
72		[GCC 3.4.6 20060404 (Red Hat 3.4.6-3)] on linux2
73		Type "help", "copyright", "credits" or "license" for more information.
74		>>>
	20	cd eduCommons
	21	/usr/local/python2.4 bootstrap.py
	22	(in some envoronments the command will be /usr/local/bin/python2.4 bootstrap.py)
75	23	</pre>
76		<p>eduCommons and its supporting software requires version 2.4.4. If your server
77		does not have Python, or if the version of Python installed is not 2.4.4, you
78		will have to install a new version.</p>
79		<p>Some platforms may have an updated version of Python available through their
80		package managers (yum, apt, fink). If you can not find a suitable version, or
81		if you prefer to build Python from source, simply download the source package
82		and use a command line interface to type in the following instructions:</p>
	24	<p>Then run the buildout script to download all the required packages and set up the eduCommons application:</p>
83	25	<pre class="literal-block">
84		tar -zxvf Python-2.4.4.tar.gz
85		cd Python-2.4.4
86		./configure
87		make
88		sudo make install
	26	bin/buildout
89	27	</pre>
90		<p>By default this will install a new version of Python in the /usr/local directory
91		on your server.</p>
92		</li>
93		<li><p class="first">Installing Python library packages</p>
94		<p>Once you have Python installed it will be necessary to include a number of
95		libraries that extend the functionality of your Python installation. If you
96		have installed Python using a package manager, it may be likely that some
97		(or all) of these packages may also be available for installation. As long
98		as suitable library versions can be found, it should be fine to use them. In
99		cases where it is not possible to load prebuilt packages, use the following
100		instructions below:</p>
101		<ol class="loweralpha">
102		<li><p class="first">Installing Python Imaging Libary (PIL)</p>
103		<p>PIL is now a required package for the latest version of Plone.</p>
104		<p>Unpack and install Imaging-1.1.6:</p>
	28	<p>Or run the same buildout script above, plus the Selenium test runner (needed to run acceptance tests):</p>
105	29	<pre class="literal-block">
106		tar -zxvf Imaging-1.1.6.tar.gz
107		cd Imaging
108		/usr/local/bin/python setup.py build
109		sudo /usr/local/bin/python setup.py install
	30	bin/buildout -c tests.cfg
110	31	</pre>
111		<p>You may require additional packages to build the imaging library. See
112		the PIL website for additional installation instructions.</p>
113		</li>
114		<li><p class="first">Installing PyXML</p>
115		<p>Unpack and install PyXML:</p>
	32	<p>Create two directories for file system storage:</p>
116	33	<pre class="literal-block">
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
	34	mkdir parts/instance/var/fss_storage
	35	mkdir parts/instance/var/fss_backup
121	36	</pre>
122		</li>
123		<li><p class="first">Installing elementtree</p>
124		<p>elementtree is now a required dependency for the latest version of Plone.</p>
125		<p>Unpack and install elementtree:</p>
	37	<p>Once you have the buildout ready you can launch it using the following:</p>
126	38	<pre class="literal-block">
127		tar -zxvf elementtree-1.2.6.tar.gz
128		cd elementtree-1.2.6
129		/usr/local/bin/python setup.py build
130		sudo /usr/local/bin/python setup.py install
	39	bin/instance start
131	40	</pre>
132		</li>
133		<li><p class="first">Installing libxml2-python</p>
134		<p>If your target platform includes binary only distributions of libxml2 and
135		libxslt, you may need to also include the development packages in order for
136		the following to work.</p>
137		<p>Unpack and install libxml2-python:</p>
	41	<p>Or to launch in the foreground of your console:</p>
138	42	<pre class="literal-block">
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
388	44	</pre>
389	45	<p>You should now be able to open a browser and go to the ZMI with the following URL
…	…
392	48	http://<server name>:8080/manage
393	49	</pre>
394		<p>You should then get a dialog prompt asking for your Zope admin username and password.</p>
395		<~~/li~~>
396		<~~li><p class="first">Install eduCommons Product</p~~>
	50	<p>You should then get a dialog prompt asking for your Zope admin username and password. The default username/password for the buildout is admin/test1234.</p>
	51	<div class="section" id="install-educommons-product-in-your-zope-instance">
	52	<h1>Install eduCommons Product in Your Zope Instance</h1>
397	53	<p>Once you have logged into the ZMI via the management interface, you are now ready
398	54	to create the site. Start by creating a plone site with the pull down menu in the
399	55	top right corner. Give the plone site an ID and title. The ID will be used in the
400	56	URL to access the site, so name it appropriately. The title will appear several
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.
407	97	In the ZMI:</p>
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>
448	104	</ol>
449	105	</div>
	106	<div class="section" id="configure-educommons">
	107	<h1>Configure eduCommons</h1>
	108	<p>Additional configuration information is provided in SETUP.txt or <a class="reference external" href="http://educommons.com/documentation/how-to/educommons-setup-instructions">online</a>. This will help you to further customize eduCommons.</p>
450	109	</div>
451	110	</div>
…	…
453	112	<hr class="footer" />
454	113	<a class="reference external" href="INSTALL.txt">View document source</a>.
455		Generated on: 2009-08-0~~5 22:23~~ UTC.
	114	Generated on: 2009-08-06 16:49 UTC.
456	115	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
457	116

enpraxis.educommons/trunk/enpraxis/educommons/docs/LOCALIZATION.html

r515	r520
155	155	<hr class="footer" />
156	156	<a class="reference external" href="LOCALIZATION.txt">View document source</a>.
157		Generated on: 2009-08-0~~5 22:23~~ UTC.
	157	Generated on: 2009-08-06 16:49 UTC.
158	158	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
159	159

enpraxis.educommons/trunk/enpraxis/educommons/docs/MIGRATION.html

r515	r520
15	15	<h1>Preparation</h1>
16	16	<p>A few things you should do before beginning the migration:</p>
17		~~<blockquote>~~
18	17	<ol class="arabic simple">
19	18	<li>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.)</li>
20	19	<li>Verify that your current instance is eduCommons-3.1.1-final.</li>
21	20	</ol>
22		~~</blockquote>~~
23	21	</div>
24	22	<div class="section" id="migration-of-educommons-3-1-1-final-to-3-2-1">
…	…
26	24	<p>The migration eduCommons from version 3.1.1-final to version 3.2.1
27	25	includes the following:</p>
28		~~<blockquote>~~
29	26	<ol class="arabic simple">
30	27	<li>Pre-migration of Data.fs in version 3.1.1-final</li>
…	…
34	31	<li>Final steps</li>
35	32	</ol>
36		~~</blockquote>~~
37	33	</div>
38	34	<div class="section" id="pre-migration-of-data-fs-in-version-3-1-1-final">
…	…
47	43	</ul>
48	44	<p>Add contentmigration product by following these steps:</p>
49		~~<blockquote>~~
50	45	<ol class="arabic simple">
51	46	<li>Download the product from the aforementioned URL</li>
…	…
53	48	<li>Restart zope</li>
54	49	</ol>
55		~~</blockquote>~~
56	50	<p>Run the migration script by following these steps:</p>
57		~~<blockquote>~~
58	51	<ol class="arabic simple">
59	52	<li>Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.)</li>
…	…
71	64	<li>Verify that the method ran successfully. (It should give you feedback.)</li>
72	65	</ol>
73		~~</blockquote>~~
74	66	</div>
75	67	<div class="section" id="movement-of-data-fs-file-to-a-new-3-2-1-instance">
…	…
87	79	<h1>Migration to eduCommons 3.2.1 instance</h1>
88	80	<p>eduCommons 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:</p>
89		~~<blockquote>~~
90	81	<ol class="arabic simple">
91	82	<li>Navigate to the root of your ZMI instance and create a new eduCommons site called eduCommons321</li>
…	…
97	88	<li>Press Upgrade</li>
98	89	</ol>
99		~~</blockquote>~~
100	90	</div>
101	91	<div class="section" id="export-import-of-educommons-site-to-a-new-3-2-1-instance">
102	92	<h1>Export/Import of eduCommons site to a new 3.2.1 instance</h1>
103	93	<p>You are now ready to transfer your migrated instance to the production environment.</p>
104		~~<blockquote>~~
105	94	<ol class="arabic simple">
106	95	<li>Navigate to the root of your ZMI instance</li>
…	…
115	104	<li>If desired, rename your imported eduCommons321 site.</li>
116	105	</ol>
117		~~</blockquote>~~
118	106	</div>
119	107	<div class="section" id="final-steps">
120	108	<h1>Final Steps</h1>
121		<blockquote>
122		Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated.</blockquote>
	109	<p>Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated.</p>
123	110	</div>
124	111	</div>
…	…
126	113	<hr class="footer" />
127	114	<a class="reference external" href="MIGRATION.txt">View document source</a>.
128		Generated on: 2009-08-0~~5 22:23~~ UTC.
	115	Generated on: 2009-08-06 16:49 UTC.
129	116	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
130	117

enpraxis.educommons/trunk/enpraxis/educommons/docs/MIGRATIONS_OLD.html

r515	r520
223	223	<hr class="footer" />
224	224	<a class="reference external" href="MIGRATIONS_OLD.txt">View document source</a>.
225		Generated on: 2009-08-0~~5 22:23~~ UTC.
	225	Generated on: 2009-08-06 16:49 UTC.
226	226	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
227	227

enpraxis.educommons/trunk/enpraxis/educommons/docs/PORTLETS.html

r515	r520
158	158	<hr class="footer" />
159	159	<a class="reference external" href="PORTLETS.txt">View document source</a>.
160		Generated on: 2009-08-0~~5 22:23~~ UTC.
	160	Generated on: 2009-08-06 16:49 UTC.
161	161	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
162	162

enpraxis.educommons/trunk/enpraxis/educommons/docs/SeleniumRCTests.html

r515	r520
295	295	<hr class="footer" />
296	296	<a class="reference external" href="SeleniumRCTests.txt">View document source</a>.
297		Generated on: 2009-08-0~~5 22:23~~ UTC.
	297	Generated on: 2009-08-06 16:49 UTC.
298	298	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
299	299

enpraxis.educommons/trunk/enpraxis/educommons/docs/SETUP.html

r515	r520
108	108	<hr class="footer" />
109	109	<a class="reference external" href="SETUP.txt">View document source</a>.
110		Generated on: 2009-08-0~~5 22:23~~ UTC.
	110	Generated on: 2009-08-06 16:49 UTC.
111	111	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
112	112

enpraxis.educommons/trunk/enpraxis/educommons/docs/src/default.css

r8	r520
17	17
18	18	body {
19
20		background: #B49F78;
21		margin-top: 0px;
22		font-family: Verdana, Arial, Helvetica, sans-serif;
	19
	20	background: #173682;
	21	font-size: .9em;
23	22	text-align:center;
	23	font-family: Arial, Helvetica, sans-serif;
	24	margin: 0;
	25	padding:0;
24	26	}
25	27
26	28	.document {
27		width: 800px;
	29	width: 960px;
28	30	margin:0 auto;
29	31	padding: 0 5px 0 5px;
30	32	color: #666;
31		~~background: #FFF;~~
32	33	border: 1px solid black;
33	34	text-align: left;
	35	background: #E8E8E8;
	36	}
	37
	38	.document h1 {
	39	padding: 0;
34	40	}
35	41
…	…
177	183	margin: 2em }
178	184
179		h1, h1, h3, h4, h5, h6 {
	185	h1, h2, h3, h4, h5, h6 {
180	186	font-size: 1em;
181	187	}
…	…
185	191	margin-top: 0.4em }
186	192
187		h1~~.title~~ {
	193	h1 {
188	194	text-align: center }
189	195
…	…
266	272	margin-left: 2em ;
267	273	margin-right: 2em ;
268		background-color: #eeeeee }
	274	padding: 5px;
	275	background-color: #D3D3D3;;
	276	color: black;
	277	}
269	278
270	279	span.classifier {
…	…
330	339	color: #FFF;
331	340	}
	341
	342
	343	h1 {
	344	border-bottom: 1px solid #173682;;
	345	}
	346
	347	h2 {
	348	border-bottom: 1px dashed #173682;
	349	}
	350
	351	blockquote {
	352	background: #D3D3D3;
	353	border: 1px solid black;
	354	padding: 0 5px;
	355	}
	356
	357	img {
	358	border: 1px solid black;
	359	vertical-align:text-top;
	360	}
	361
	362

enpraxis.educommons/trunk/enpraxis/educommons/docs/src/INSTALL.txt

r8	r520
1		===================================
2		eduCommons $$version$$ Installation
3		===================================
	1	==================================
	2	Installing eduCommons $$version$$
	3	==================================
4	4
5		-------------------------
6		Installation Instructions
7		-------------------------
	5	Download the eduCommons $$version$$ release, available at:
8	6
9		Installation
10		============
	7	::
11	8
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-$$version$$.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-$$version$$/* .
260		sudo rm -rf eduCommons-$$version$$
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
399	10
400	11
401		~~II. Configuration Steps~~
402		~~-----------------------~~
403	12
404		1. Launch Zope
	13	Unarchive the package to a directory which will serve as your buildout directory. Change directories and run the bootstrap script:
405	14
406		Once Zope has been properly configured it can then be launched via the following
407		commands:
408		::
	15	::
409	16
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)
480	20
481	21
	22	Then run the buildout script to download all the required packages and set up the eduCommons application:
	23
	24	::
	25
	26	bin/buildout
	27
	28
	29	Or 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
	36	Create 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
	44	Once you have the buildout ready you can launch it using the following:
	45
	46	::
	47
	48	bin/instance start
	49
	50
	51	Or to launch in the foreground of your console:
	52
	53	::
	54
	55	bin/instance fg
	56
	57
	58	You 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
	66	You 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
	68	Install eduCommons Product in Your Zope Instance
	69	================================================
	70
	71	Once you have logged into the ZMI via the management interface, you are now ready
	72	to create the site. Start by creating a plone site with the pull down menu in the
	73	top right corner. Give the plone site an ID and title. The ID will be used in the
	74	URL to access the site, so name it appropriately. The title will appear several
	75	places within the eduCommons install, and should be based on your group or institution.</p>
	76	Under "Extension Profiles" you need to do a multi-select (hold down the CTRL or the
	77	Command key). Select the following so they are all highlighted:
	78
	79	1. Working Copy Support (Iterate)
	80	2. ContentLicensing
	81	3. IMSTransport
	82	4. LinguaPlone
	83	5. PloneBookmarklets
	84	6. Zip File Transport
	85	7. eduCommons
	86	8. Left Skin
	87
	88	Then click "Add Plone Site." Once the eduCommons instance has been created, you will need to QuickInstall the FileSystemStorage Product.
	89
	90	In the ZMI:
	91
	92	1. Navigate to your eduCommons instance
	93	2. Navigate to portal_quickinstaller
	94	3. Select the checkbox to the left of FileSystemStorage
	95	4. Click Install
	96
	97	If you wish to localize content in other languages you will need to QuickInstall install LinguaPlone.
	98	This can be done either now from the ZMI or later, via Site Setup --> Add-on Products.
	99
	100	In the ZMI:
	101
	102	1. Navigate to your eduCommons instance
	103	2. Navigate to portal_quickinstaller
	104	3. Select the checkbox to the left of LinguPlone
	105	4. Click Install
	106
	107	If you have installed LinguaPlone you will also need to select your supported languages.
	108
	109	In the ZMI:
	110
	111	1. Navigate to your eduCommons instance
	112	2. Navigate to portal_languages
	113	3. Select one or more Allowed languages (use the control or apple key to multi-select)
	114	4. Click Save
	115
	116	Additional instructions for localizing content using LinguaPlone are available in LOCALIZATION.txt.
	117	Finally, you need to reorder the Layers in your eduCommons Skins Selections.
	118	In the ZMI:
	119
	120	1. Navigate to your eduCommons instance
	121	2. Navigate to portal_skins
	122	3. Click on the Properties tab
	123	4. 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
	124	5. Click Save (be sure to click the Save button for the Skins selection section)
	125
	126	Configure eduCommons
	127	====================
	128
	129	Additional 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/docs/src/MIGRATION.txt

r515	r520
8	8	A few things you should do before beginning the migration:
9	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.)
	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	11
12		2. Verify that your current instance is eduCommons-3.1.1-final.
	12	2. Verify that your current instance is eduCommons-3.1.1-final.
13	13
14	14
…	…
19	19	includes the following:
20	20
21		1. Pre-migration of Data.fs in version 3.1.1-final
	21	1. Pre-migration of Data.fs in version 3.1.1-final
22	22
23		2. Movement of Data.fs file to a new $$version$$ instance
	23	2. Movement of Data.fs file to a new $$version$$ instance
24	24
25		3. Migration to the eduCommons $$version$$ instance
	25	3. Migration to the eduCommons $$version$$ instance
26	26
27		4. Export/Import of eduCommons site to a new $$version$$ instance
	27	4. Export/Import of eduCommons site to a new $$version$$ instance
28	28
29		5. Final steps
	29	5. Final steps
30	30
31	31	Pre-migration of Data.fs in version 3.1.1-final
…	…
42	42	Add contentmigration product by following these steps:
43	43
44		1. Download the product from the aforementioned URL
	44	1. Download the product from the aforementioned URL
45	45
46		2. Unzip the product into [old_instance]/Products
	46	2. Unzip the product into [old_instance]/Products
47	47
48		3. Restart zope
	48	3. Restart zope
49	49
50	50	Run the migration script by following these steps:
51	51
52		1. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.)
	52	1. Open your 3.1.1-final eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.)
53	53
54		2. From the drop down menu, select "External method" and click the Add button.
	54	2. From the drop down menu, select "External method" and click the Add button.
55	55
56		3. Enter the following parameters:
	56	3. Enter the following parameters:
57	57
58		* Id: PreMigrate
59		* Title: PreMigrate
60		* Module Name: PreMigrate
61		* Function Name: pre_migrate_3_1_1_to_3_2_1
	58	* Id: PreMigrate
	59	* Title: PreMigrate
	60	* Module Name: PreMigrate
	61	* Function Name: pre_migrate_3_1_1_to_3_2_1
62	62
63		4. Click Add
	63	4. Click Add
64	64
65		5. Click on the PreMigrate script you just added
	65	5. Click on the PreMigrate script you just added
66	66
67		6. Click the test tab.
	67	6. Click the test tab.
68	68
69		7. Verify that the method ran successfully. (It should give you feedback.)
	69	7. Verify that the method ran successfully. (It should give you feedback.)
70	70
71	71
…	…
87	87	eduCommons $$version$$ uses the portal_setup tool to perform the necessary upgrade from 3.1.1 to $$version$$. 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:
88	88
89		1. Navigate to the root of your ZMI instance and create a new eduCommons site called eduCommons321
90		2. Open your new $$version$$ eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.)
91		3. Navigate to portal_setup
92		4. Press the 'Upgrades' tab
93		5. From the drop down menu, select 'Products.eduCommons:default' and click Choose Profile button.
94		6. Choose the 'Migration :: 3.1.1 to 3.2.1' option
95		7. Press Upgrade
	89	1. Navigate to the root of your ZMI instance and create a new eduCommons site called eduCommons321
	90	2. Open your new $$version$$ eduCommons site in the ZMI. (click educommons Setup, then click Zope Management Interface.)
	91	3. Navigate to portal_setup
	92	4. Press the 'Upgrades' tab
	93	5. From the drop down menu, select 'Products.eduCommons:default' and click Choose Profile button.
	94	6. Choose the 'Migration :: 3.1.1 to 3.2.1' option
	95	7. Press Upgrade
96	96
97	97
…	…
101	101	You are now ready to transfer your migrated instance to the production environment.
102	102
103		1. Navigate to the root of your ZMI instance
104		2. Select the checkbox next to your new $$version$$ eduCommons site
105		3. Press Import/Export
106		4. 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.
108		5. Move the .zexp into the import directory of your production site [production_site]parts/instance/import
109		6. Navigate to the ZMI of your production site
110		7. Press Import/Export
111		8. 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.
112		9. If desired, rename your imported eduCommons321 site.
	103	1. Navigate to the root of your ZMI instance
	104	2. Select the checkbox next to your new $$version$$ eduCommons site
	105	3. Press Import/Export
	106	4. 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.
	108	5. Move the .zexp into the import directory of your production site [production_site]parts/instance/import
	109	6. Navigate to the ZMI of your production site
	110	7. Press Import/Export
	111	8. 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.
	112	9. If desired, rename your imported eduCommons321 site.
113	113
114	114	Final Steps
115	115	-----------
116	116
117		Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated.
	117	Your site should now be migrated. Navigate to your site in the browser and ensure it has migrated.
118	118
119	119

Context Navigation

Changeset 520

Legend:

Download in other formats: