-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 [open-zaak/open-zaak#1649] Document envvars
replace the manual envvar docs with OAf `generate_envvar_docs`, this ensure that generic envvars that are used by every component are documented centrally in OAF and custom envvars can be documented in the code where they are declared
- Loading branch information
Showing
4 changed files
with
130 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{% extends "open_api_framework/env_config.rst" %} | ||
|
||
{% block intro %} | ||
The Objects and Objecttypes APIs can be run both as a Docker container or a VPS / dedicated server. | ||
It relies on other services, such as database and cache backends, which can be configured through environment variables. | ||
{% endblock %} | ||
|
||
{% block extra %} | ||
|
||
Initial superuser creation (Docker only) | ||
---------------------------------------- | ||
|
||
A clean installation of Objects API comes without pre-installed or pre-configured admin | ||
user by default. | ||
|
||
Users of Objects API can opt-in to provision an initial superuser via environment | ||
variables. The user will only be created if it doesn't exist yet. | ||
|
||
* ``OBJECTS_SUPERUSER_USERNAME``: specify the username of the superuser to create. Setting | ||
this to a non-empty value will enable the creation of the superuser. Default empty. | ||
* ``OBJECTS_SUPERUSER_EMAIL``: specify the e-mail address to configure for the superuser. | ||
Defaults to `admin@admin.org`. Only has an effect if ``OBJECTS_SUPERUSER_USERNAME`` is set. | ||
* ``OBJECTS_SUPERUSER_PASSWORD``: specify the password for the superuser. Default empty, | ||
which means the superuser will be created _without_ password. Only has an effect | ||
if ``OBJECTS_SUPERUSER_USERNAME`` is set. | ||
|
||
Initial configuration | ||
--------------------- | ||
|
||
Both Objects API and Objecttypes API support `setup_configuration` management command, | ||
which allows configuration via environment variables. | ||
All these environment variables are described at :ref:`command line <installation_config_cli>`. | ||
|
||
{% endblock %} |