2020-08-15 12:43:38 +02:00
|
|
|
# OpenSlides instance configuration
|
|
|
|
#
|
|
|
|
# As well as environment variables for various services, this file contains
|
|
|
|
# variables used to persist custom settings for docker-compose.yml or
|
|
|
|
# docker-stack.yml. See the preamble of a docker-compose.yml.m4 or
|
|
|
|
# docker-stack.yml.m4 template for more information.
|
|
|
|
#
|
|
|
|
# Most variables are listed here only to facilitate discovery of the available
|
|
|
|
# options. Empty values cause the template's defaults to be inserted.
|
|
|
|
|
|
|
|
# General
|
|
|
|
# -------
|
2021-04-08 07:41:55 +02:00
|
|
|
|
|
|
|
# The domain your OpenSlides installation in reachable. E.g. example.com or
|
|
|
|
# 127.0.0.1 for a local deployment. This domain is used when generating links
|
|
|
|
# in emails and so on, so it should be the public facing domain. The default
|
|
|
|
# is 127.0.0.1
|
|
|
|
# If you do not have any port-changing proxies, this setting should be kept in
|
|
|
|
# sync with the EXTERNAL_*_PORTS below
|
2020-08-15 12:43:38 +02:00
|
|
|
INSTANCE_DOMAIN=
|
2021-04-08 07:41:55 +02:00
|
|
|
|
|
|
|
# The schema (http or https) to use for generating public links. The default
|
|
|
|
# is https.
|
|
|
|
INSTANCE_URL_SCHEME=
|
|
|
|
|
|
|
|
# The ports the setup binds to to listen for http/https requests. To not bind
|
|
|
|
# to http or https, leave the port empty. Behavior of port-combinations:
|
|
|
|
# - If both ports are set, the server listens to https. Additionally, a http to
|
|
|
|
# https redirect is activated on the http port.
|
|
|
|
# - If no ports are set, the https port defaults to 443.
|
|
|
|
# - If exactly one port is set, the server listens to the given port.
|
|
|
|
# If the https port is set, there must be a ssl certificate. See the README
|
|
|
|
# for more information.
|
2020-08-15 12:43:38 +02:00
|
|
|
EXTERNAL_HTTP_PORT=
|
2021-04-08 07:41:55 +02:00
|
|
|
EXTERNAL_HTTPS_PORT=
|
|
|
|
|
|
|
|
# A list of hosts, that are allowed to accept. If there is a not accepted host,
|
|
|
|
# a 421 response will be returned.
|
|
|
|
# The default is an empty list, so all hosts are accepted.
|
|
|
|
# Example with two hosts: ALLOWED_HOSTS="127.0.0.1:443 example.com"
|
|
|
|
ALLOWED_HOSTS=
|
|
|
|
|
|
|
|
# The name for the docker stack used.
|
|
|
|
PROJECT_STACK_NAME=
|
|
|
|
|
|
|
|
# The default registry. Defaults to "openslides".
|
2020-08-15 12:43:38 +02:00
|
|
|
DEFAULT_DOCKER_REGISTRY=
|
|
|
|
|
|
|
|
# Docker Images
|
|
|
|
# -------------
|
Docker: Simplify image name/registry handling
For a subset of the images required by a Compose or Swarm Setup,
non-default names can be configured in .env. Originally, the names were
treated as the images' complete names, i.e., including an optional
registry domain. Using this setup, it was possible to pull the
irregularly updated auxiliary images from a default registry while, at
the same time, obtaining certain images from different registries.
Commit e225a57f97 changed this behavior. Since then, the names in .env
can only be used to change part of the image name, excluding the
registry. If a default registry is configured it is always prepended to
the given image name, breaking the original use case.
This patch removes the ability to override image names in .env.
Instead, the registry of each image can be customized.
The reasoning here is that the only common reason to change an image
name is to change its Docker registry. For example, while the default
registry may be set to default.example.com, it may be necessary to
obtain the backend image private.example.com/openslides-server. With
this patch, that would be achieved by the following configuration in
.env:
DOCKER_OPENSLIDES_BACKEND_REGISTRY="private.example.com"
For special cases, for which the images' basename must indeed be changed
as well, the template would need to be customized.
The templates are not backwards-compatible.
2021-02-24 15:42:33 +01:00
|
|
|
DOCKER_OPENSLIDES_PROXY_REGISTRY=
|
2021-02-08 13:51:56 +01:00
|
|
|
DOCKER_OPENSLIDES_PROXY_TAG=
|
Docker: Simplify image name/registry handling
For a subset of the images required by a Compose or Swarm Setup,
non-default names can be configured in .env. Originally, the names were
treated as the images' complete names, i.e., including an optional
registry domain. Using this setup, it was possible to pull the
irregularly updated auxiliary images from a default registry while, at
the same time, obtaining certain images from different registries.
Commit e225a57f97 changed this behavior. Since then, the names in .env
can only be used to change part of the image name, excluding the
registry. If a default registry is configured it is always prepended to
the given image name, breaking the original use case.
This patch removes the ability to override image names in .env.
Instead, the registry of each image can be customized.
The reasoning here is that the only common reason to change an image
name is to change its Docker registry. For example, while the default
registry may be set to default.example.com, it may be necessary to
obtain the backend image private.example.com/openslides-server. With
this patch, that would be achieved by the following configuration in
.env:
DOCKER_OPENSLIDES_BACKEND_REGISTRY="private.example.com"
For special cases, for which the images' basename must indeed be changed
as well, the template would need to be customized.
The templates are not backwards-compatible.
2021-02-24 15:42:33 +01:00
|
|
|
DOCKER_OPENSLIDES_BACKEND_REGISTRY=
|
2020-08-15 12:43:38 +02:00
|
|
|
DOCKER_OPENSLIDES_BACKEND_TAG=
|
Docker: Simplify image name/registry handling
For a subset of the images required by a Compose or Swarm Setup,
non-default names can be configured in .env. Originally, the names were
treated as the images' complete names, i.e., including an optional
registry domain. Using this setup, it was possible to pull the
irregularly updated auxiliary images from a default registry while, at
the same time, obtaining certain images from different registries.
Commit e225a57f97 changed this behavior. Since then, the names in .env
can only be used to change part of the image name, excluding the
registry. If a default registry is configured it is always prepended to
the given image name, breaking the original use case.
This patch removes the ability to override image names in .env.
Instead, the registry of each image can be customized.
The reasoning here is that the only common reason to change an image
name is to change its Docker registry. For example, while the default
registry may be set to default.example.com, it may be necessary to
obtain the backend image private.example.com/openslides-server. With
this patch, that would be achieved by the following configuration in
.env:
DOCKER_OPENSLIDES_BACKEND_REGISTRY="private.example.com"
For special cases, for which the images' basename must indeed be changed
as well, the template would need to be customized.
The templates are not backwards-compatible.
2021-02-24 15:42:33 +01:00
|
|
|
DOCKER_OPENSLIDES_FRONTEND_REGISTRY=
|
2020-08-15 12:43:38 +02:00
|
|
|
DOCKER_OPENSLIDES_FRONTEND_TAG=
|
Docker: Simplify image name/registry handling
For a subset of the images required by a Compose or Swarm Setup,
non-default names can be configured in .env. Originally, the names were
treated as the images' complete names, i.e., including an optional
registry domain. Using this setup, it was possible to pull the
irregularly updated auxiliary images from a default registry while, at
the same time, obtaining certain images from different registries.
Commit e225a57f97 changed this behavior. Since then, the names in .env
can only be used to change part of the image name, excluding the
registry. If a default registry is configured it is always prepended to
the given image name, breaking the original use case.
This patch removes the ability to override image names in .env.
Instead, the registry of each image can be customized.
The reasoning here is that the only common reason to change an image
name is to change its Docker registry. For example, while the default
registry may be set to default.example.com, it may be necessary to
obtain the backend image private.example.com/openslides-server. With
this patch, that would be achieved by the following configuration in
.env:
DOCKER_OPENSLIDES_BACKEND_REGISTRY="private.example.com"
For special cases, for which the images' basename must indeed be changed
as well, the template would need to be customized.
The templates are not backwards-compatible.
2021-02-24 15:42:33 +01:00
|
|
|
DOCKER_OPENSLIDES_AUTOUPDATE_REGISTRY=
|
2020-05-28 11:40:41 +02:00
|
|
|
DOCKER_OPENSLIDES_AUTOUPDATE_TAG=
|
2020-08-15 12:43:38 +02:00
|
|
|
|
|
|
|
# Database
|
|
|
|
# --------
|
|
|
|
PGNODE_2_ENABLED=
|
|
|
|
PGNODE_3_ENABLED=
|
|
|
|
PGNODE_REPMGR_PRIMARY=
|
|
|
|
PGNODE_WAL_ARCHIVING=
|
|
|
|
PGNODE_1_PLACEMENT_CONSTR=
|
|
|
|
PGNODE_2_PLACEMENT_CONSTR=
|
|
|
|
PGNODE_3_PLACEMENT_CONSTR=
|
|
|
|
PGBOUNCER_PLACEMENT_CONSTR=
|
|
|
|
|
|
|
|
# Service Replication
|
|
|
|
# -------------------
|
|
|
|
OPENSLIDES_BACKEND_SERVICE_REPLICAS=
|
|
|
|
OPENSLIDES_FRONTEND_SERVICE_REPLICAS=
|
2020-05-28 11:40:41 +02:00
|
|
|
OPENSLIDES_AUTOUPDATE_SERVICE_REPLICAS=
|
2020-08-15 12:43:38 +02:00
|
|
|
REDIS_RO_SERVICE_REPLICAS=
|
|
|
|
MEDIA_SERVICE_REPLICAS=
|
|
|
|
|
2020-11-05 16:19:44 +01:00
|
|
|
# Media service
|
|
|
|
# -------------
|
|
|
|
CACHE_SIZE=
|
|
|
|
CACHE_DATA_MIN_SIZE_KB=
|
|
|
|
CACHE_DATA_MAX_SIZE_KB=
|
|
|
|
|
2020-08-15 12:43:38 +02:00
|
|
|
# E-Mail
|
|
|
|
# ------
|
|
|
|
DEFAULT_FROM_EMAIL=
|
|
|
|
POSTFIX_MYHOSTNAME=
|
|
|
|
POSTFIX_RELAYHOST=
|
2020-08-15 12:59:47 +02:00
|
|
|
|
|
|
|
# OpenSlides Backend settings (settings.py)
|
|
|
|
# -----------------------------------------
|
|
|
|
# Features
|
|
|
|
ENABLE_SAML=
|
|
|
|
ENABLE_ELECTRONIC_VOTING=
|
2021-02-09 16:06:44 +01:00
|
|
|
ENABLE_CHAT=
|
2020-10-02 09:57:28 +02:00
|
|
|
DEMO_USERS=
|
2021-02-05 09:55:54 +01:00
|
|
|
|
2020-08-15 12:59:47 +02:00
|
|
|
# Connections
|
|
|
|
AUTOUPDATE_DELAY=
|
|
|
|
CONNECTION_POOL_LIMIT=
|
|
|
|
DATABASE_HOST=
|
|
|
|
DATABASE_PASSWORD=
|
|
|
|
DATABASE_PORT=
|
|
|
|
DATABASE_USER=
|
|
|
|
EMAIL_HOST=
|
|
|
|
EMAIL_HOST_PASSWORD=
|
|
|
|
EMAIL_HOST_USER=
|
|
|
|
EMAIL_PORT=
|
2020-10-28 08:34:43 +01:00
|
|
|
EMAIL_USE_SSL=
|
|
|
|
EMAIL_USE_TLS=
|
|
|
|
EMAIL_TIMEOUT=
|
2020-08-15 12:59:47 +02:00
|
|
|
JITSI_DOMAIN=
|
2020-08-21 15:46:43 +02:00
|
|
|
JITSI_ROOM_PASSWORD=
|
2020-08-15 12:59:47 +02:00
|
|
|
JITSI_ROOM_NAME=
|
|
|
|
REDIS_CHANNLES_HOST=
|
|
|
|
REDIS_CHANNLES_PORT=
|
|
|
|
REDIS_HOST=
|
|
|
|
REDIS_PORT=
|
|
|
|
REDIS_SLAVE_HOST=
|
|
|
|
REDIS_SLAVE_PORT=
|
|
|
|
REDIS_SLAVE_WAIT_TIMEOUT=
|
2021-03-12 01:07:39 +01:00
|
|
|
SERVER_SETUP_HOST=
|
|
|
|
SERVER_SETUP_PORT=
|
2021-02-05 09:55:54 +01:00
|
|
|
|
2020-08-15 12:59:47 +02:00
|
|
|
# Logging
|
|
|
|
DJANGO_LOG_LEVEL=
|
|
|
|
OPENSLIDES_LOG_LEVEL=
|
|
|
|
RESET_PASSWORD_VERBOSE_ERRORS=
|
2021-02-17 14:38:18 +01:00
|
|
|
|
|
|
|
# Optional services
|
|
|
|
# -----------------
|
|
|
|
# If enabled, Prometheus will be accessible at /prometheus/ without any
|
|
|
|
# built-in access controls! Please make sure to use it in a controlled
|
|
|
|
# development environment or to set up access controls independently.
|
|
|
|
PROMETHEUS_ENABLED=
|