Download as
Browse Code »

Commit 4a08f8bdf0e7dde99634a8ac7fe9d8d7fd965175

Authored by Sergio Oliveira
1 parent ac9ca554
Exists in master and in 39 other branches 1.12.x, add_requests_as_dep, celery_service, change-passwd-signal, check-port, colab-signals, colab-vcard, colab_search, colab_tag, colab_tag_merge, community_association, detach_super_archives, fix-dashboard, fix-message-preview, fix_app_label, fix_cache_count_spb, fix_header, fixed_gitlab_import, go_to_profile_panel, header_footer, layout-fix, mobile_user_scalable, move_out_plugins, paginate-threads, profile_integration, refactor-data-import, remove-gitlab-plugin, removing_namespace, search_block, search_filters, spb-release/3.0, split_screen, stable, startplugin, timestamp_plugins, translation_review, user_regex, validate-passwd, workin_whoosh_temp

Removed old docs

Showing 9 changed files with 0 additions and 1692 deletions   Show diff stats
docs/Makefile
View file @ac9ca55
@@ -1,177 +0,0 @@ @@ -1,177 +0,0 @@
1 -# Makefile for Sphinx documentation  
2 -#  
3 -  
4 -# You can set these variables from the command line.  
5 -SPHINXOPTS =  
6 -SPHINXBUILD = sphinx-build  
7 -PAPER =  
8 -BUILDDIR = _build  
9 -  
10 -# User-friendly check for sphinx-build  
11 -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)  
12 -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)  
13 -endif  
14 -  
15 -# Internal variables.  
16 -PAPEROPT_a4 = -D latex_paper_size=a4  
17 -PAPEROPT_letter = -D latex_paper_size=letter  
18 -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .  
19 -# the i18n builder cannot share the environment and doctrees with the others  
20 -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .  
21 -  
22 -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext  
23 -  
24 -help:  
25 - @echo "Please use \`make <target>' where <target> is one of"  
26 - @echo " html to make standalone HTML files"  
27 - @echo " dirhtml to make HTML files named index.html in directories"  
28 - @echo " singlehtml to make a single large HTML file"  
29 - @echo " pickle to make pickle files"  
30 - @echo " json to make JSON files"  
31 - @echo " htmlhelp to make HTML files and a HTML help project"  
32 - @echo " qthelp to make HTML files and a qthelp project"  
33 - @echo " devhelp to make HTML files and a Devhelp project"  
34 - @echo " epub to make an epub"  
35 - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"  
36 - @echo " latexpdf to make LaTeX files and run them through pdflatex"  
37 - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"  
38 - @echo " text to make text files"  
39 - @echo " man to make manual pages"  
40 - @echo " texinfo to make Texinfo files"  
41 - @echo " info to make Texinfo files and run them through makeinfo"  
42 - @echo " gettext to make PO message catalogs"  
43 - @echo " changes to make an overview of all changed/added/deprecated items"  
44 - @echo " xml to make Docutils-native XML files"  
45 - @echo " pseudoxml to make pseudoxml-XML files for display purposes"  
46 - @echo " linkcheck to check all external links for integrity"  
47 - @echo " doctest to run all doctests embedded in the documentation (if enabled)"  
48 -  
49 -clean:  
50 - rm -rf $(BUILDDIR)/*  
51 -  
52 -html:  
53 - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html  
54 - @echo  
55 - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."  
56 -  
57 -dirhtml:  
58 - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml  
59 - @echo  
60 - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."  
61 -  
62 -singlehtml:  
63 - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml  
64 - @echo  
65 - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."  
66 -  
67 -pickle:  
68 - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle  
69 - @echo  
70 - @echo "Build finished; now you can process the pickle files."  
71 -  
72 -json:  
73 - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json  
74 - @echo  
75 - @echo "Build finished; now you can process the JSON files."  
76 -  
77 -htmlhelp:  
78 - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp  
79 - @echo  
80 - @echo "Build finished; now you can run HTML Help Workshop with the" \  
81 - ".hhp project file in $(BUILDDIR)/htmlhelp."  
82 -  
83 -qthelp:  
84 - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp  
85 - @echo  
86 - @echo "Build finished; now you can run "qcollectiongenerator" with the" \  
87 - ".qhcp project file in $(BUILDDIR)/qthelp, like this:"  
88 - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhcp"  
89 - @echo "To view the help file:"  
90 - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ColabSoftwareDocumentation.qhc"  
91 -  
92 -devhelp:  
93 - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp  
94 - @echo  
95 - @echo "Build finished."  
96 - @echo "To view the help file:"  
97 - @echo "# mkdir -p $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"  
98 - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ColabSoftwareDocumentation"  
99 - @echo "# devhelp"  
100 -  
101 -epub:  
102 - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub  
103 - @echo  
104 - @echo "Build finished. The epub file is in $(BUILDDIR)/epub."  
105 -  
106 -latex:  
107 - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex  
108 - @echo  
109 - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."  
110 - @echo "Run \`make' in that directory to run these through (pdf)latex" \  
111 - "(use \`make latexpdf' here to do that automatically)."  
112 -  
113 -latexpdf:  
114 - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex  
115 - @echo "Running LaTeX files through pdflatex..."  
116 - $(MAKE) -C $(BUILDDIR)/latex all-pdf  
117 - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."  
118 -  
119 -latexpdfja:  
120 - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex  
121 - @echo "Running LaTeX files through platex and dvipdfmx..."  
122 - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja  
123 - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."  
124 -  
125 -text:  
126 - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text  
127 - @echo  
128 - @echo "Build finished. The text files are in $(BUILDDIR)/text."  
129 -  
130 -man:  
131 - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man  
132 - @echo  
133 - @echo "Build finished. The manual pages are in $(BUILDDIR)/man."  
134 -  
135 -texinfo:  
136 - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo  
137 - @echo  
138 - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."  
139 - @echo "Run \`make' in that directory to run these through makeinfo" \  
140 - "(use \`make info' here to do that automatically)."  
141 -  
142 -info:  
143 - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo  
144 - @echo "Running Texinfo files through makeinfo..."  
145 - make -C $(BUILDDIR)/texinfo info  
146 - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."  
147 -  
148 -gettext:  
149 - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale  
150 - @echo  
151 - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."  
152 -  
153 -changes:  
154 - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes  
155 - @echo  
156 - @echo "The overview file is in $(BUILDDIR)/changes."  
157 -  
158 -linkcheck:  
159 - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck  
160 - @echo  
161 - @echo "Link check complete; look for any errors in the above output " \  
162 - "or in $(BUILDDIR)/linkcheck/output.txt."  
163 -  
164 -doctest:  
165 - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest  
166 - @echo "Testing of doctests in the sources finished, look at the " \  
167 - "results in $(BUILDDIR)/doctest/output.txt."  
168 -  
169 -xml:  
170 - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml  
171 - @echo  
172 - @echo "Build finished. The XML files are in $(BUILDDIR)/xml."  
173 -  
174 -pseudoxml:  
175 - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml  
176 - @echo  
177 - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."  
docs/_static/logo_small.png
View file @ac9ca55

2.95 KB
docs/about.rst
View file @ac9ca55
@@ -1,35 +0,0 @@ @@ -1,35 +0,0 @@
1 -.. -*- coding: utf-8 -*-  
2 -  
3 -.. highlight:: rest  
4 -  
5 -.. _colab_software:  
6 -  
7 -What is Colab?  
8 -==============  
9 -  
10 -Application that integrates existing systems to represent the contributions of the members through:  
11 -  
12 -* The amendments to the Wiki trac system.  
13 -  
14 -* Changes to the trac system code.  
15 -  
16 -* Discussions at the mailman list.  
17 -  
18 -* And other systems in the community.  
19 -  
20 -Features  
21 ---------  
22 -  
23 -* Developerd by Interlegis Communities http://colab.interlegis.leg.br/  
24 -  
25 -* Writed with Python http://python.org/  
26 -  
27 -* Build in Django Web Framework https://www.djangoproject.com/  
28 -  
29 -* Search engine with Solr https://lucene.apache.org/solr/  
30 -  
31 -Integration with Solr  
32 ----------------------  
33 -  
34 -This software uses Apache Solr as search platform based on Apache Lucene.  
35 -  
docs/cent-os/colab-centos-instalation-tutorial.rst
View file @ac9ca55
@@ -1,718 +0,0 @@ @@ -1,718 +0,0 @@
1 -.. -*- coding: utf-8 -*-  
2 -  
3 -.. highlight:: rest  
4 -  
5 -.. _colab_software:  
6 -  
7 -====================  
8 -Colab on Cent OS 6.4  
9 -====================  
10 -  
11 -Nginx 1.6  
12 -=========  
13 -  
14 -Download the nginx  
15 -  
16 -.. code-block::  
17 - cd /tmp  
18 - wget http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm  
19 - sudo rpm -ivh nginx-release-centos-6-0.el6.ngx.noarch.rpm  
20 -  
21 -Install nginx  
22 -  
23 -.. code-block::  
24 -  
25 - sudo yum install nginx -y  
26 -  
27 -Start nginx with the system  
28 -  
29 -.. code-block::  
30 -  
31 - sudo chkconfig nginx on  
32 -  
33 -  
34 -Postgres Server 9.3  
35 -===================  
36 -  
37 -Install postgresql  
38 -  
39 -.. code-block::  
40 -  
41 - sudo yum localinstall http://yum.postgresql.org/9.3/redhat/rhel-6-x86_64/pgdg-centos93-9.3-1.noarch.rpm -y  
42 - sudo yum install postgresql93 postgresql93-devel postgresql93-libs postgresql93-server -y  
43 -  
44 -Initialize database  
45 -  
46 -.. code-block::  
47 -  
48 - sudo service postgresql-9.3 initdb  
49 -  
50 -Start postgresql with the system  
51 -  
52 -.. code-block::  
53 -  
54 - sudo chkconfig postgresql-9.3 on  
55 -  
56 -Start postgresql  
57 -  
58 -.. code-block::  
59 -  
60 - sudo service postgresql-9.3 start  
61 -  
62 -Put the binaries of postgres in the PATH variable  
63 -  
64 -.. code-block::  
65 -  
66 - echo "export PATH=$PATH:/usr/pgsql-9.3/bin/" >> ~/.bashrc  
67 - source ~/.bashrc  
68 - sudo su  
69 - echo "export PATH=$PATH:/usr/pgsql-9.3/bin/" >> ~/.bashrc  
70 - source ~/.bashrc  
71 - exit  
72 -  
73 -Edit sudoers file  
74 -  
75 -.. code-block::  
76 -  
77 - sudo vim /etc/sudoers  
78 -  
79 -Inside sudoers file change the line  
80 -  
81 -.. code-block::  
82 -  
83 - Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin  
84 -  
85 -To this line  
86 -  
87 -.. code-block::  
88 -  
89 - Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/pgsql-9.3/bin/  
90 -  
91 -And save the file  
92 -  
93 -.. code-block::  
94 -  
95 - [ESC]:wq!  
96 -  
97 -Create a password for postgresql database, in this case we have an user called ``colab``, and we will set its password too.  
98 -  
99 -.. code-block::  
100 -  
101 - sudo -u postgres psql  
102 -  
103 -.. code-block::  
104 -  
105 - ALTER USER postgres WITH PASSWORD 'colab';  
106 - CREATE USER colab SUPERUSER INHERIT CREATEDB CREATEROLE;  
107 - ALTER USER colab PASSWORD 'colab';  
108 - \q  
109 -  
110 -Restart the postgresql  
111 -  
112 -.. code-block::  
113 -  
114 - sudo service postgresql-9.3 restart  
115 -  
116 -  
117 -Trac 1.0  
118 -========  
119 -  
120 -Install the dependencies  
121 -  
122 -.. code-block::  
123 -  
124 - sudo yum install gcc python-devel python-setuptools -y  
125 -  
126 -Install this package to use Trac with postgresql  
127 -  
128 -.. code-block::  
129 -  
130 - sudo easy_install psycopg2  
131 -  
132 -If you are going to use postgresql, create the database for trac  
133 -  
134 -.. code-block::  
135 -  
136 - sudo -u postgres psql  
137 -  
138 -.. code-block::  
139 -  
140 - CREATE DATABASE "trac_colab" WITH OWNER "colab" ENCODING 'UTF8' LC_COLLATE='en_US.UTF-8' LC_CTYPE='en_US.UTF-8' TEMPLATE=template0;  
141 - \q  
142 -  
143 -And change the database authentication to md5  
144 -  
145 -.. code-block::  
146 -  
147 - sudo vi /var/lib/pgsql/9.3/data/pg_hba.conf  
148 -  
149 -.. code-block::  
150 -  
151 - [ESC]:%s/peer/md5  
152 - [ESC]:%s/ident/md5  
153 -  
154 -.. code-block::  
155 -  
156 - [ESC]:wq!  
157 -  
158 -And restart postgresql  
159 -  
160 -.. code-block::  
161 -  
162 - sudo service postgresql-9.3 restart  
163 -  
164 -  
165 -Install Trac  
166 -  
167 -.. code-block::  
168 -  
169 - sudo easy_install trac  
170 -  
171 -Intiate Trac  
172 -  
173 -.. code-block::  
174 -  
175 - sudo mkdir -p /opt/trac  
176 - sudo trac-admin /opt/trac initenv  
177 -  
178 -In ``Project Name [My Project]>`` we used ``colab``. And if you are going to use the postgresql, put this line in ``Database connection string [sqlite:db/trac.db]>``, and we are using the user ``colab``.  
179 -  
180 -.. code-block::  
181 -  
182 - postgres://colab:colab@/trac_colab?host=localhost  
183 -  
184 -SVN Plugin  
185 -  
186 -Install subversion  
187 -  
188 -.. code-block::  
189 -  
190 - sudo yum install subversion -y  
191 -  
192 -Create a repository and initiate it  
193 -  
194 -.. code-block::  
195 -  
196 - mkdir -p /home/colab/myrepo  
197 - mkdir -p /tmp/project/{branches,tags,trunk}  
198 - svnadmin create /home/colab/myrepo/  
199 - svn import /tmp/project file:///home/colab/myrepo/ -m "initial import"  
200 - sudo rm -rf /tmp/project  
201 - find /home/colab/myrepo -type f -exec chmod 660 {} \;  
202 - find /home/colab/myrepo -type d -exec chmod 2770 {} \;  
203 -  
204 -Edit the Trac's configuration file  
205 -  
206 -.. code-block::  
207 -  
208 - sudo vim /opt/trac/conf/trac.ini  
209 -  
210 -Inside the trac.ini file.  
211 -Replace the line  
212 -  
213 -.. code-block::  
214 -  
215 - repository_dir =  
216 -  
217 -With this one  
218 -  
219 -.. code-block::  
220 -  
221 - repository_dir = /home/colab/myrepo/  
222 -  
223 -Insert those lines in the end of file to activate the view of subversion on Trac.  
224 -  
225 -.. code-block::  
226 -  
227 - [components]  
228 - tracopt.versioncontrol.svn.* = enabled  
229 -  
230 -.. code-block::  
231 -  
232 - [ESC]:wq!  
233 -  
234 -Remote User  
235 -  
236 -Create the plugin to set the remote user variable  
237 -  
238 -.. code-block::  
239 -  
240 - sudo vim /opt/trac/plugins/remote-user-auth.py  
241 -  
242 -And put this in the file  
243 -  
244 -.. code-block::  
245 -  
246 - from trac.core import *  
247 - from trac.config import BoolOption  
248 - from trac.web.api import IAuthenticator  
249 -  
250 - class MyRemoteUserAuthenticator(Component):  
251 -  
252 - implements(IAuthenticator)  
253 -  
254 - obey_remote_user_header = BoolOption('trac', 'obey_remote_user_header', 'false',  
255 - """Whether the 'Remote-User:' HTTP header is to be trusted for user logins  
256 - (''since ??.??').""")  
257 -  
258 - def authenticate(self, req):  
259 - if self.obey_remote_user_header and req.get_header('Remote-User'):  
260 - return req.get_header('Remote-User')  
261 - return None  
262 -  
263 -Save the file  
264 -  
265 -.. code-block::  
266 -  
267 - [ESC]:wq!  
268 -  
269 -Edit Trac's configuration file  
270 -  
271 -.. code-block::  
272 -  
273 - sudo vim /opt/trac/conf/trac.ini  
274 -  
275 -Insert this line in the [trac] session.  
276 -  
277 -.. code-block::  
278 -  
279 - obey_remote_user_header = true  
280 -  
281 -Save and quit  
282 -  
283 -.. code-block::  
284 -  
285 - [ESC]:wq!  
286 -  
287 -*NOTE:*  
288 - To run Trac: ``sudo tracd --port 5000 /opt/trac`` . And to access it `http://localhost:5000 <http://localhost:5000>`_  
289 -  
290 -Solr 4.6.1  
291 -==========  
292 -  
293 -Download Solr and unpack it  
294 -  
295 -.. code-block::  
296 -  
297 - cd /tmp  
298 - sudo wget http://archive.apache.org/dist/lucene/solr/4.6.1/solr-4.6.1.tgz  
299 - sudo tar xvzf solr-4.6.1.tgz  
300 -  
301 -Install Solr in ``/usr/share``  
302 -  
303 -.. code-block::  
304 -  
305 - sudo mv solr-4.6.1 /usr/share/solr  
306 - sudo cp /usr/share/solr/example/webapps/solr.war /usr/share/solr/example/solr/solr.war  
307 -  
308 -Remove the ``updateLog`` tag, editing the solrconfig.xml  
309 -  
310 -.. code-block::  
311 -  
312 - sudo vim /usr/share/solr/example/solr/collection1/conf/solrconfig.xml  
313 -  
314 -And remove those lines  
315 -  
316 -.. code-block::  
317 -  
318 - <updateLog>  
319 - <str name="dir">${solr.ulog.dir:}</str>  
320 - </updateLog>  
321 -  
322 -.. code-block::  
323 -  
324 - [ESC]wq!  
325 -  
326 -*NOTE:*  
327 -  
328 - To run Solr  
329 - cd /usr/share/solr/example/; sudo java -jar start.jar  
330 -  
331 -Mailman  
332 -=======  
333 -  
334 -Install the fcgiwrap  
335 -  
336 -.. code-block::  
337 -  
338 - sudo yum install fcgi-devel git -y  
339 - cd /tmp  
340 - sudo git clone https://github.com/gnosek/fcgiwrap.git  
341 - cd fcgiwrap  
342 - sudo yum groupinstall "Development tools" -y  
343 - sudo autoreconf -i  
344 - sudo ./configure  
345 - sudo make  
346 - sudo make install  
347 -  
348 -Now you can install spawn fcgi  
349 -  
350 -.. code-block::  
351 -  
352 - sudo yum install spawn-fcgi -y  
353 -  
354 -And edit the spawn-fgci configuration file  
355 -  
356 -.. code-block::  
357 -  
358 - sudo vim /etc/sysconfig/spawn-fcgi  
359 -  
360 -.. code-block::  
361 -  
362 - FCGI_SOCKET=/var/run/fcgiwrap.socket  
363 - FCGI_PROGRAM=/usr/local/sbin/fcgiwrap  
364 - FCGI_USER=apache  
365 - FCGI_GROUP=apache  
366 - FCGI_EXTRA_OPTIONS="-M 0770"  
367 - OPTIONS="-u $FCGI_USER -g $FCGI_GROUP -s $FCGI_SOCKET -S $FCGI_EXTRA_OPTIONS -F 1 -P /var/run/spawn-fcgi.pid -- $FCGI_PROGRAM"  
368 -  
369 -Save and quit  
370 -  
371 -.. code-block::  
372 -  
373 - [ESC]:wq!  
374 -  
375 -Add nginx to the apache's user group, to grant all the right permissions to spawn-fcgi  
376 -  
377 -.. code-block::  
378 -  
379 - sudo usermod -a -G apache nginx  
380 -  
381 -Put spaw-fcgi to start with the system, and start it  
382 -  
383 -.. code-block::  
384 -  
385 - sudo chkconfig --levels 235 spawn-fcgi on  
386 - sudo /etc/init.d/spawn-fcgi start  
387 -  
388 -Install mailman  
389 -  
390 -.. code-block::  
391 -  
392 - sudo yum install mailman -y  
393 -  
394 -Create a list, in this case we called it ``mailman``  
395 -  
396 -.. code-block::  
397 -  
398 - sudo /usr/lib/mailman/bin/newlist mailman  
399 -  
400 -Put a real email in ``Enter the email of the person running the list:``. And put a password in ``Initial mailman password:``, we used ``admin`` as password.  
401 -  
402 -And add that list to the aliases file  
403 -  
404 -.. code-block::  
405 -  
406 - sudo vim /etc/aliases  
407 -  
408 -.. code-block::  
409 -  
410 - ## mailman mailing list  
411 - mailman: "|/usr/lib/mailman/mail/mailman post mailman"  
412 - mailman-admin: "|/usr/lib/mailman/mail/mailman admin mailman"  
413 - mailman-bounces: "|/usr/lib/mailman/mail/mailman bounces mailman"  
414 - mailman-confirm: "|/usr/lib/mailman/mail/mailman confirm mailman"  
415 - mailman-join: "|/usr/lib/mailman/mail/mailman join mailman"  
416 - mailman-leave: "|/usr/lib/mailman/mail/mailman leave mailman"  
417 - mailman-owner: "|/usr/lib/mailman/mail/mailman owner mailman"  
418 - mailman-request: "|/usr/lib/mailman/mail/mailman request mailman"  
419 - mailman-subscribe: "|/usr/lib/mailman/mail/mailman subscribe mailman"  
420 - mailman-unsubscribe: "|/usr/lib/mailman/mail/mailman unsubscribe mailman"  
421 -  
422 -.. code-block::  
423 -  
424 - [ESC]:wq!  
425 -  
426 -Now, reset the aliases  
427 -  
428 -.. code-block::  
429 -  
430 - sudo newaliases  
431 -  
432 -Restart postfix  
433 -  
434 -.. code-block::  
435 -  
436 - sudo /etc/init.d/postfix restart  
437 -  
438 -And add the mailman to start with the system  
439 -  
440 -.. code-block::  
441 -  
442 - sudo chkconfig --levels 235 mailman on  
443 -  
444 -Start mailman and create a symbolic link inside cgi-bin  
445 -  
446 -.. code-block::  
447 -  
448 - sudo /etc/init.d/mailman start  
449 - cd /usr/lib/mailman/cgi-bin/  
450 - sudo ln -s ./ mailman  
451 -  
452 -Create a config file to mailman inside nginx  
453 -  
454 -.. code-block::  
455 -  
456 - sudo vim /etc/nginx/conf.d/list.conf  
457 -  
458 -.. code-block::  
459 -  
460 - server {  
461 - server_name localhost;  
462 - listen 8080;  
463 -  
464 - location /mailman/cgi-bin {  
465 - root /usr/lib;  
466 - fastcgi_split_path_info (^/mailman/cgi-bin/[^/]*)(.*)$;  
467 - include /etc/nginx/fastcgi_params;  
468 - fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;  
469 - fastcgi_param PATH_INFO $fastcgi_path_info;  
470 - fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;  
471 - fastcgi_intercept_errors on;  
472 - fastcgi_pass unix:/var/run/fcgiwrap.socket;  
473 - }  
474 - location /images/mailman {  
475 - alias /usr/lib/mailman/icons;  
476 - }  
477 - location /pipermail {  
478 - alias /var/lib/mailman/archives/public;  
479 - autoindex on;  
480 - }  
481 - }  
482 -  
483 -.. code-block::  
484 -  
485 - [ESC]:wq!  
486 -  
487 -Restart nginx to update the new configuration  
488 -  
489 -.. code-block::  
490 -  
491 - sudo service nginx restart  
492 -  
493 -Edit the config script of mailman, to fix the url used by it.  
494 -  
495 -.. code-block::  
496 -  
497 - sudo vim /etc/mailman/mm_cfg.py  
498 -  
499 -Add this line in the end of file  
500 -  
501 -.. code-block::  
502 -  
503 - DEFAULT_URL_PATTERN = 'https://%s/mailman/cgi-bin/'  
504 -  
505 -.. code-block::  
506 -  
507 - [ESC]:wq!  
508 -  
509 -Run the fix_url and restart mailman.  
510 -  
511 -.. code-block::  
512 -  
513 - sudo /usr/lib/mailman/bin/withlist -l -a -r fix_url  
514 - sudo service mailman restart  
515 -  
516 -*NOTE:*  
517 - You can access mailman in this url: `http://localhost:8080/mailman/cgi-bin/listinfo <http://localhost:8080/mailman/cgi-bin/listinfo>`_  
518 -  
519 -  
520 -Python 2.7 + Django 1.6  
521 -=======================  
522 -  
523 -Install the devel tools to build specific python 2.7 modules  
524 -  
525 -.. code-block::  
526 -  
527 - sudo yum groupinstall "Development tools" -y  
528 - sudo yum install zlib-devel bzip2-devel openssl-devel ncurses-devel libxslt-devel -y  
529 -  
530 -Download and compile Python 2.7  
531 -  
532 -.. code-block::  
533 -  
534 - cd /tmp  
535 - sudo wget --no-check-certificate https://www.python.org/ftp/python/2.7.6/Python-2.7.6.tar.xz  
536 - sudo tar xf Python-2.7.6.tar.xz  
537 - cd Python-2.7.6  
538 - sudo ./configure --prefix=/usr/local  
539 - sudo make  
540 -  
541 -Install python 2.7 as an alternative python, because cent os uses python 2.6 in the system.  
542 -  
543 -.. code-block::  
544 -  
545 - sudo make altinstall  
546 -  
547 -Update the PATH variable to execute python as root.  
548 -  
549 -.. code-block::  
550 -  
551 - sudo su  
552 - echo "export PATH=$PATH:/usr/local/bin/" >> ~/.bashrc  
553 - source ~/.bashrc  
554 - exit  
555 -  
556 -Install the easy_install for python 2.7  
557 -  
558 -.. code-block::  
559 -  
560 - cd /tmp  
561 - sudo wget https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py  
562 - sudo /usr/local/bin/python2.7 ez_setup.py  
563 -  
564 -Instal pip 2.7  
565 -  
566 -.. code-block::  
567 -  
568 - sudo /usr/local/bin/easy_install-2.7 pip  
569 -  
570 -Install additional packages to python.  
571 -  
572 -.. code-block::  
573 -  
574 - sudo yum remove libevent -y  
575 - sudo yum install mercurial libevent-devel python-devel -y  
576 -  
577 -Edit sudores file to let ``python2.7`` execute in sudo mode.  
578 -  
579 -*NOTE:*  
580 -  
581 - The path ``/usr/bin:/usr/pgsql-9.3/bin/`` will be only in this file if you installed postgresql before, if you didn't just remove it from those lines.  
582 -  
583 -.. code-block::  
584 -  
585 - sudo vim /etc/sudoers  
586 -  
587 -Change the line  
588 -  
589 -.. code-block::  
590 -  
591 - Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/pgsql-9.3/bin/  
592 -  
593 -To  
594 -  
595 -.. code-block::  
596 -  
597 - Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/pgsql-9.3/bin/:/usr/local/bin/  
598 -  
599 -.. code-block::  
600 -  
601 - [ESC]:wq!  
602 -  
603 -Django 1.6  
604 -  
605 -Install django and uwsgi  
606 -  
607 -.. code-block::  
608 -  
609 - sudo pip2.7 install django  
610 - sudo pip2.7 install uwsgi  
611 -  
612 -Colab  
613 -=====  
614 -  
615 -Install git and clone colab  
616 -  
617 -.. code-block::  
618 -  
619 - sudo yum install git -y  
620 - cd /opt  
621 - sudo git clone https://github.com/colab-community/colab.git  
622 -  
623 -Install colab requirements  
624 -  
625 -.. code-block::  
626 -  
627 - sudo pip2.7 install mimeparse  
628 - sudo pip2.7 install -r /opt/colab/requirements.txt  
629 - sudo pip2.7 uninstall django_browserid -y  
630 - sudo pip2.7 install django_browserid==0.9  
631 -  
632 -  
633 -Create the local_settings file in colab folder  
634 -  
635 -.. code-block::  
636 -  
637 - sudo cp /opt/colab/src/colab/local_settings-dev.py /opt/colab/src/colab/local_settings.py  
638 -  
639 -And edit it inserting browser id in the end of file  
640 -  
641 -.. code-block::  
642 -  
643 - sudo vim /opt/colab/src/colab/local_settings.py  
644 -  
645 -.. code-block::  
646 -  
647 - BROWSERID_AUDIENCES = [SITE_URL, SITE_URL.replace('https', 'http')]  
648 -  
649 -.. code-block::  
650 -  
651 - [ESC]:wq!  
652 -  
653 -Create the database for colab, remind that the user colab was created at the postgresql section  
654 -  
655 -.. code-block::  
656 -  
657 - sudo -u postgres psql  
658 -  
659 -.. code-block::  
660 -  
661 - CREATE DATABASE "colab" WITH OWNER "colab" ENCODING 'UTF8' LC_COLLATE='en_US.UTF-8' LC_CTYPE='en_US.UTF-8' TEMPLATE=template0;  
662 - \q  
663 -  
664 -  
665 -Build the solr schema.xml  
666 -  
667 -.. code-block::  
668 -  
669 - cd /opt/colab/src  
670 - sudo su  
671 - python2.7 manage.py build_solr_schema > /opt/colab/src/schema.xml  
672 - exit  
673 -  
674 -Copy the shcema to solr  
675 -  
676 -.. code-block::  
677 -  
678 - sudo cp /opt/colab/src/schema.xml /usr/share/solr/example/solr/collection1/conf/schema.xml  
679 - sudo rm -f /opt/colab/src/schema.xml  
680 -  
681 -Edit the schema to change the ``stopwords_en.txt`` to ``lang/stopwords_en.txt``  
682 -  
683 -.. code-block::  
684 -  
685 - sudo vim /usr/share/solr/example/solr/collection1/conf/schema.xml  
686 -  
687 -.. code-block::  
688 -  
689 - [ESC]:%s/stopwords_en.txt/lang\/stopwords_en.txt  
690 - [ESC]:wq!  
691 -  
692 -  
693 -Syncronize and migrate the colab's database  
694 -  
695 -.. code-block::  
696 -  
697 - cd /opt/colab/src  
698 - python2.7 manage.py syncdb  
699 - python2.7 manage.py migrate  
700 -  
701 -Start Solr in a terminal, and then, in other terminal, update colab index  
702 -  
703 -.. code-block::  
704 -  
705 - cd /opt/colab/src  
706 - python2.7 manage.py update_index  
707 -  
708 -Now you can close this terminal, and stop solr with ``Ctrl+C``  
709 -  
710 -Import mailman e-mails  
711 -  
712 -.. code-block::  
713 -  
714 - sudo python2.7 /opt/colab/src/manage.py import_emails  
715 -  
716 -*NOTE:*  
717 -  
718 - To run Colab: python2.7 /opt/colab/src/manage.py runserver . To access colab go in: `http://localhost:8000 <http://localhost:8000>`_  
719 \ No newline at end of file 0 \ No newline at end of file
docs/conf.py
View file @ac9ca55
@@ -1,306 +0,0 @@ @@ -1,306 +0,0 @@
1 -# -*- coding: utf-8 -*-  
2 -#  
3 -# Colab Software documentation build configuration file, created by  
4 -# sphinx-quickstart on Mon Oct 14 15:16:49 2013.  
5 -#  
6 -# This file is execfile()d with the current directory set to its containing dir.  
7 -#  
8 -# Note that not all possible configuration values are present in this  
9 -# autogenerated file.  
10 -#  
11 -# All configuration values have a default; values that are commented out  
12 -# serve to show the default.  
13 -  
14 -import sys, os  
15 -  
16 -# If extensions (or modules to document with autodoc) are in another directory,  
17 -# add these directories to sys.path here. If the directory is relative to the  
18 -# documentation root, use os.path.abspath to make it absolute, like shown here.  
19 -#sys.path.insert(0, os.path.abspath('.'))  
20 -  
21 -# -- General configuration -----------------------------------------------------  
22 -  
23 -# If your documentation needs a minimal Sphinx version, state it here.  
24 -#needs_sphinx = '1.0'  
25 -  
26 -# Add any Sphinx extension module names here, as strings. They can be extensions  
27 -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.  
28 -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']  
29 -  
30 -# Add any paths that contain templates here, relative to this directory.  
31 -templates_path = ['_templates']  
32 -  
33 -# The suffix of source filenames.  
34 -source_suffix = '.rst'  
35 -  
36 -# The encoding of source files.  
37 -#source_encoding = 'utf-8-sig'  
38 -  
39 -# The master toctree document.  
40 -master_doc = 'index'  
41 -  
42 -# General information about the project.  
43 -project = u'Colab Software'  
44 -copyright = u'2013, Leonardo J. Caballero G.'  
45 -  
46 -# The version info for the project you're documenting, acts as replacement for  
47 -# |version| and |release|, also used in various other places throughout the  
48 -# built documents.  
49 -#  
50 -# The short X.Y version.  
51 -version = '0.1'  
52 -# The full version, including alpha/beta/rc tags.  
53 -release = '0.1'  
54 -  
55 -# The language for content autogenerated by Sphinx. Refer to documentation  
56 -# for a list of supported languages.  
57 -#language = None  
58 -  
59 -# There are two options for replacing |today|: either, you set today to some  
60 -# non-false value, then it is used:  
61 -#today = ''  
62 -# Else, today_fmt is used as the format for a strftime call.  
63 -#today_fmt = '%B %d, %Y'  
64 -  
65 -# List of patterns, relative to source directory, that match files and  
66 -# directories to ignore when looking for source files.  
67 -exclude_patterns = ['_build']  
68 -  
69 -# The reST default role (used for this markup: `text`) to use for all documents.  
70 -#default_role = None  
71 -  
72 -# If true, '()' will be appended to :func: etc. cross-reference text.  
73 -#add_function_parentheses = True  
74 -  
75 -# If true, the current module name will be prepended to all description  
76 -# unit titles (such as .. function::).  
77 -#add_module_names = True  
78 -  
79 -# If true, sectionauthor and moduleauthor directives will be shown in the  
80 -# output. They are ignored by default.  
81 -#show_authors = False  
82 -  
83 -# The name of the Pygments (syntax highlighting) style to use.  
84 -pygments_style = 'sphinx'  
85 -  
86 -# A list of ignored prefixes for module index sorting.  
87 -#modindex_common_prefix = []  
88 -  
89 -# If true, keep warnings as "system message" paragraphs in the built documents.  
90 -#keep_warnings = False  
91 -  
92 -  
93 -# -- Options for HTML output ---------------------------------------------------  
94 -  
95 -# The theme to use for HTML and HTML Help pages. See the documentation for  
96 -# a list of builtin themes.  
97 -html_theme = 'default'  
98 -  
99 -# Theme options are theme-specific and customize the look and feel of a theme  
100 -# further. For a list of options available for each theme, see the  
101 -# documentation.  
102 -#html_theme_options = {}  
103 -  
104 -# Add any paths that contain custom themes here, relative to this directory.  
105 -#html_theme_path = []  
106 -  
107 -# The name for this set of Sphinx documents. If None, it defaults to  
108 -# "<project> v<release> documentation".  
109 -#html_title = None  
110 -  
111 -# A shorter title for the navigation bar. Default is the same as html_title.  
112 -#html_short_title = None  
113 -  
114 -# The name of an image file (relative to this directory) to place at the top  
115 -# of the sidebar.  
116 -#html_logo = None  
117 -  
118 -# The name of an image file (within the static path) to use as favicon of the  
119 -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32  
120 -# pixels large.  
121 -#html_favicon = None  
122 -  
123 -# Add any paths that contain custom static files (such as style sheets) here,  
124 -# relative to this directory. They are copied after the builtin static files,  
125 -# so a file named "default.css" will overwrite the builtin "default.css".  
126 -html_static_path = ['_static']  
127 -  
128 -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,  
129 -# using the given strftime format.  
130 -#html_last_updated_fmt = '%b %d, %Y'  
131 -  
132 -# If true, SmartyPants will be used to convert quotes and dashes to  
133 -# typographically correct entities.  
134 -#html_use_smartypants = True  
135 -  
136 -# Custom sidebar templates, maps document names to template names.  
137 -#html_sidebars = {}  
138 -  
139 -# Additional templates that should be rendered to pages, maps page names to  
140 -# template names.  
141 -#html_additional_pages = {}  
142 -  
143 -# If false, no module index is generated.  
144 -#html_domain_indices = True  
145 -  
146 -# If false, no index is generated.  
147 -#html_use_index = True  
148 -  
149 -# If true, the index is split into individual pages for each letter.  
150 -#html_split_index = False  
151 -  
152 -# If true, links to the reST sources are added to the pages.  
153 -#html_show_sourcelink = True  
154 -  
155 -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.  
156 -#html_show_sphinx = True  
157 -  
158 -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.  
159 -#html_show_copyright = True  
160 -  
161 -# If true, an OpenSearch description file will be output, and all pages will  
162 -# contain a <link> tag referring to it. The value of this option must be the  
163 -# base URL from which the finished HTML is served.  
164 -#html_use_opensearch = ''  
165 -  
166 -# This is the file name suffix for HTML files (e.g. ".xhtml").  
167 -#html_file_suffix = None  
168 -  
169 -# Output file base name for HTML help builder.  
170 -htmlhelp_basename = 'ColabSoftwareDocumentationdoc'  
171 -  
172 -  
173 -# -- Options for LaTeX output --------------------------------------------------  
174 -  
175 -latex_elements = {  
176 -# The paper size ('letterpaper' or 'a4paper').  
177 -#'papersize': 'letterpaper',  
178 -  
179 -# The font size ('10pt', '11pt' or '12pt').  
180 -#'pointsize': '10pt',  
181 -  
182 -# Additional stuff for the LaTeX preamble.  
183 -#'preamble': '',  
184 -}  
185 -  
186 -# Grouping the document tree into LaTeX files. List of tuples  
187 -# (source start file, target name, title, author, documentclass [howto/manual]).  
188 -latex_documents = [  
189 - ('index', 'ColabSoftwareDocumentation.tex', u'Colab Software',  
190 - u'Leonardo J. Caballero G.', 'manual'),  
191 -]  
192 -  
193 -# The name of an image file (relative to this directory) to place at the top of  
194 -# the title page.  
195 -#latex_logo = None  
196 -  
197 -# For "manual" documents, if this is true, then toplevel headings are parts,  
198 -# not chapters.  
199 -#latex_use_parts = False  
200 -  
201 -# If true, show page references after internal links.  
202 -#latex_show_pagerefs = False  
203 -  
204 -# If true, show URL addresses after external links.  
205 -#latex_show_urls = False  
206 -  
207 -# Documents to append as an appendix to all manuals.  
208 -#latex_appendices = []  
209 -  
210 -# If false, no module index is generated.  
211 -#latex_domain_indices = True  
212 -  
213 -  
214 -# -- Options for manual page output --------------------------------------------  
215 -  
216 -# One entry per manual page. List of tuples  
217 -# (source start file, name, description, authors, manual section).  
218 -man_pages = [  
219 - ('index', 'colabsoftwaredocumentation', u'Colab Software',  
220 - [u'Leonardo J. Caballero G.'], 1)  
221 -]  
222 -  
223 -# If true, show URL addresses after external links.  
224 -#man_show_urls = False  
225 -  
226 -  
227 -# -- Options for Texinfo output ------------------------------------------------  
228 -  
229 -# Grouping the document tree into Texinfo files. List of tuples  
230 -# (source start file, target name, title, author,  
231 -# dir menu entry, description, category)  
232 -texinfo_documents = [  
233 - ('index', 'ColabSoftwareDocumentation', u'Colab Software',  
234 - u'Leonardo J. Caballero G.', 'ColabSoftwareDocumentation', 'One line description of project.',  
235 - 'Miscellaneous'),  
236 -]  
237 -  
238 -# Documents to append as an appendix to all manuals.  
239 -#texinfo_appendices = []  
240 -  
241 -# If false, no module index is generated.  
242 -#texinfo_domain_indices = True  
243 -  
244 -# How to display URL addresses: 'footnote', 'no', or 'inline'.  
245 -#texinfo_show_urls = 'footnote'  
246 -  
247 -# If true, do not generate a @detailmenu in the "Top" node's menu.  
248 -#texinfo_no_detailmenu = False  
249 -  
250 -  
251 -# -- Options for Epub output ---------------------------------------------------  
252 -  
253 -# Bibliographic Dublin Core info.  
254 -epub_title = u'Colab Software Documentation'  
255 -epub_author = u'Leonardo J. Caballero G.'  
256 -epub_publisher = u'Leonardo J. Caballero G.'  
257 -epub_copyright = u'2013, Leonardo J. Caballero G.'  
258 -  
259 -# The language of the text. It defaults to the language option  
260 -# or en if the language is not set.  
261 -#epub_language = ''  
262 -  
263 -# The scheme of the identifier. Typical schemes are ISBN or URL.  
264 -#epub_scheme = ''  
265 -  
266 -# The unique identifier of the text. This can be a ISBN number  
267 -# or the project homepage.  
268 -#epub_identifier = ''  
269 -  
270 -# A unique identification for the text.  
271 -#epub_uid = ''  
272 -  
273 -# A tuple containing the cover image and cover page html template filenames.  
274 -#epub_cover = ()  
275 -  
276 -# A sequence of (type, uri, title) tuples for the guide element of content.opf.  
277 -#epub_guide = ()  
278 -  
279 -# HTML files that should be inserted before the pages created by sphinx.  
280 -# The format is a list of tuples containing the path and title.  
281 -#epub_pre_files = []  
282 -  
283 -# HTML files shat should be inserted after the pages created by sphinx.  
284 -# The format is a list of tuples containing the path and title.  
285 -#epub_post_files = []  
286 -  
287 -# A list of files that should not be packed into the epub file.  
288 -#epub_exclude_files = []  
289 -  
290 -# The depth of the table of contents in toc.ncx.  
291 -#epub_tocdepth = 3  
292 -  
293 -# Allow duplicate toc entries.  
294 -#epub_tocdup = True  
295 -  
296 -# Fix unsupported image types using the PIL.  
297 -#epub_fix_images = False  
298 -  
299 -# Scale large images.  
300 -#epub_max_image_width = 0  
301 -  
302 -# If 'no', URL addresses will not be shown.  
303 -#epub_show_urls = 'inline'  
304 -  
305 -# If false, no index is generated.  
306 -#epub_use_index = True  
docs/index.rst
View file @ac9ca55
@@ -1,25 +0,0 @@ @@ -1,25 +0,0 @@
1 -.. Colab Software documentation master file, created by  
2 - sphinx-quickstart on Mon Oct 14 15:16:49 2013.  
3 - You can adapt this file completely to your liking, but it should at least  
4 - contain the root `toctree` directive.  
5 -  
6 -=================================  
7 -Colab, a Software for Communities  
8 -=================================  
9 -  
10 -Contents:  
11 -  
12 -.. toctree::  
13 - :maxdepth: 2  
14 -  
15 - about  
16 - install  
17 -  
18 -  
19 -Indices and tables  
20 -==================  
21 -  
22 -* :ref:`genindex`  
23 -* :ref:`modindex`  
24 -* :ref:`search`  
25 -  
docs/install.rst
View file @ac9ca55
@@ -1,15 +0,0 @@ @@ -1,15 +0,0 @@
1 -.. -*- coding: utf-8 -*-  
2 -  
3 -.. highlight:: rest  
4 -  
5 -.. _colab_software_install:  
6 -  
7 -Installation  
8 -============  
9 -  
10 -Colab software can be install in many Linux distros, like these:  
11 -  
12 -.. toctree::  
13 - :maxdepth: 1  
14 -  
15 - ubuntu1004  
docs/make.bat
View file @ac9ca55
@@ -1,242 +0,0 @@ @@ -1,242 +0,0 @@
1 -@ECHO OFF  
2 -  
3 -REM Command file for Sphinx documentation  
4 -  
5 -if "%SPHINXBUILD%" == "" (  
6 - set SPHINXBUILD=sphinx-build  
7 -)  
8 -set BUILDDIR=_build  
9 -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .  
10 -set I18NSPHINXOPTS=%SPHINXOPTS% .  
11 -if NOT "%PAPER%" == "" (  
12 - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%  
13 - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%  
14 -)  
15 -  
16 -if "%1" == "" goto help  
17 -  
18 -if "%1" == "help" (  
19 - :help  
20 - echo.Please use `make ^<target^>` where ^<target^> is one of  
21 - echo. html to make standalone HTML files  
22 - echo. dirhtml to make HTML files named index.html in directories  
23 - echo. singlehtml to make a single large HTML file  
24 - echo. pickle to make pickle files  
25 - echo. json to make JSON files  
26 - echo. htmlhelp to make HTML files and a HTML help project  
27 - echo. qthelp to make HTML files and a qthelp project  
28 - echo. devhelp to make HTML files and a Devhelp project  
29 - echo. epub to make an epub  
30 - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter  
31 - echo. text to make text files  
32 - echo. man to make manual pages  
33 - echo. texinfo to make Texinfo files  
34 - echo. gettext to make PO message catalogs  
35 - echo. changes to make an overview over all changed/added/deprecated items  
36 - echo. xml to make Docutils-native XML files  
37 - echo. pseudoxml to make pseudoxml-XML files for display purposes  
38 - echo. linkcheck to check all external links for integrity  
39 - echo. doctest to run all doctests embedded in the documentation if enabled  
40 - goto end  
41 -)  
42 -  
43 -if "%1" == "clean" (  
44 - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i  
45 - del /q /s %BUILDDIR%\*  
46 - goto end  
47 -)  
48 -  
49 -  
50 -%SPHINXBUILD% 2> nul  
51 -if errorlevel 9009 (  
52 - echo.  
53 - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx  
54 - echo.installed, then set the SPHINXBUILD environment variable to point  
55 - echo.to the full path of the 'sphinx-build' executable. Alternatively you  
56 - echo.may add the Sphinx directory to PATH.  
57 - echo.  
58 - echo.If you don't have Sphinx installed, grab it from  
59 - echo.http://sphinx-doc.org/  
60 - exit /b 1  
61 -)  
62 -  
63 -if "%1" == "html" (  
64 - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html  
65 - if errorlevel 1 exit /b 1  
66 - echo.  
67 - echo.Build finished. The HTML pages are in %BUILDDIR%/html.  
68 - goto end  
69 -)  
70 -  
71 -if "%1" == "dirhtml" (  
72 - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml  
73 - if errorlevel 1 exit /b 1  
74 - echo.  
75 - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.  
76 - goto end  
77 -)  
78 -  
79 -if "%1" == "singlehtml" (  
80 - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml  
81 - if errorlevel 1 exit /b 1  
82 - echo.  
83 - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.  
84 - goto end  
85 -)  
86 -  
87 -if "%1" == "pickle" (  
88 - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle  
89 - if errorlevel 1 exit /b 1  
90 - echo.  
91 - echo.Build finished; now you can process the pickle files.  
92 - goto end  
93 -)  
94 -  
95 -if "%1" == "json" (  
96 - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json  
97 - if errorlevel 1 exit /b 1  
98 - echo.  
99 - echo.Build finished; now you can process the JSON files.  
100 - goto end  
101 -)  
102 -  
103 -if "%1" == "htmlhelp" (  
104 - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp  
105 - if errorlevel 1 exit /b 1  
106 - echo.  
107 - echo.Build finished; now you can run HTML Help Workshop with the ^  
108 -.hhp project file in %BUILDDIR%/htmlhelp.  
109 - goto end  
110 -)  
111 -  
112 -if "%1" == "qthelp" (  
113 - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp  
114 - if errorlevel 1 exit /b 1  
115 - echo.  
116 - echo.Build finished; now you can run "qcollectiongenerator" with the ^  
117 -.qhcp project file in %BUILDDIR%/qthelp, like this:  
118 - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ColabSoftwareDocumentation.qhcp  
119 - echo.To view the help file:  
120 - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ColabSoftwareDocumentation.ghc  
121 - goto end  
122 -)  
123 -  
124 -if "%1" == "devhelp" (  
125 - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp  
126 - if errorlevel 1 exit /b 1  
127 - echo.  
128 - echo.Build finished.  
129 - goto end  
130 -)  
131 -  
132 -if "%1" == "epub" (  
133 - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub  
134 - if errorlevel 1 exit /b 1  
135 - echo.  
136 - echo.Build finished. The epub file is in %BUILDDIR%/epub.  
137 - goto end  
138 -)  
139 -  
140 -if "%1" == "latex" (  
141 - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex  
142 - if errorlevel 1 exit /b 1  
143 - echo.  
144 - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.  
145 - goto end  
146 -)  
147 -  
148 -if "%1" == "latexpdf" (  
149 - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex  
150 - cd %BUILDDIR%/latex  
151 - make all-pdf  
152 - cd %BUILDDIR%/..  
153 - echo.  
154 - echo.Build finished; the PDF files are in %BUILDDIR%/latex.  
155 - goto end  
156 -)  
157 -  
158 -if "%1" == "latexpdfja" (  
159 - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex  
160 - cd %BUILDDIR%/latex  
161 - make all-pdf-ja  
162 - cd %BUILDDIR%/..  
163 - echo.  
164 - echo.Build finished; the PDF files are in %BUILDDIR%/latex.  
165 - goto end  
166 -)  
167 -  
168 -if "%1" == "text" (  
169 - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text  
170 - if errorlevel 1 exit /b 1  
171 - echo.  
172 - echo.Build finished. The text files are in %BUILDDIR%/text.  
173 - goto end  
174 -)  
175 -  
176 -if "%1" == "man" (  
177 - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man  
178 - if errorlevel 1 exit /b 1  
179 - echo.  
180 - echo.Build finished. The manual pages are in %BUILDDIR%/man.  
181 - goto end  
182 -)  
183 -  
184 -if "%1" == "texinfo" (  
185 - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo  
186 - if errorlevel 1 exit /b 1  
187 - echo.  
188 - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.  
189 - goto end  
190 -)  
191 -  
192 -if "%1" == "gettext" (  
193 - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale  
194 - if errorlevel 1 exit /b 1  
195 - echo.  
196 - echo.Build finished. The message catalogs are in %BUILDDIR%/locale.  
197 - goto end  
198 -)  
199 -  
200 -if "%1" == "changes" (  
201 - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes  
202 - if errorlevel 1 exit /b 1  
203 - echo.  
204 - echo.The overview file is in %BUILDDIR%/changes.  
205 - goto end  
206 -)  
207 -  
208 -if "%1" == "linkcheck" (  
209 - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck  
210 - if errorlevel 1 exit /b 1  
211 - echo.  
212 - echo.Link check complete; look for any errors in the above output ^  
213 -or in %BUILDDIR%/linkcheck/output.txt.  
214 - goto end  
215 -)  
216 -  
217 -if "%1" == "doctest" (  
218 - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest  
219 - if errorlevel 1 exit /b 1  
220 - echo.  
221 - echo.Testing of doctests in the sources finished, look at the ^  
222 -results in %BUILDDIR%/doctest/output.txt.  
223 - goto end  
224 -)  
225 -  
226 -if "%1" == "xml" (  
227 - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml  
228 - if errorlevel 1 exit /b 1  
229 - echo.  
230 - echo.Build finished. The XML files are in %BUILDDIR%/xml.  
231 - goto end  
232 -)  
233 -  
234 -if "%1" == "pseudoxml" (  
235 - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml  
236 - if errorlevel 1 exit /b 1  
237 - echo.  
238 - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.  
239 - goto end  
240 -)  
241 -  
242 -:end  
docs/ubuntu1004.rst
View file @ac9ca55
@@ -1,174 +0,0 @@ @@ -1,174 +0,0 @@
1 -.. -*- coding: utf-8 -*-  
2 -  
3 -.. highlight:: rest  
4 -  
5 -.. _ubuntu1004_install:  
6 -  
7 -Installation instructions for Ubuntu 10.04  
8 -==========================================  
9 -  
10 -.. contents :: :local:  
11 -  
12 -Install Solr and dependencies  
13 ------------------------------  
14 -  
15 -* Install Java, tomcat, JDBC Postgres drivers (Ubuntu partner repositories must be enabled): ::  
16 -  
17 - sudo apt-get install sun-java6-bin tomcat6 libpg-java  
18 -  
19 -* Download Solr 3.3 and extract it: ::  
20 -  
21 - wget http://archive.apache.org/dist/lucene/solr/3.3.0/apache-solr-3.3.0.tgz  
22 - tar xzf apache-solr-3.3.0.tgz  
23 -  
24 -* Create the directory ``/var/local/lib/solr/`` and give the right permissions: ::  
25 -  
26 - sudo mkdir -p /var/local/lib/solr/  
27 - sudo chown tomcat6:tomcat6 /var/local/lib/solr/  
28 -  
29 -* Copy the solr home example to ``/usr/local/share/``: ::  
30 -  
31 - sudo cp -R apache-solr-3.3.0/example/solr /usr/local/share/  
32 -  
33 -* Create a folder for libs in the solr home: ::  
34 -  
35 - sudo mkdir /usr/local/share/solr/lib/  
36 -  
37 -* Copy Solr libs to libs folder: ::  
38 -  
39 - sudo cp apache-solr-3.3.0/dist/*.jar /usr/local/share/solr/lib/  
40 -  
41 -* Copy Solr distribution to solr home: ::  
42 -  
43 - sudo cp apache-solr-3.3.0/dist/apache-solr-3.3.0.war /usr/local/share/solr/  
44 -  
45 -* Link the JDBC Postgres drivers into the Solr installation: ::  
46 -  
47 - sudo ln -s /usr/share/java/postgresql-jdbc3-8.4.jar /usr/local/share/solr/lib/  
48 -  
49 -* Link configurations to ``/etc`` ::  
50 -  
51 - sudo ln -s /usr/local/share/solr/conf/ /etc/solr  
52 -  
53 -* Copy the configuration files from this folder into ``/etc/solr/``  
54 -  
55 -* Link the ``solr-tomcat.xml`` file in the Tomcat configuration: ::  
56 -  
57 - sudo ln -s /etc/solr/solr-tomcat.xml /etc/tomcat6/Catalina/localhost/solr.xml  
58 -  
59 -* Check ``data-config.xml`` to make sure all information to connect to the databases are right  
60 -  
61 -* Create a ``dataimport.properties`` on ``/etc/solr`` and give write access to ``tomcat6``: ::  
62 -  
63 - sudo touch /etc/solr/dataimport.properties  
64 - sudo chown tomcat6:tomcat6 /etc/solr/dataimport.properties  
65 -  
66 -* Restart tomcat: ::  
67 -  
68 - sudo /etc/init.d/tomcat6 restart  
69 -  
70 -Install Colab and dependencies  
71 -------------------------------  
72 -  
73 -* Install Apache2 with WSGI support: ::  
74 -  
75 - sudo apt-get install apache2 libapache2-mod-wsgi  
76 -  
77 -* Install dependencies to compile psycopg2: ::  
78 -  
79 - sudo apt-get build-dep python-psycopg2  
80 -  
81 -* Install Python PIP and update it: ::  
82 -  
83 - sudo apt-get install python-pip  
84 - sudo pip install -U pip  
85 -  
86 -* Install python virtualenv: ::  
87 -  
88 - sudo pip install virtualenv  
89 -  
90 -* Create a virtualenv for the deploy ::  
91 -  
92 - sudo mkdir /usr/local/django/  
93 - sudo virtualenv /usr/local/django/colab/  
94 -  
95 -* Download the colab ``src`` code: ::  
96 -  
97 - sudo hg clone https://bitbucket.org/seocam/atu-colab /usr/local/src/colab/  
98 -  
99 -* Install the django site: ::  
100 -  
101 - sudo pip install /usr/local/src/colab -E /usr/local/django/colab/  
102 -  
103 -* Configure your database settings in ``/usr/local/django/colab/lib/python2.6/site-packages/settings_local.py``  
104 -  
105 -* Enable the colab site on apache and reload it: ::  
106 -  
107 - sudo ln -s /usr/local/django/colab/apache-site/colab /etc/apache2/sites-available  
108 - sudo a2ensite colab  
109 - sudo service apache2 restart  
110 -  
111 -Configuring server to send emails  
112 -----------------------------------  
113 -  
114 -* Install postfix and mailutils: ::  
115 -  
116 - sudo apt-get install mailutils postfix  
117 -  
118 -* Update the file ``/etc/aliases`` adding users that should receive root's messages and run the update command: ::  
119 -  
120 - sudo newaliases  
121 -  
122 -  
123 -Cron job to import emails  
124 ----------------------------  
125 -  
126 -* Install sshfs: ::  
127 -  
128 - sudo apt-get install sshfs autofs  
129 -  
130 -* Create SSH keys. You should use a password but this tutorial won't cover it (if you use you will need to install and configure keychain process to be able to proceed): ::  
131 -  
132 - sudo ssh-keygen  
133 -  
134 -* Copy the content of your key (``/root/.ssh/id_rsa.pub``) to the file ``/root/.ssh/authorized_keys`` on the mailinglist server.  
135 -  
136 -* Append the following content to /etc/auto.master file: ::  
137 -  
138 - sudo /usr/local/django/colab/mnt /usr/local/django/colab/autofs/listas --timeout=600,--ghost  
139 -  
140 -* Restart autofs: ::  
141 -  
142 - service autofs restart  
143 -  
144 -* Link cron script into ``/etc/cron.d/`` folder: ::  
145 -  
146 - ln -s /usr/local/django/colab/etc/cron.d/colab_import_emails /etc/cron.d/  
147 -  
148 -* From now on the emails should be imported every minute  
149 -  
150 -  
151 -Cron job to reindex Solr  
152 --------------------------  
153 -  
154 -* Install wget: ::  
155 -  
156 - sudo apt-get install wget  
157 -  
158 -* Link cron script into ``/etc/cron.d/`` folder: ::  
159 -  
160 - sudo ln -s /usr/local/django/colab/etc/cron.d/colab_solr_reindex /etc/cron.d/  
161 -  
162 -* From now on delta reindex should run every 10 minutes and full reindex once a day.  
163 -  
164 -  
165 -Updating an installed version  
166 -------------------------------  
167 -  
168 -* Update the source code: ::  
169 -  
170 - sudo cd /usr/local/src/colab/  
171 - sudo hg pull  
172 - sudo hg up  
173 - sudo pip install /usr/local/src/colab/ -E /usr/local/django/colab/ -U  
174 - sudo service apache2 restart