diff options
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 102 |
1 files changed, 54 insertions, 48 deletions
diff --git a/docs/install.rst b/docs/install.rst index d00a1bc..427e163 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -49,7 +49,7 @@ Optionaly (but recommanded): - `tinymce <http://tinymce.moxiecode.com/>`_ - `gpsbabel <http://www.gpsbabel.org/>`_ - - django-celery if you want to manage import + - django-celery if you want to manage large imports The simpliest way to obtain these packages is to get them from your favorite @@ -59,7 +59,7 @@ Linux distribution repositories. For instance on Debian Wheezy:: 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 python-gdal + python-django-celery python-simplejson python-gdal gpsbabel If these packages do not exist in your distribution's repository, please refer to the applications' websites. @@ -92,12 +92,24 @@ From an archive +++++++++++++++ The last "stable" version is available in this `directory <http://www.peacefrogs.net/download/chimere/>`_. +Take care of getting the last version in the desired X.Y branch (for instance +the last version for the 1.0 branch is version 1.0.2. +Extract it to the desired destination path:: + + wget http://www.peacefrogs.net/download/chimere -q -O -| html2text + (...) + [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.1.tar.bz2 17-Nov-2010 16:51 53K + [[ ]] chimere-1.0.2.tar.bz2 17-Nov-2010 16:51 53K + (...) + + wget http://www.peacefrogs.net/download/chimere/chimere-1.0.2.tar.bz2 Download, unpack and move the files in an apache user (www-data for Debian) readable directory:: cd $INSTALL_PATH - sudo tar xvjf /home/etienne/chimere-last.tar.bz2 + sudo tar xvjf chimere-last.tar.bz2 sudo chown -R myusername:www-data chimere From the git repository @@ -112,14 +124,20 @@ Another solution is to get the last git version:: git checkout v2.0 # checkout the desired version -Base configuration -****************** +Create a custom project template +******************************** There a default project provided "example_project". Copy and modify it (or get another project based on Chimere):: cd $INSTALL_PATH/chimere - cp -r example_project mychimere_project + cp -ra example_project mychimere_project + +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. In your chimere application directory create local_settings.py to fit to your configuration. @@ -147,9 +165,6 @@ settings are initialized in settings.py. :: for a Debian installation with Jquery and Jquery-ui activated) * GPSBABEL: path to gpsbabel (default is appropriate for a Debian installation with gpsbabel installed) - * CHIMERE_DEFAULT_ZOOM: default zoom on map - * CHIMERE_DEFAULT_CENTER: center of the map - * CHIMERE_DISPLAY_AREAS: display area's shortcuts * TIME_ZONE: local time zone for this installation * LANGUAGE_CODE: language code for this installation @@ -171,31 +186,26 @@ Regroup static files in one path:: cd $INSTALL_PATH/chimere/mychimere_project ./manage.py collectstatic -Removing celery configuration -+++++++++++++++++++++++++++++ - -TODO - 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/mychimere_project - ./manage.py compilemessages -l fr + cd $INSTALL_PATH/chimere/chimere/ + django-admin compilemessages If your language is not available, feel free to create the default po files 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" according -to the language you choose to create):: +You first need to create the default po file (of course, replace **fr** +according to the language you choose to create):: - ./manage.py makemessages -l fr + django-admin makemessages -l fr -There should now be a django.po file in locale/fr/LC_MESSAGES. Complete it with -your translation. +There should now be a *django.po* file in *locale/fr/LC_MESSAGES*. Complete it +with your translation. Now that the translation file is completed, just compile it the same way you would have if the language file was already available. @@ -230,13 +240,15 @@ Install mod_wsgi for apache:: TODO: adapt apache-wsgi.conf Create and edit a configuration for Chimère:: - sudo vim $INSTALL_PATH/chimere/apache/django.wsgi - sudo vim $INSTALL_PATH/chimere/apache/apache-wsgi.conf + sudo cp $INSTALL_PATH/chimere/apache/django.wsgi \ + $INSTALL_PATH/chimere/apache/mydjango.wsgi + sudo vim $INSTALL_PATH/chimere/apache/mydjango.wsgi sudo cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf /etc/apache2/sites-available/chimere + sudo vim /etc/apache2/sites-available/chimere # create log dir sudo mkdir /var/log/apache2/chimere/ -Adapt the files django.wsgi (with the correct sys path) and chimere. +Adapt the files *mydjango.wsgi* (with the correct sys path) and *chimere*. To activate the website reload apache:: @@ -252,6 +264,13 @@ When you have installed the application there is a few simple steps to follow to Most of theses steps are done in the administration pages accessible at : http://where_is_chimere/admin To access theses pages you have to identify you with login and password provided at the initialization of the database. +Creating areas +-------------- + +You probably want to define at least one default area. The configuration of +this area allow you to define the default zoom, welcome message, etc. of your +Chimère. + Creating users -------------- @@ -288,28 +307,21 @@ Detail of rights for default user/groups: | Route add/modify/delete | yes | yes | yes | +-----------------------------------------+-------------------+---------------------------+-----------+ -Setting the welcome page ------------------------- - -The message has to be set by updating the file templates/welcome.html. -You only have to change the message at the begin of #detail_content. Creating property models ------------------------ -A basic installation of Chimère only permit to associate a name, a category and (for the point of interest) a picture for each point of interest and each route. You may want to add more fields like phone number or opening hours. For that all you have to do is to add a new property model. -The administration ask you for name, order (to order between other properties), availability for the user and type (only text field and long text field are available for the moment). -Then to make this property available it is necessary to restart your application (and then probably to reload Apache). -All forms are then automaticaly updated with this new field. - -Updating the detail window --------------------------- +A basic installation of Chimère only permit to associate a name, a category, a +description and (for the point of interest) multimedia files for each point of +interest and each route. You may want to add more fields like phone number or +opening hours. For that all you have to do is to add a new property model. +The administration ask you for name, order (to order between other properties), +availability for the user and type (only text field and long text field are +available for the moment). +Then to make this property available it is necessary to restart your +application (and then probably to reload Apache). +All forms are then automatically updated with this new field. -When clicking on a POI a window appear with the details. -Particulary if you have set some new property models you may want to customize this window. -Each property is in a paragraph with id: property_i_j (i is the order and j is the model property id - the first model property is id 1 then 2...). -You can simply adapt the CSS file (static/styles.css) to match the desired presentation. -If you want to really change the whole presentation you can change the template file templates/detail.html (go to the Django template documentation for details). Updating the design ------------------- @@ -347,12 +359,6 @@ Theses fields are mainly quite self-explainatory. The color is used to draw routes (if this subcategory contains routes). If it a basic color it can be set with the english name (for instance: "red", "blue", "yellow" or "purple") otherwise you can put the HTML RVB code (for instance "#9227c9"). The element type is the type of element the subcategory can contain: POI, route or both. -Creating areas --------------- - -Areas are useful to provide a quick access to a particular town, a district, etc. -To define an area fill a name and move/zoom to the choosed location. Submit it and that's all. - ---------- Moderation ---------- |