Docs update to reflect other environmental variables available in the docker image#2047
Conversation
…lable in the docker image
| docker run -p 5000:80 -e CONTAINER_HOST=192.168.0.7 -it geopython/pygeoapi | ||
|
|
||
| 4. **`CONTAINER_PORT`**: | ||
| This variable sets the listening port for incoming connections. The default port is `80`; in this example, we change it to 5001. |
There was a problem hiding this comment.
Fence 5001 in backticks (5001 -> 5001)
|
|
||
| 6. **`WSGI_WORKER_TIMEOUT`**: | ||
|
|
||
| Gunicorn workers silent for more than the seconds set by this variable are killed and restarted. The default value is 6000. |
| To learn more about the Admin API see :ref:`admin-api`. | ||
|
|
||
| 3. **`CONTAINER_HOST`**: | ||
| This variable sets the listening address for incoming connections. Normally the server is listening on localhost (the default), but other values are also possible. |
|
Is the understanding that variables not documented, but used in the entrypoint are adequately documented here? The two env variables I most commonly override here are |
To assume that the users will figure out these variables exist without even pointing to the documentation of Gunicorn, seems a bit far fetched; but maybe that is just me... (: |
- added backticks to 4
Overview
There are quite a few environmental variables about server behaviour that can be injected into the docker image:
pygeoapi/docker/entrypoint.sh
Lines 43 to 52 in 4fba2a4
This PR adds information about them in the documentation.
Additional information
The server port in particular is quite important to document; as it currently stands, the server is ignoring whatever is set in pygeoapi config, and overriding it with port 80.
Dependency policy (RFC2)
Updates to public demo
Contributions and licensing
(as per https://github.com/geopython/pygeoapi/blob/master/CONTRIBUTING.md#contributions-and-licensing)