-
-
Notifications
You must be signed in to change notification settings - Fork 308
Docs update to reflect other environmental variables available in the docker image #2047
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…lable in the docker image
docs/source/running-with-docker.rst
Outdated
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fence 5001 in backticks (5001 -> 5001)
docs/source/running-with-docker.rst
Outdated
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
6000 -> 6000.
docs/source/running-with-docker.rst
Outdated
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
localhost -> localhost
|
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)