summaryrefslogtreecommitdiff
path: root/docs/_build/html/_sources/configuration.txt
blob: f8bed2b0734e8a69ff92b8a002d5064117ed6486 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
.. -*- coding: utf-8 -*-

=============
Configuration
=============

:Author: Étienne Loks
:date: 2012-10-08
:Copyright: CC-BY 3.0

This documents presents the first steps to configure your Chimère.

The version has been updated for version 2.0.0.

If an usage to the CLI is required, your session has to be initialised with
theses environment variables::

    CHIMERE_PATH=/srv/chimere # change with your installation path
    CHIMERE_LOCALNAME=mychimere # change with your local project name
    CHIMERE_APP_PATH=$CHIMERE_PATH/$CHIMERE_LOCALNAME


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 web administration pages.

If you are not familiar with *Django-like* administration pages you can look
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.


Managing 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
--------------

If you are not the only administrator/moderator of this Chimère installation
you have to create and manage account for the other users.

You can create a new *superuser* account with the CLI::

    ./manage.py createsuperuser

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).

Then complete the other pieces of information.

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                   | 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 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.