Commit 1d9ed4d3c044315862f149edc2b7184f80b13375

Authored by Leonardo J. Caballero G
1 parent 11fc822f

Updated with Sphinx format

Showing 1 changed file with 57 additions and 58 deletions   Show diff stats
README.rst
... ... @@ -46,81 +46,80 @@ Installation
46 46 Installation instructions for Ubuntu 10.04
47 47 -------------------------------------------
48 48  
49   -* Install Apache2 with WSGI support:
  49 +* Install Apache2 with WSGI support: ::
50 50  
51   - * apt-get install apache2 libapache2-mod-wsgi
  51 + sudo apt-get install apache2 libapache2-mod-wsgi
52 52  
53   -* Install dependencies to compile psycopg2:
  53 +* Install dependencies to compile psycopg2: ::
54 54  
55   - * apt-get build-dep python-psycopg2
  55 + sudo apt-get build-dep python-psycopg2
56 56  
57   -* Install Python PIP and update it:
58   -
59   - * apt-get install python-pip
60   - * pip install -U pip
  57 +* Install Python PIP and update it: ::
61 58  
62   -* Install python virtualenv:
63   -
64   - * pip install virtualenv
  59 + sudo apt-get install python-pip
  60 + sudo pip install -U pip
  61 +
  62 +* Install python virtualenv: ::
65 63  
66   -* Create a virtualenv for the deploy
  64 + sudo pip install virtualenv
  65 +
  66 +* Create a virtualenv for the deploy ::
67 67  
68   - * mkdir /usr/local/django/
69   - * virtualenv /usr/local/django/colab/
  68 + sudo mkdir /usr/local/django/
  69 + sudo virtualenv /usr/local/django/colab/
70 70  
71   -* Download the colab src code:
  71 +* Download the colab ``src`` code: ::
72 72  
73   - * hg clone https://bitbucket.org/seocam/atu-colab /usr/local/src/colab/
  73 + sudo hg clone https://bitbucket.org/seocam/atu-colab /usr/local/src/colab/
74 74  
75   -* Install the django site:
  75 +* Install the django site: ::
76 76  
77   - * pip install /usr/local/src/colab -E /usr/local/django/colab/
  77 + sudo pip install /usr/local/src/colab -E /usr/local/django/colab/
78 78  
79   -* Configure your database settings in /usr/local/django/colab/lib/python2.6/site-packages/settings_local.py
  79 +* Configure your database settings in ``/usr/local/django/colab/lib/python2.6/site-packages/settings_local.py``
80 80  
81   -* Enable the colab site on apache and reload it:
  81 +* Enable the colab site on apache and reload it: ::
82 82  
83   - * ln -s /usr/local/django/colab/apache-site/colab /etc/apache2/sites-available
84   - * a2ensite colab
85   - * service apache2 restart
86   -
  83 + sudo ln -s /usr/local/django/colab/apache-site/colab /etc/apache2/sites-available
  84 + sudo a2ensite colab
  85 + sudo service apache2 restart
87 86  
88 87 Configuring server to send emails
89 88 ----------------------------------
90 89  
91   -* Install postfix and mailutils:
92   -
93   - * apt-get install mailutils postfix
  90 +* Install postfix and mailutils: ::
94 91  
95   -* Update the file /etc/aliases adding users that should receive root's messages and run the update command:
  92 + sudo apt-get install mailutils postfix
96 93  
97   - * newaliases
  94 +* Update the file ``/etc/aliases`` adding users that should receive root's messages and run the update command: ::
  95 +
  96 + sudo newaliases
98 97  
99 98  
100 99 Cron job to import emails
101 100 ---------------------------
102 101  
103   -* Install sshfs:
104   -
105   - * apt-get install sshfs autofs
106   -
107   -* 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):
  102 +* Install sshfs: ::
108 103  
109   - * ssh-keygen
110   -
111   -* Copy the content of your key (/root/.ssh/id_rsa.pub) to the file /root/.ssh/authorized_keys on the mailinglist server.
  104 + sudo apt-get install sshfs autofs
  105 +
  106 +* 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): ::
  107 +
  108 + sudo ssh-keygen
112 109  
113   -* Append the following content to /etc/auto.master file:
  110 +* Copy the content of your key (``/root/.ssh/id_rsa.pub``) to the file ``/root/.ssh/authorized_keys`` on the mailinglist server.
114 111  
115   - * /usr/local/django/colab/mnt /usr/local/django/colab/autofs/listas --timeout=600,--ghost
  112 +* Append the following content to /etc/auto.master file: ::
116 113  
117   -* Restart autofs:
  114 + sudo /usr/local/django/colab/mnt /usr/local/django/colab/autofs/listas --timeout=600,--ghost
118 115  
119   - * service autofs restart
  116 +* Restart autofs: ::
  117 +
  118 + service autofs restart
120 119  
121   -* Link cron script into /etc/cron.d/ folder:
  120 +* Link cron script into ``/etc/cron.d/`` folder: ::
122 121  
123   - * ln -s /usr/local/django/colab/etc/cron.d/colab_import_emails /etc/cron.d/
  122 + ln -s /usr/local/django/colab/etc/cron.d/colab_import_emails /etc/cron.d/
124 123  
125 124 * From now on the emails should be imported every minute
126 125  
... ... @@ -128,24 +127,24 @@ Cron job to import emails
128 127 Cron job to reindex Solr
129 128 -------------------------
130 129  
131   -* Install wget:
132   -
133   - * apt-get install wget
134   -
135   -* Link cron script into /etc/cron.d/ folder:
136   -
137   - * ln -s /usr/local/django/colab/etc/cron.d/colab_solr_reindex /etc/cron.d/
138   -
  130 +* Install wget: ::
  131 +
  132 + sudo apt-get install wget
  133 +
  134 +* Link cron script into ``/etc/cron.d/`` folder: ::
  135 +
  136 + sudo ln -s /usr/local/django/colab/etc/cron.d/colab_solr_reindex /etc/cron.d/
  137 +
139 138 * From now on delta reindex should run every 10 minutes and full reindex once a day.
140 139  
141 140  
142 141 Updating an installed version
143 142 ------------------------------
144 143  
145   -* Update the source code:
146   -
147   - * cd /usr/local/src/colab/
148   - * hg pull
149   - * hg up
150   - * pip install /usr/local/src/colab/ -E /usr/local/django/colab/ -U
151   - * service apache2 restart
  144 +* Update the source code: ::
  145 +
  146 + sudo cd /usr/local/src/colab/
  147 + sudo hg pull
  148 + sudo hg up
  149 + sudo pip install /usr/local/src/colab/ -E /usr/local/django/colab/ -U
  150 + sudo service apache2 restart
... ...