Skip to content

Commit b967acc

Browse files
author
SilviaAmAm
committed
📝 chore: Improve docs of env vars
1 parent bb9056a commit b967acc

File tree

1 file changed

+55
-3
lines changed

1 file changed

+55
-3
lines changed

docs/developers/environment-variables.rst

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,61 @@ Backend (Django)
1313
* - Variable
1414
- Description
1515
- Default
16-
* - ``FOO``
17-
- Bar
18-
- ``"bla"``
16+
* - ``ENVIRONMENT``
17+
- A label for the environment
18+
- ``"test-maykin"``
19+
* - ``ALLOWED_HOSTS``
20+
- See `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#allowed-hosts>`__
21+
- ``localhost``
22+
* - ``DJANGO_SETTINGS_MODULE``
23+
- Path to the Django settings module to use.
24+
- ``openbeheer.conf.docker``
25+
* - ``SECRET_KEY``
26+
- See `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#secret-key>`__. Can be generated with tools like https://djecrety.ir/.
27+
- ``someSecretKey``
28+
* - ``DB_NAME``
29+
- Name of the database.
30+
- ``openbeheer``
31+
* - ``DB_USER``
32+
- Name of the database user.
33+
- ``openbeheer``
34+
* - ``DB_HOST``
35+
- Database hostname.
36+
- ``localhost``
37+
* - ``DB_PORT``
38+
- Database port.
39+
- ``5432``
40+
* - ``CACHE_DEFAULT``
41+
- Address of the cache to use for the default cache.
42+
- ``redis:6379/0``
43+
* - ``CACHE_AXES``
44+
- Address of the cache to use for the axes cache.
45+
- ``redis:6379/0``
46+
* - ``CSRF_TRUSTED_ORIGINS``
47+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#csrf-trusted-origins>`__.
48+
- ``http://localhost:9000``
49+
* - ``CSRF_COOKIE_SAMESITE``
50+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#csrf-cookie-samesite>`__.
51+
- ``Strict``
52+
* - ``CSRF_COOKIE_SECURE``
53+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#csrf-cookie-secure>`__.
54+
- ``True``
55+
* - ``SESSION_COOKIE_SAMESITE``
56+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#session-cookie-samesite>`__.
57+
- ``Strict``
58+
* - ``SESSION_COOKIE_SECURE``
59+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#session-cookie-secure>`__.
60+
- ``True``
61+
* - ``SESSION_COOKIE_AGE``
62+
- See the `Django docs <https://docs.djangoproject.com/en/5.2/ref/settings/#session-cookie-age>`__.
63+
- ``900``
64+
* - ``OIDC_RENEW_ID_TOKEN_EXPIRY_SECONDS``
65+
- Should be the same as ``SESSION_COOKIE_AGE``.
66+
- ``900``
67+
* - ``OPEN_ZAAK_ADMIN_BASE_URL``
68+
- The url of the Open Zaak that will be used to reference back to Open Zaak when features are not available in Open Beheer.
69+
- ``https://openzaak.example.nl``
70+
1971

2072
Frontend (React)
2173
----------------

0 commit comments

Comments
 (0)