diff options
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 166 |
1 files changed, 113 insertions, 53 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 64930b0..f8bed2b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -31,75 +31,135 @@ at the first paragraph of :ref:`administration` where it is presented. To access theses pages you have to identify you with an account with *staff* and *superuser* status. -A *superuser* account is created at the initialization of the database. You can -create a new *superuser* account in the web interface (see the account -management section) or with the CLI:: +A *superuser* account is created at the initialization of the database. - ./manage.py createsuperuser +Managing areas +-------------- -Creating areas +An *Area* is the base of your map. It defines: + +* a name: a human readable label for this area. +* a welcome message (*not mandatory*): this message is displayed once a day per + user arriving on the map. +* a map bounding box: this is the default area to display when arriving on the + map. +* restriction on the bounding box: if set to restricted, the end user can't pan + outside the defined bounding box. +* available layers (*not mandatory* OSM Mapnik is used by default): OSM Mapnik + render, OSM MapQuest render, OSM Transport Map render, OSM CycleMap are + available by default. You can add new custom layer cf. :ref:`managing-layers`. +* categories restriction (*not mandatory*): if no restriction is set all + categories are available. +* default checked categories (*not mandatory*). +* an external CSS file (*not mandatory*): an URL to an external CSS file. +* if categories are displayed dynamically (if dynamically is set, the end user + only view categories witch have items on the map section the user currently + see). +* an associated URN (*not mandatory*): the name of the area as a web ressource. + In practice, if the area is not the default area the URN is used at the end of + the default URL to access to this area. This is not mandatory but necessary + for each area that is not the default one. + +*Areas* are customizable directly on the web administration interface in +*Chimere/Areas*. + +As there is little chance that the default area is appropriate for you, you'll +have to set at least one default area. + +Adding many area can be a mean to show your map in different flavors. + +Managing users -------------- -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. +If you are not the only administrator/moderator of this Chimère installation +you have to create and manage account for the other users. -Creating users --------------- +You can create a new *superuser* account with the CLI:: + + ./manage.py createsuperuser -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. +User password can be changed with the CLI (useful if you have forgotten your +password):: + + ./manage.py changepassword username + +*Users* are customizable directly on the web administration interface in +*Auth/User*. + +To create a new account, simply click on the Add button near Users. Give a name +and a default password (the user can change it on in own later). -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. + +Check the case: *Staff status* (or this user will not be able to log to +the administration website). + +If this account is a new technical administrator, check *Superuser status* (this +user must be trustworthy!). Otherwise you'll have to give permissions to this +new user. It is easier to don't add permission manually but make this user +member of a group. + +Two type of default group are proposed: application administrator and moderator. + +Moderator are limited to an *Area* (they only see items that are inside the +bounding box). If a moderator manage many areas you'll have to select many +groups. 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 | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Import add/modify/delete | yes | no | no | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Layer 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 | -+-----------------------------------------+-------------------+---------------------------+-----------+ -| Color/Color theme 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 | -+-----------------------------------------+-------------------+---------------------------+-----------+ ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Task | Technical administrator | 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 | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Import add/modify/delete | yes | no | no | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Layer 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 | ++-----------------------------------------+-------------------------+---------------------------+-----------+ +| Color/Color theme 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. +A basic installation of Chimère permit to associate a name, a category, a +description, dates, multimedia files, picture files, etc. for each geographic +item. + +You may want to add more custom fields like phone number or opening hours. For +that all you have to do is to add a new property model (*Chimere/Property +model*). +The administration page ask you for: + +* a name, +* an order (to order between other properties), +* an availability to the end user (this can be used to set hidden properties), +* a mandatory status, +* the categories the property applied to (if no categories selected it applied + to all), +* the type: text, long text, password or date. + +To make this property available it is necessary to reload your webserver (the +property is cached). + +All forms are then automatically updated with this new field. |