-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathdocker_env.rst
153 lines (108 loc) · 4.2 KB
/
docker_env.rst
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
****************************
Docker environment variables
****************************
The following environment variables used to deploy G3W-SUITE by docker (https://github.com/g3w-suite/g3w-suite-docker).
They must added to ``.env`` deploy file.
Requirements variables
**********************
``WEBGIS_PUBLIC_HOSTNAME``
^^^^^^^^^^^^^^^^^^^^^^^^^^
The domain to which the application will respond.
``WEBGIS_DOCKER_SHARED_VOLUME``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The path on which the docker permanent volume will be mounted with the application data inside.
Database connections parameters
-------------------------------
The follow variables re for set the connection to G3W-SUITE administration database.
``G3WSUITE_POSTGRES_USER_LOCAL``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Database username to connect to G3W-SUITE database.
If you are going to use docker postgis image, it'll be created on first run of container.
``G3WSUITE_POSTGRES_PASS``
^^^^^^^^^^^^^^^^^^^^^^^^^^
Database username password to connect to G3W-SUITE database.
If you are going to use docker postgis image, it'll be created on first run of container.
``G3WSUITE_POSTGRES_DBNAME``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Database name of G3W-SUITE database connect to.
If you are going to use docker postgis image, it'll be created on first run of container.
``G3WSUITE_POSTGRES_HOST``
^^^^^^^^^^^^^^^^^^^^^^^^^^
Database host value connect to.
If you are going to use docker postgis image, it'll be set to `postgis`
``G3WSUITE_POSTGRES_PORT``
^^^^^^^^^^^^^^^^^^^^^^^^^^
Database port value connect to.
If you are going to use docker postgis image, it'll be set to `5432`
``G3WSUITE_ADMIN_USERNAME``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The login used for the superuser account. Only works when setup a new environment.
``G3WSUITE_ADMIN_PASSWORD``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The password used for the superuser account. It will also be used as default password for new accounts.
Other not required settings
***************************
Caching system
--------------
``TILESTACHE_CACHE_TOKEN``
^^^^^^^^^^^^^^^^^^^^^^^^^^
A custom unique token to use for internal caching request.
Default value is : `374h5g96831hsgetvmkdel`.
``TILESTACHE_CACHE_BUFFER_SIZE``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tile width/height tile map dimension.
Default value is: `256`.
``G3WSUITE_TILECACHE_PATH``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Internal path to folder to save tiles of map.
Dafault value is: `/shared-volume/tile_cache/`.
Gunicorn settings
-----------------
G3W-SUITE with docker is deployed with Gunicorn.
``G3WSUITE_GUNICORN_NUM_WORKERS``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Number of workers Gunicorn has to start with.
Default: `8`.
Usually then number of workers is equal to number of processor x 2.
``G3WSUITE_GUNICORN_MAX_REQUESTS``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Number of requests after that gunicorn worker restart.
Default: `200`.
Thi is used to compensate the python/gunicorn memory leaks.
QGIS server variables
---------------------
Every QGIS environment variables available as specified on manual
https://docs.qgis.org/3.22/en/docs/server_manual/config.html#environment-variables
can be set, important is remember to add thy to `docker-compose.yml` o `docker-compose-consument.yml`.
The following varaible are just set into docker-compose files:
``PGSERVICEFILE``
^^^^^^^^^^^^^^^^^
Put your pg services into `./scripts/pg_service.conf file`, the conf file will be mounted into
docker container at runtime to PGSERVICEFILE path position.
``QGIS_SERVER_LOG_FILE``
^^^^^^^^^^^^^^^^^^^^^^^^
``QGIS_SERVER_LOG_LEVEL``
^^^^^^^^^^^^^^^^^^^^^^^^^
Openrouteservice
----------------
``ORS_API_ENDPOINT``
^^^^^^^^^^^^^^^^^^^^
Openrouteservice API end point.
Default: 'https://api.openrouteservice.org/v2'.
``ORS_API_KEY``
^^^^^^^^^^^^^^^
Openrouteservice API key
Optional, can be blank if the key is not required by the endpoint
``ORS_MAX_RANGES``
^^^^^^^^^^^^^^^^^^
Max number of ranges (it depends on the server configuration)
Default: 6.
``ORS_MAX_LOCATIONS``
^^^^^^^^^^^^^^^^^^^^^
Max number of locations(it depends on the server configuration)
Default: 2.
Frontend module
---------------
``FRONTEND``
^^^^^^^^^^^^
If `true` install and activate G3W-SUITEfrontend module https://github.com/g3w-suite/g3w-admin-frontend