Skip to content

Commit

Permalink
📝 [open-zaak/open-zaak#1649] Document envvars
Browse files Browse the repository at this point in the history
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
stevenbal committed Aug 22, 2024
1 parent 321821a commit c332881
Show file tree
Hide file tree
Showing 4 changed files with 158 additions and 141 deletions.
196 changes: 78 additions & 118 deletions docs/installation/configuration/env_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,145 +4,109 @@
Environment configuration reference
===================================


Open Notificaties can be ran both as a Docker container or directly on a VPS or
dedicated server. It relies on other services, such as database and cache
backends, which can be configured through environment variables.


Available environment variables
===============================

--------

Required
--------

* ``DJANGO_SETTINGS_MODULE``: which environment settings to use. Available options:
* ``nrc.conf.production``
* ``nrc.conf.staging``
* ``nrc.conf.docker``
* ``nrc.conf.dev``
* ``nrc.conf.ci``

* ``SECRET_KEY``: secret key that's used for certain cryptographic utilities. You
should generate one via `miniwebtool`_
* ``SECRET_KEY``: Secret key that's used for certain cryptographic utilities. You should generate one via `miniwebtool <https://www.miniwebtool.com/django-secret-key-generator>`_.
* ``ALLOWED_HOSTS``: a comma separated (without spaces!) list of domains that serve the installation. Used to protect against Host header attacks. Defaults to: ``(empty string)``.
* ``CACHE_DEFAULT``: redis cache address for the default cache (this **MUST** be set when using Docker). Defaults to: ``localhost:6379/0``.
* ``CACHE_AXES``: redis cache address for the brute force login protection cache (this **MUST** be set when using Docker). Defaults to: ``localhost:6379/0``.
* ``EMAIL_HOST``: hostname for the outgoing e-mail server (this **MUST** be set when using Docker). Defaults to: ``localhost``.

* ``ALLOWED_HOSTS``: a comma separated (without spaces!) list of domains that
serve the installation. Used to protect against ``Host`` header attacks.

**Docker**

Additionally, the following optional envvars MUST be set/changed when running
on Docker, since ``localhost`` is contained within the container:

* ``CACHE_DEFAULT``
* ``CACHE_AXES``
* ``EMAIL_HOST``

--------
Optional
Database
--------

* ``ENVIRONMENT``: An identifier for the environment, displayed in the admin depending on
the settings module used and included in the error monitoring (see ``SENTRY_DSN``).
The default is set according to ``DJANGO_SETTINGS_MODULE``. Good examples values are:
* ``production``
* ``test``
* ``ACME public``

* ``SITE_ID``: defaults to ``1``. The database ID of the site object. You usually
won't have to touch this.

* ``DEBUG``: defaults to ``False``. Only set this to ``True`` on a local development
environment. Various other security settings are derived from this setting!

* ``IS_HTTPS``: defaults to the inverse of ``DEBUG``. Used to construct absolute
URLs and controls a variety of security settings.

* ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``localhost``,
unless you're using the ``docker`` environment, then it defaults to ``db``.

* ``DB_USER``: username of the database user. Defaults to ``opennotificaties``,
unless you're using the ``docker`` environment, then it defaults to ``postgres``.

* ``DB_PASSWORD``: password of the database user. Defaults to ``opennotificaties``,
unless you're using the ``docker`` environment, then it defaults to no password.

* ``DB_NAME``: name of the PostgreSQL database. Defaults to ``opennotificaties``,
unless you're using the ``docker`` environment, then it defaults to ``postgres``.

* ``DB_PORT``: port number of the database, defaults to ``5432``.

* ``USE_X_FORWARDED_HOST``: whether to grab the domain/host from the ``X-Forwarded-Host``
header or not. This header is typically set by reverse proxies (such as nginx,
traefik, Apache...). Default ``False`` - this is a header that can be spoofed and you
need to ensure you control it before enabling this.

* ``NUM_PROXIES``: the number of reverse proxies in front of Open Notificaties, as an
integer. This is used to determine the actual client IP adres. Defaults to 1, which
should be okay on Kubernetes when using an Ingress.
* ``DB_NAME``: name of the PostgreSQL database. Defaults to: ``nrc``.
* ``DB_USER``: username of the database user. Defaults to: ``nrc``.
* ``DB_PASSWORD``: password of the database user. Defaults to: ``nrc``.
* ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``db`` for the docker environment, otherwise defaults to ``localhost``.
* ``DB_PORT``: port number of the database. Defaults to: ``5432``.

* ``CACHE_DEFAULT``: redis cache address for the default cache. Defaults to
``localhost:6379/0``.

* ``CACHE_AXES``: redis cache address for the brute force login protection cache.
Defaults to ``localhost:6379/0``.

* ``EMAIL_HOST``: hostname for the outgoing e-mail server. Defaults to
``localhost``.

* ``EMAIL_PORT``: port number of the outgoing e-mail server. Defaults to ``25``.
Note that if you're on Google Cloud, sending e-mail via port 25 is completely
blocked and you should use 487 for TLS.
Cross-Origin-Resource-Sharing
-----------------------------

* ``EMAIL_HOST_USER``: username to connect to the mail server. Default empty.
* ``CORS_ALLOW_ALL_ORIGINS``: allow cross-domain access from any client. Defaults to: ``False``.
* ``CORS_ALLOWED_ORIGINS``: explicitly list the allowed origins for cross-domain requests. Example: http://localhost:3000,https://some-app.gemeente.nl. Defaults to: ``[]``.
* ``CORS_ALLOWED_ORIGIN_REGEXES``: same as ``CORS_ALLOWED_ORIGINS``, but supports regular expressions. Defaults to: ``[]``.
* ``CORS_EXTRA_ALLOW_HEADERS``: headers that are allowed to be sent as part of the cross-domain request. By default, Authorization, Accept-Crs and Content-Crs are already included. The value of this variable is added to these already included headers. Defaults to: ``[]``.

* ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Default empty.

* ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server.
Defaults to ``False``. Should be ``True`` if you're changing the ``EMAIL_PORT`` to
``487``.
Celery
------

* ``SENTRY_DSN``: URL of the sentry project to send error reports to. Default
empty, i.e. -> no monitoring set up. Highly recommended to configure this.
* ``CELERY_RESULT_BACKEND``: the URL of the backend/broker that will be used by Celery to send the notifications. Defaults to: ``redis://localhost:6379/1``.
* ``PUBLISH_BROKER_URL``: the URL of the broker that will be used to actually send the notifications. Defaults to: ``amqp://guest:guest@localhost:5672/%2F``.
* ``CELERY_BROKER_URL``: the URL of the broker that will be used to actually send the notifications. Defaults to: ``amqp://127.0.0.1:5672//``.

* ``LOG_STDOUT``: whether to log to stdout or not. For Docker environments, defaults to
``True``, for other environments the default is to log to file.

* ``EXTRA_VERIFY_CERTS``: a comma-separated list of paths to certificates to trust, empty
by default. If you're using self-signed certificates for the services that Open Notificaties
communicates with, specify the path to those (root) certificates here, rather than
disabling SSL certificate verification. Example:
``EXTRA_VERIFY_CERTS=/etc/ssl/root1.crt,/etc/ssl/root2.crt``.
Elastic APM
-----------

* ``LOG_NOTIFICATIONS_IN_DB``: indicates whether or not sent notifications should be saved to the database (default: ``False``).
* ``ELASTIC_APM_SERVER_URL``: URL where Elastic APM is hosted. Defaults to: ``None``.
* ``ELASTIC_APM_SERVICE_NAME``: Name of the service for this application in Elastic APM. Defaults to ``nrc - <environment>``.
* ``ELASTIC_APM_SECRET_TOKEN``: Token used to communicate with Elastic APM. Defaults to: ``default``.
* ``ELASTIC_APM_TRANSACTION_SAMPLE_RATE``: By default, the agent will sample every transaction (e.g. request to your service). To reduce overhead and storage requirements, set the sample rate to a value between 0.0 and 1.0. Defaults to: ``0.1``.

* ``NOTIFICATION_NUMBER_OF_DAYS_RETAINED``: the number of days for which you wish to keep notifications (default: ``30``).

------
Celery
------
Notifications
-------------

* ``CELERY_BROKER_URL``: the URL of the broker that will be used to actually send the notifications (default: ``amqp://127.0.0.1:5672//``).
* ``LOG_NOTIFICATIONS_IN_DB``: indicates whether or not sent notifications should be saved to the database. Defaults to: ``False``.
* ``NOTIFICATION_NUMBER_OF_DAYS_RETAINED``: the number of days for which you wish to keep notifications. Defaults to: ``30``.

* ``CELERY_RESULT_BACKEND``: the backend where the results of tasks will be stored (default: ``redis://localhost:6379/1``)

-----------------------------
Cross-Origin-Resource-Sharing
-----------------------------

The following parameters control the CORS policy.
Optional
--------

* ``CORS_ALLOW_ALL_ORIGINS``: allow cross-domain access from any client. Defaults to ``False``.
* ``SITE_ID``: The database ID of the site object. You usually won't have to touch this. Defaults to: ``1``.
* ``DEBUG``: Only set this to ``True`` on a local development environment. Various other security settings are derived from this setting!. Defaults to: ``False``.
* ``USE_X_FORWARDED_HOST``: whether to grab the domain/host from the X-Forwarded-Host header or not. This header is typically set by reverse proxies (such as nginx, traefik, Apache...). Note: this is a header that can be spoofed and you need to ensure you control it before enabling this. Defaults to: ``False``.
* ``IS_HTTPS``: Used to construct absolute URLs and controls a variety of security settings. Defaults to the inverse of ``DEBUG``.
* ``EMAIL_PORT``: port number of the outgoing e-mail server. Note that if you're on Google Cloud, sending e-mail via port 25 is completely blocked and you should use 487 for TLS. Defaults to: ``25``.
* ``EMAIL_HOST_USER``: username to connect to the mail server. Defaults to: ``(empty string)``.
* ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Defaults to: ``(empty string)``.
* ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server. Should be True if you're changing the ``EMAIL_PORT`` to 487. Defaults to: ``False``.
* ``DEFAULT_FROM_EMAIL``: The default email address from which emails are sent. Defaults to: ``nrc@example.com``.
* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``False``.
* ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``.
* ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``.
* ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``.
* ``SESSION_COOKIE_SAMESITE``: The value of the SameSite flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible. Defaults to: ``Strict``.
* ``CSRF_COOKIE_SAMESITE``: The value of the SameSite flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. Defaults to: ``Strict``.
* ``ENVIRONMENT``: An identifier for the environment, displayed in the admin depending on the settings module used and included in the error monitoring (see ``SENTRY_DSN``). The default is set according to ``DJANGO_SETTINGS_MODULE``.
* ``SUBPATH``: If hosted on a subpath, provide the value here. If you provide ``/gateway``, the component assumes its running at the base URL: ``https://somedomain/gateway/``. Defaults to an empty string. Defaults to: ``None``.
* ``RELEASE``: The version number or commit hash of the application (this is also sent to Sentry).
* ``NUM_PROXIES``: the number of reverse proxies in front of the application, as an integer. This is used to determine the actual client IP adres. On Kubernetes with an ingress you typically want to set this to 2. Defaults to: ``1``.
* ``CSRF_TRUSTED_ORIGINS``: A list of trusted origins for unsafe requests (e.g. POST). Defaults to: ``[]``.
* ``NOTIFICATIONS_DISABLED``: indicates whether or not notifications should be sent to the Notificaties API for operations on the API endpoints. Defaults to ``True`` for the ``dev`` environment, otherwise defaults to ``False``.
* ``DISABLE_2FA``: Whether or not two factor authentication should be disabled. Defaults to: ``False``.
* ``LOG_OUTGOING_REQUESTS_EMIT_BODY``: Whether or not outgoing request bodies should be logged. Defaults to: ``True``.
* ``LOG_OUTGOING_REQUESTS_DB_SAVE``: Whether or not outgoing request logs should be saved to the database. Defaults to: ``False``.
* ``LOG_OUTGOING_REQUESTS_DB_SAVE_BODY``: Whether or not outgoing request bodies should be saved to the database. Defaults to: ``True``.
* ``LOG_OUTGOING_REQUESTS_MAX_AGE``: The amount of time after which request logs should be deleted from the database. Defaults to: ``7``.
* ``CSP_EXTRA_DEFAULT_SRC``: Defaults to: ``[]``.
* ``CSP_REPORT_PERCENTAGE``: Defaults to: ``1.0``.
* ``CSP_EXTRA_FORM_ACTION``: Defaults to: ``[]``.
* ``CSP_FORM_ACTION``: Defaults to: ``['"\'self\'"']``.
* ``CSP_EXTRA_IMG_SRC``: Defaults to: ``[]``.
* ``CSP_OBJECT_SRC``: Defaults to: ``['"\'none\'"']``.
* ``SENTRY_DSN``: URL of the sentry project to send error reports to. Default empty, i.e. -> no monitoring set up. Highly recommended to configure this.
* ``EXTRA_VERIFY_CERTS``: a comma-separated list of paths to certificates to trust, If you're using self-signed certificates for the services that Open Notificaties communicates with, specify the path to those (root) certificates here, rather than disabling SSL certificate verification. Example: ``EXTRA_VERIFY_CERTS=/etc/ssl/root1.crt,/etc/ssl/root2.crt``. Defaults to: ``(empty string)``.

* ``CORS_ALLOWED_ORIGINS``: explicitly list the allowed origins for cross-domain requests.
Defaults to an empty list. Example: ``http://localhost:3000,https://some-app.gemeente.nl``.

* ``CORS_ALLOWED_ORIGIN_REGEXES``: same as ``CORS_ALLOWED_ORIGINS``, but supports regular
expressions.

* ``CORS_EXTRA_ALLOW_HEADERS``: headers that are allowed to be sent as part of the cross-domain
request. By default, ``Authorization``, ``Accept-Crs`` and ``Content-Crs`` are already
included. The value of this variable is added to these already included headers.
Defaults to an empty list.

---------------------
Initial configuration
Expand All @@ -154,15 +118,14 @@ All these environment variables are described at :ref:`installation_configuratio


Specifying the environment variables
====================================
=====================================

There are two strategies to specify the environment variables:

* provide them in a ``.env`` file
* start the Open Notificaties processes (with uwsgi/gunicorn/celery) in a process
* start the component processes (with uwsgi/gunicorn/celery) in a process
manager that defines the environment variables

---------------------
Providing a .env file
---------------------

Expand All @@ -172,17 +135,14 @@ NOT *in* the ``src`` directory).

The syntax is key-value:

.. code-block::
.. code::
SOME_VAR=some_value
OTHER_VAR="quoted_value"
SOME_VAR=some_value
OTHER_VAR="quoted_value"
-------------------------------------------
Provide the envvars via the process manager
-------------------------------------------

If you use a process manager (such as supervisor/systemd), use their techniques
to define the envvars. The Open Notificaties implementation will pick them up out of
the box.

.. _miniwebtool: https://www.miniwebtool.com/django-secret-key-generator/
to define the envvars. The component will pick them up out of the box.
7 changes: 2 additions & 5 deletions src/nrc/conf/dev.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
os.environ.setdefault("IS_HTTPS", "no")
os.environ.setdefault("RELEASE", "dev")
os.environ.setdefault("ENVIRONMENT", "development")
os.environ.setdefault("DISABLE_2FA", "True")

os.environ.setdefault("DB_NAME", "opennotificaties")
os.environ.setdefault("DB_USER", "opennotificaties")
Expand Down Expand Up @@ -50,10 +51,6 @@
INTERNAL_IPS = ("127.0.0.1",)
DEBUG_TOOLBAR_CONFIG = {"INTERCEPT_REDIRECTS": False}

# None of the authentication backends require two-factor authentication.
if config("DISABLE_2FA", default=True): # pragma: no cover
MAYKIN_2FA_ALLOW_MFA_BYPASS_BACKENDS = AUTHENTICATION_BACKENDS

# in memory cache and django-axes don't get along.
# https://django-axes.readthedocs.io/en/latest/configuration.html#known-configuration-problems
CACHES = {
Expand Down Expand Up @@ -84,4 +81,4 @@

TEST_CALLBACK_AUTH = False

ELASTIC_APM["DEBUG"] = config("DISABLE_APM_IN_DEV", default=True)
ELASTIC_APM["DEBUG"] = config("DISABLE_APM_IN_DEV", default=True, add_to_docs=False)
Loading

0 comments on commit c332881

Please sign in to comment.