Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
@bruhnild
bruhnild committed Feb 2, 2024
1 parent fbe1150 commit 65eafdc
Showing 1 changed file with 54 additions and 80 deletions.
134 changes: 54 additions & 80 deletions docs/install/advanced-configuration.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ In order to check your configuration of spatial extents, a small tool
is available at http://server/tools/extents/.

.. note ::
Administrator privileges are required.
Administrator privileges are required.
Email settings
Expand Down Expand Up @@ -61,7 +60,6 @@ API
False

.. note::

- This API provides access to promotion content (Treks, POIs, Touristic Contents ...).
- Set to ``False`` if Geotrek is intended to be used only for managing content and not promoting them.
- This setting does not impact the Path endpoints, which means that the Paths informations will always need authentication to be display in the API, regardless of this setting.
Expand Down Expand Up @@ -163,13 +161,10 @@ Expected columns in table/view are :
* ``lang`` : string (language code)

.. note ::
- The schema used in ``AUTHENT_TABLENAME`` must be in the user search_path (``ALTER USER $geotrek_db_user SET search_path=public,userschema;``)
- User management will be disabled from Administration backoffice.
- In order to disable remote login, just comment *AUTHENTICATION_BACKENDS* line in settings
file, and restart instance (see paragraph above).
- Geotrek-admin can support many types of users authentication (LDAP, oauth, ...), contact us
for more details.
- The schema used in ``AUTHENT_TABLENAME`` must be in the user search_path (``ALTER USER $geotrek_db_user SET search_path=public,userschema;``)
- User management will be disabled from Administration backoffice.
- In order to disable remote login, just comment *AUTHENTICATION_BACKENDS* line in settings file, and restart instance (see paragraph above).
- Geotrek-admin can support many types of users authentication (LDAP, oauth, ...), contact us for more details.
Custom SQL
~~~~~~~~~~
Expand Down Expand Up @@ -272,7 +267,6 @@ You can change or add more basemaps layers like this:
]

.. note::

To use some IGN Geoportail WMTS tiles (Scan25, Scan100, etc.), you may need an API key. You can find more information about this on https://geoservices.ign.fr/services-geoplateforme-diffusion.

Map layers zoom
Expand All @@ -288,8 +282,7 @@ Map layers zoom


.. note ::
It can be interesting when your tiles can't go to a zoom. For example OpenTopoMap is 17.
It can be interesting when your tiles can't go to a zoom. For example OpenTopoMap is 17.
Map layers colors and style
Expand All @@ -308,8 +301,7 @@ Map layers colors and style
MAPENTITY_CONFIG['MAP_STYLES']['city']['opacity'] = 0.8

.. note ::
It can be interesting when your tiles can't go to a zoom. For example OpenTopoMap is 17.
It can be interesting when your tiles can't go to a zoom. For example OpenTopoMap is 17.
.. envvar:: COLORS_POOL
Expand Down Expand Up @@ -409,9 +401,8 @@ Geographical CRUD
PATH_SNAPPING_DISTANCE = 2.0

.. note ::
- Change the distance. Better to keep it like this.
- Not used when ``TREKKING_TOPOLOGY_ENABLED = True``
- Change the distance. Better to keep it like this.
- Not used when ``TREKKING_TOPOLOGY_ENABLED = True``
.. envvar:: SNAP_DISTANCE

Expand All @@ -430,9 +421,8 @@ Geographical CRUD
PATH_MERGE_SNAPPING_DISTANCE = 2

.. note ::
- Change the distance. Should be higher or the same as ``PATH_SNAPPING_DISTANCE``.
- Used when ``TREKKING_TOPOLOGY_ENABLED = True``.
- Change the distance. Should be higher or the same as ``PATH_SNAPPING_DISTANCE``.
- Used when ``TREKKING_TOPOLOGY_ENABLED = True``.
.. envvar:: TREK_POINTS_OF_REFERENCE_ENABLED

Expand Down Expand Up @@ -469,9 +459,9 @@ Geographical CRUD
Example with more overlays::

TOPOLOGY_STATIC_OFFSETS = {'land': -7, 'physical': 0, 'competence': 7, 'signagemanagement': -14, 'workmanagement': 14}
.. note ::

- You should not change it to avoid overlay except if you want to have more overlays.
.. note ::
You should not change it to avoid overlay except if you want to have more overlays.
**All settings used to generate altimetric profile :**

Expand All @@ -491,7 +481,6 @@ Geographical CRUD
ALTIMETRIC_AREA_MARGIN = 0.15
.. note::

- All these settings can be modified but you need to check the result every time
- The only one modified most of the time is ``ALTIMETRIC_PROFILE_COLOR``

Expand Down Expand Up @@ -531,10 +520,9 @@ Map screenshots
MAP_CAPTURE_SIZE = 800

.. note ::
- Size in pixels of the capture.
- Be careful with your pdfs.
- If you change this value, pdfs will be rendered differently
- Size in pixels of the capture.
- Be careful with your pdfs.
- If you change this value, pdfs will be rendered differently
Modules and components
Expand Down Expand Up @@ -626,9 +614,8 @@ In order to remove zoning combo-boxes on list map:
True

.. note ::
- By doing so, some software upgrades may not be as smooth as usual.
- Never forget to mention this customization if you ask for community support.
- By doing so, some software upgrades may not be as smooth as usual.
- Never forget to mention this customization if you ask for community support.
Paths
Expand Down Expand Up @@ -674,8 +661,7 @@ Paths
True

.. note ::
Email configuration takes place in ``/opt/geotrek-admin/var/conf/custom.py``, where you control recipients emails (``ADMINS``, ``MANAGERS``) and email server configuration.
Email configuration takes place in ``/opt/geotrek-admin/var/conf/custom.py``, where you control recipients emails (``ADMINS``, ``MANAGERS``) and email server configuration.
Signage and Blade
Expand All @@ -695,10 +681,9 @@ Signage and Blade
BLADE_CODE_TYPE = INT

.. note ::
- It can be string or integer
- If you have an integer code : ``int``
- If you have an string code : ``str``
- It can be string or integer
- If you have an integer code : ``int``
- If you have an string code : ``str``
.. envvar:: BLADE_CODE_FORMAT

Expand All @@ -710,13 +695,12 @@ Signage and Blade
BLADE_CODE_FORMAT = "{signagecode}-{bladenumber}"

.. note ::
- If you want to change : move information under bracket
- You can also remove one element between bracket
- You can do for exemple : ``"CD99.{signagecode}.{bladenumber}"``
- It will display : ``CD99.XIDNZEIU.01 (first blade of XIDNZEIU)``
- ``signagecode`` is the code of the signage
- ``bladenumber`` is the number of the blade
- If you want to change : move information under bracket
- You can also remove one element between bracket
- You can do for exemple : ``"CD99.{signagecode}.{bladenumber}"``
- It will display : ``CD99.XIDNZEIU.01 (first blade of XIDNZEIU)``
- ``signagecode`` is the code of the signage
- ``bladenumber`` is the number of the blade
.. envvar:: LINE_CODE_FORMAT

Expand All @@ -728,13 +712,12 @@ Signage and Blade
LINE_CODE_FORMAT = "{signagecode}-{bladenumber}-{linenumber}"

.. note ::
- Similar with above
- You can do for example : ``"CD99.{signagecode}-{bladenumber}.{linenumber}"``
- It will display : ``CD99.XIDNZEIU-01.02`` (second line of the first blade of XIDNZEIU)
- ``signagecode`` is the code of the signage
- ``bladenumber`` is the number of the blade
- ``linenumber`` is the number of the line
- Similar with above
- You can do for example : ``"CD99.{signagecode}-{bladenumber}.{linenumber}"``
- It will display : ``CD99.XIDNZEIU-01.02`` (second line of the first blade of XIDNZEIU)
- ``signagecode`` is the code of the signage
- ``bladenumber`` is the number of the blade
- ``linenumber`` is the number of the line
Diving
Expand Down Expand Up @@ -799,9 +782,8 @@ You can also insert Outdoor minimal data:
After installing Outdoor module, you have to add permissions to your user groups on outdoor sites and courses.

.. note ::
- Outdoor module is not compatible with PostGIS <= 2.4 that is included in Ubuntu 18.04.
- You should either upgrade to Ubuntu 20.04 or upgrade postGIS to 2.5 with https://launchpad.net/~ubuntugis/+archive/ubuntu/ppa
- Outdoor module is not compatible with PostGIS <= 2.4 that is included in Ubuntu 18.04.
- You should either upgrade to Ubuntu 20.04 or upgrade postGIS to 2.5 with https://launchpad.net/~ubuntugis/+archive/ubuntu/ppa
.. _sensitive-areas:

Expand Down Expand Up @@ -1137,7 +1119,6 @@ To make these lists available for your Geotrek-rando, run ``sync_rando`` (see :r
- Make sure Users involved in the workflow have proper permissions to create and update Reports and Interventions (`/admin/auth/user/`)

.. note ::
- Be aware that, when enabling Suricate Management mode, Suricate becomes the master database for reports. This means **reports created in Geotrek-admin will not be saved to the database, they will only be sent to Suricate**.
- Reports are only saved when synchronized back from Suricate, when the synchronization command is run.
Expand Down Expand Up @@ -1324,8 +1305,7 @@ It will verify that the mimetype of the file matches the extension.
PAPERCLIP_ALLOWED_EXTENSIONS = None

.. note ::
These two settings will also not allow downloading images from the parsers.
These two settings will also not allow downloading images from the parsers.
Interface
Expand Down Expand Up @@ -2663,7 +2643,6 @@ Its configuration can be customized using advanced settings (see above paragraph
}

.. note ::
- This will apply to all text fields.
- For more information on configuration entries available, please refer to the official documentation of *TinyMCE version 3*.
Expand All @@ -2680,7 +2659,6 @@ Max characters count
MAPENTITY_CONFIG['MAX_CHARACTERS'] = 1500

.. note ::
- This will apply to all text fields.
- See `this issue <https://github.com/GeotrekCE/Geotrek-admin/issues/2901>`_ for details.
Expand All @@ -2698,7 +2676,6 @@ Copyright on pictures
THUMBNAIL_COPYRIGHT_FORMAT = "{title} {author}"

.. note ::
- This will apply to all text fields.
- For more information on configuration entries available, please refer to the official documentation of *TinyMCE version 3*.
Expand Down Expand Up @@ -2843,8 +2820,7 @@ The template for a specific portal will use the modification made on the overrid
( except if you change specific block)

.. note ::
This modification is not mandatory, if you have multiple portal and you want to modify the template of only one portal, you create one folder for this specific portal
This modification is not mandatory, if you have multiple portal and you want to modify the template of only one portal, you create one folder for this specific portal
**You might need to use your own images in the PDF templates.**

Expand All @@ -2868,9 +2844,7 @@ Example of a customised template (``/opt/geotrek-admin/var/conf/extra_templates/
{% endblock url %}

.. note ::
The default template may change in the future versions. You will be
in charge of porting the modification to your copy.
The default template may change in the future versions. You will be in charge of porting the modification to your copy.
Test your modifications by exporting a trek or a content to PDF from Geotrek-admin application.
To get your modifications available for Rando application, launch the ``sync_rando`` command.
Expand Down Expand Up @@ -2977,8 +2951,8 @@ With Geotrek-rando V2, there is a synchronization mechanism to expose Geotrek-ad
SYNC_RANDO_ROOT = os.path.join(VAR_DIR, 'data')

.. note::
- If you want to modify it, do not forget to import os at the top of the file.
- Check `import Python <https://docs.python.org/3/reference/import.html>`_ , if you need any information
- If you want to modify it, do not forget to import os at the top of the file.
- Check `import Python <https://docs.python.org/3/reference/import.html>`_ , if you need any information

.. envvar:: SYNC_RANDO_OPTIONS

Expand Down Expand Up @@ -3006,7 +2980,7 @@ Distances
500

.. note::
This distance can be changed by practice for treks in the admin.
This distance can be changed by practice for treks in the admin.

.. envvar:: DIVING_INTERSECTION_MARGIN

Expand All @@ -3033,7 +3007,7 @@ Limits
TREK_EXPORT_POI_LIST_LIMIT = 14

.. note::
``14`` is already a huge amount of POI, but it's possible to add more
``14`` is already a huge amount of POI, but it's possible to add more

.. envvar:: TREK_EXPORT_INFORMATION_DESK_LIST_LIMIT

Expand All @@ -3044,7 +3018,7 @@ Limits
TREK_EXPORT_INFORMATION_DESK_LIST_LIMIT = 14

.. note::
You can put ``-1`` if you want all the information desks
You can put ``-1`` if you want all the information desks

Categories
~~~~~~~~~~~
Expand All @@ -3062,7 +3036,7 @@ Categories
True

.. note::
Field order for each practices in admin will be taken in account
Field order for each practices in admin will be taken in account

.. envvar:: SPLIT_TREKS_CATEGORIES_BY_ACCESSIBILITY

Expand Down Expand Up @@ -3150,8 +3124,8 @@ Categories
.. note::
- All the settings about order are the order inside Geotrek-rando website.
- Practices of diving, treks and categories of touristic contents are taken in account
- All the settings about order are the order inside Geotrek-rando website.
- Practices of diving, treks and categories of touristic contents are taken in account


Settings for Geotrek-mobile
Expand All @@ -3166,8 +3140,8 @@ Settings for Geotrek-mobile
SYNC_MOBILE_ROOT = os.path.join(VAR_DIR, 'mobile')

.. note::
- If you want to modify it, do not forget to import os at the top of the file.
- Check `import Python <https://docs.python.org/3/reference/import.html>`_ , if you need any information
- If you want to modify it, do not forget to import os at the top of the file.
- Check `import Python <https://docs.python.org/3/reference/import.html>`_ , if you need any information

.. envvar:: SYNC_MOBILE_OPTIONS

Expand Down Expand Up @@ -3215,8 +3189,8 @@ Settings for Geotrek-mobile
]

.. note::
- Interval key is in meters.
- You can add new intervals
- Interval key is in meters.
- You can add new intervals

.. envvar:: MOBILE_ASCENT_INTERVALS

Expand All @@ -3232,7 +3206,7 @@ Settings for Geotrek-mobile
]

.. note::
- Do the same as above
Do the same as above

.. envvar:: MOBILE_DURATION_INTERVALS

Expand All @@ -3249,7 +3223,7 @@ Settings for Geotrek-mobile
]

.. note::
- Check ``MOBILE_LENGTH_INTERVALS`` section to use it, here interval correspond to 1 unit of hour
Check ``MOBILE_LENGTH_INTERVALS`` section to use it, here interval correspond to 1 unit of hour

.. envvar:: ENABLED_MOBILE_FILTERS

Expand All @@ -3271,5 +3245,5 @@ Settings for Geotrek-mobile
]

.. note::
- Remove any of the filters if you don't want one of them. It's useless to add other one.
Remove any of the filters if you don't want one of them. It's useless to add other one.

0 comments on commit 65eafdc

Please sign in to comment.