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


In your project :

Add geostore to your ``INSTALLED_APPS`` :

::

    # install required apps
    INSTALLED_APPS = [
        ...
        'django.contrib.gis',  # assume contrib.gis is installed
        ...
        'rest_framework',
        'rest_framework_gis',
        'geostore',
        ...
    ]

Settings
********

.. warning::

  Geostore will change the geojson serializer on app loading.


INTERNAL_GEOMETRY_SRID
----------------------
**Default: 4326**

It's the installation SRID, it must be set before the first migration and never change after installation,
else you must create your own migrations to change your database SRID.

HOSTNAME
--------
**Default: empty**

Used to feed ``TERRA_TILES_HOSTNAMES`` setting

TERRA_TILES_HOSTNAMES
---------------------
**Default: [HOSTNAME, ]**

It contains the list of base URLs where are served the vector tiles.
Since web browsers limit the number of connections to one domain name, a workaround is to use
many domains to serve vector tiles, so browser will create more tcp connections, and the tiles loading
will be faster.

MAX_TILE_ZOOM
-------------
**Default: 15**

It represent the max authorized zoom, if a tile with a zoom above this setting is requested, geostore will refuse to serve it.

MIN_TILE_ZOOM
-------------
**Default: 10**

Like for ``MAX_TILE_ZOOM`` setting, if a tile of a lesser zoom than this setting is requested, backend will refuse to serve it.


GEOSTORE_LAYER_VIEWSSET
-----------------------
**Default: 'geostore.views.LayerViewSet'**

Python dotted path to LayerViewSet. Can be any class inherited from 'geostore.views.LayerViewSet'


GEOSTORE_LAYER_SERIALIZER
-------------------------
**Default: 'geostore.serializers.LayerSerializer'**

Python dotted path to LayerSerializer. Can be any class inherited from 'geostore.serializers.LayerSerializer'


GEOSTORE_EXPORT_CELERY_ASYNC
----------------------------
**Default: False**
If your project use a celery worker, set to True to enable async exports. URLS will be provided in API, calling these urls will launch asynchronous exports and send email with a link for user download.


URLs
****

Add to you urls.py file this pattern:

::

    urlpatterns = [
        ...
        path('', include('geostore.urls', namespace='geostore')),
        ...
    ]

You can customize default url and namespace by including geostore.views directly


Admin
-----

you can disable and / or customize admin