summaryrefslogtreecommitdiff
path: root/docs/install.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/install.rst')
-rw-r--r--docs/install.rst54
1 files changed, 28 insertions, 26 deletions
diff --git a/docs/install.rst b/docs/install.rst
index 10c333e..f05e5f0 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -8,8 +8,8 @@ Installation
:date: 2012-10-08
:Copyright: CC-BY 3.0
-This documents presents the installation of Chimère.
-The version has been updated for version 2.0.0.
+This document presents the installation of Chimère.
+It has been updated for version 2.0.0.
Prerequisites
*************
@@ -26,7 +26,7 @@ Prerequisites
- `Beautiful Soup <http://www.crummy.com/software/BeautifulSoup/>`_
- python-simplejson
- python-gdal
- - `unidecode <http://pypi.python.org/pypi/Unidecode>_
+ - `unidecode <http://pypi.python.org/pypi/Unidecode>`_
- `lxml <http://lxml.de/>`_
- `jquery <http://jquery.com/>`_ version 1.7.1 or better
- `jquery-ui <http://jqueryui.com/>`_
@@ -37,7 +37,7 @@ geodjango is a part of django since version 1.0 but it has some specific
- `geos <http://trac.osgeo.org/geos/>`_ 3.0.x
- `proj.4 <http://trac.osgeo.org/proj/>`_ 4.4 to 4.6
- - `posgis <http://postgis.refractions.net/>`_ versions 1.2.1 or 1.3.x
+ - `postgis <http://postgis.refractions.net/>`_ versions 1.2.1 or 1.3.x
- `gdal <http://www.gdal.org/>`_
@@ -51,22 +51,24 @@ Optionaly (but recommanded):
The simpliest way to obtain these packages is to get them from your favorite
Linux distribution repositories. For instance on Debian Wheezy::
- apt-get install python python-django python-django-south \
- python-beautifulsoup tinymce apache2 libgeos-3.3.3 proj-bin gdal-bin \
- python-gdal python-lxml python-psycopg2 python-imaging gettext \
- postgresql-9.1 postgresql-9.1-postgis libjs-jquery libjs-jquery-ui \
- python-django-celery python-simplejson gpsbabel \
- python-pyexiv2 python-feedparser javascript-common
+ apt-get install apache2 python python-django python-django-south \
+ postgresql-9.1 gettext python-psycopg2 python-imaging \
+ python-pyexiv2 python-beautifulsoup python-simplejson python-gdal \
+ javascript-common python-lxml libjs-jquery libjs-jquery-ui \
+ python-feedparser libgeos-3.3.3 proj-bin postgresql-9.1-postgis \
+ gdal-bin tinymce gpsbabel python-django-celery \
+
On Debian Squeeze (you need to activate backports)::
apt-get install -t squeeze-backports python-django libjs-jquery
- apt-get install python python-django-south python-beautifulsoup tinymce \
- apache2 libgeos-3.2.0 proj-bin gdal-bin python-gdal python-lxml \
- python-psycopg2 python-imaging gettext postgresql-8.4 \
- postgresql-8.4-postgis libjs-jquery libjs-jquery-ui python-simplejson \
- gpsbabel python-pyexiv2 python-feedparser javascript-common
+ apt-get install apache2 python python-django python-django-south \
+ postgresql-8.4 gettext python-psycopg2 python-imaging \
+ python-pyexiv2 python-beautifulsoup python-simplejson python-gdal \
+ javascript-common python-lxml libjs-jquery libjs-jquery-ui \
+ python-feedparser libgeos-3.2.0 proj-bin postgresql-8.4-postgis \
+ gdal-bin tinymce gpsbabel \
If these packages do not exist in your distribution's repository, please refer
@@ -137,7 +139,7 @@ Another solution is to get the last git version::
Create a custom project template
********************************
-There a default project provided "example_project". Copy and modify it (or
+There a default project is provided (example_project). Copy and modify it (or
get another project based on Chimere)::
cd $INSTALL_PATH/chimere
@@ -146,13 +148,13 @@ get another project based on Chimere)::
Your project name is used for the name of the Python package of your template.
As a Python package it should follow the rule of Python variable name:
it must be at least one letter and can have a string of numbers, letters and
-"_" to any length. Don't begin the name by "_" because it has special
-significance in Python.
+underscores ("_") to any length. Don't begin the name by "_" because it has
+special significance in Python.
In your chimere application directory create local_settings.py to fit to your
configuration.
A base template is provided (local_settings.py.example) and short descriptions of
-the more relevant fields are given below (at least check them). Most of theses
+the more relevant fields are given below (at least check them). Most of these
settings are initialized in settings.py. ::
cd $INSTALL_PATH/chimere/mychimere_project
@@ -202,13 +204,13 @@ Compiling languages
*******************
If your language is available in the locale directory of chimere, you will just
-need to get it compiled. This can be done with (here, **fr** stands for french).
+need to get it compiled. This can be done with (here, **fr** stands for french.
Replace it with the appropriate language code)::
cd $INSTALL_PATH/chimere/chimere/
django-admin compilemessages
-If your language is not available, feel free to create the default po files and
+If your language is not available, feel free to create the default po file and
to submit it, contributions are well appreciated. Procedure is as follows:
You first need to create the default po file (of course, replace **fr**
@@ -255,10 +257,10 @@ Install mod_wsgi for apache::
TODO: adapt apache-wsgi.conf
+
Create and edit a configuration for Chimère::
- cp $INSTALL_PATH/chimere/apache/django.wsgi \
- $INSTALL_PATH/chimere/apache/mydjango.wsgi
+ cp $INSTALL_PATH/chimere/apache/django.wsgi $INSTALL_PATH/chimere/apache/mydjango.wsgi
vim $INSTALL_PATH/chimere/apache/mydjango.wsgi
cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf /etc/apache2/sites-available/chimere
vim /etc/apache2/sites-available/chimere
@@ -267,14 +269,14 @@ Create and edit a configuration for Chimère::
Adapt the files *mydjango.wsgi* (with the correct sys path) and Apache *chimere*.
-To activate the website reload apache::
+To activate the website, reload apache::
a2ensite chimere
/etc/init.d/apache2 reload
If you encounter problem with the upload of files with Unicode chars in their
-names activate the appropriate locale in Apache. On a Debian server with UTF-8
-as default encoding in the file */etc/apache2/envvars* uncomment the following
+names, activate the appropriate locale in Apache. On a Debian server with UTF-8
+as default encoding in the file */etc/apache2/envvars*, uncomment the following
line::
. /etc/default/locale