diff options
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 157 |
1 files changed, 22 insertions, 135 deletions
diff --git a/docs/install.rst b/docs/install.rst index e1cb458..9af5558 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,22 +1,15 @@ .. -*- coding: utf-8 -*- -==================== -Chimère installation -==================== +============ +Installation +============ :Author: Étienne Loks -:date: 2012-08-03 +:date: 2012-10-08 :Copyright: CC-BY 3.0 This documents presents the installation of Chimère. -The version has been updated for installation of version 2.0-RC4. - ------------------ -Base installation ------------------ - -Installation ------------- +The version has been updated for version 2.0.0. Prerequisites ************* @@ -37,6 +30,7 @@ Prerequisites - `lxml <http://lxml.de/>`_ - `jquery <http://jquery.com/>`_ version 1.7.1 or better - `jquery-ui <http://jqueryui.com/>`_ + - `Universal Feed Parser <https://code.google.com/p/feedparser/>`_ geodjango is a part of django since version 1.0 but it has some specific (geographically related) additional dependencies: @@ -61,18 +55,18 @@ 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 gpsbabel \ - python-pyexiv2 + python-django-celery python-simplejson gpsbabel \ + python-pyexiv2 python-feedparser javascript-common On Debian Squeeze (you need to activate backports):: - apt-get install -t squeeze-backports python-django + 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 \ - python-gdal gpsbabel python-pyexiv2 + gpsbabel python-pyexiv2 python-feedparser javascript-common If these packages do not exist in your distribution's repository, please refer @@ -169,17 +163,20 @@ settings are initialized in settings.py. :: * DATABASES: parameters for the database * PROJECT_NAME: name of the project + * SECRET_KEY: a secret key for a particular Django installation. This is + used to provide cryptographic signing, and should be set to a unique, + unpredictable value. Change it! * ROOT_URLCONF: url configuration for your project something like: 'mychimere_project.urls' * EMAIL_HOST: smtp of an email server to send emails - * TINYMCE_URL: url to tinymce path (default is appropriate - for a Debian installation with tinymce activated) + * TINYMCE_URL: url to tinymce path (default is appropriate for a Debian + installation with tinymce activated) * JQUERY_JS_URLS: list of Jquery and Jquery-ui urls (default is appropriate for a Debian installation with Jquery and Jquery-ui activated) * JQUERY_CSS_URLS: list of Jquery and Jquery-ui urls (default is appropriate for a Debian installation with Jquery and Jquery-ui activated) - * GPSBABEL: path to gpsbabel (default is appropriate - for a Debian installation with gpsbabel installed) + * GPSBABEL: path to gpsbabel (default is appropriate for a Debian + installation with gpsbabel installed) * TIME_ZONE: local time zone for this installation * LANGUAGE_CODE: language code for this installation @@ -241,6 +238,11 @@ to create tables managed with south:: The database is set, congratulations! +If you want to populate your installation with default data (don't do this on +an already populated instance!):: + + ./manage.py loaddata ../chimere/fixtures/default_data.json + Webserver configuration *********************** @@ -270,118 +272,3 @@ To activate the website reload apache:: a2ensite chimere /etc/init.d/apache2 reload ------------------- -Base configuration ------------------- - -When you have installed the application there is a few simple steps to follow to configure *your* Chimère. - -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 --------------- - -If you are not the only administrator of this Chimère installation you have to create account for the other users. -Currently the process has to be done manualy. - -Simply click on the Add button near Users. Give a name and a default password (the user can change it on in own later). -Then complete the other pieces of information. -Check the case: Member of the staff (or this user will not be able to log to this administration site). -To simply give this user correct rights don't add permission manualy but make this user member of a group. -Two default group are proposed: application administrator and moderator. - -Detail of rights for default user/groups: - -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Task | Application owner | Application administrator | Moderator | -+=========================================+===================+===========================+===========+ -| User add/modify/delete | yes | no | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Group add/modify/delete | yes | no | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Property model add/modify/delete | yes | no | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| News add/modify/delete | yes | yes | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Area add/modify/delete | yes | yes | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Icon add/modify/delete | yes | yes | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Category/Subcategory add/modify/delete | yes | yes | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Point Of Interest add/modify/delete | yes | yes | yes | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Route add/modify/delete | yes | yes | yes | -+-----------------------------------------+-------------------+---------------------------+-----------+ - - -Creating property models ------------------------- - -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. - - -Updating the design -------------------- - -You can of course customize Chimère with your own CSS. To do that just edit the file static/styles.css. - -After this basic configuration done the harder is done. You can do now application administration tasks. - -------------------- -Site administration -------------------- - -The explanation are to create new elements. To modify these elements it is the same if only some fields are already filled. - -Creating news -------------- - -A news system is available. -All you have to to do is to click on the Add button near News. -For each news you have to provided a name and a content. The content can contain HTML tags. -The avaibility is set with a checkbox. - -Creating categories/subcategories ---------------------------------- - -Before adding categories you have to set some icons. Theses icons appears on the map and in the categories' box on the main map. -Be careful to resize correctly your icons. Indeed the icon will be presented at their real size on the map. -To add icons: the Add button near Icons. - -Categories are in fact only containers for subcategories. You'll have to provide only a name and an order. -To add categories: the Add button near categories (quite clear now, isn't it?) - -Fields of subcategories are: an associated category, a name, an icon, an order, a color and an element type. -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. - ----------- -Moderation ----------- - -The moderation step is quite simple. It works the same with POIs and routes. -The moderator can access to all POIs (or routes) by clicking on the Modify button. -A search field is available to search by name but the more interesting is to filter POIs (or route) by state and by subcategory. -Then to modify an item you have to click on his name. -The submission can now freely modified. Compared to the main submission interface there is only on field add: the state field. To be publish in the main site the item must have the state: Available. -If an item is not revelant the Delete button permit to remove it. - |