ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
ff1d5c0c4d
OpenSlides/docker/.env

137 lines
3.6 KiB
Bash
Raw Normal View History

Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
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
# -------
Add ALLOWED_HOSTS the proxy responds with a 421, if a host header with an invalid host name is encountered. If nothing is provided (see default .env) all hosts are allowed. Examples: ALLOWED_HOSTS="localhost:8000 127.0.0.1:8000" ALLOWED_HOSTS="some.domain.example.com" Add EXTERNAL_HTTPS_PORT. See .env for the configuration.
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
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
2020-08-15 12:43:38 +02:00
INSTANCE_DOMAIN=
Add ALLOWED_HOSTS the proxy responds with a 421, if a host header with an invalid host name is encountered. If nothing is provided (see default .env) all hosts are allowed. Examples: ALLOWED_HOSTS="localhost:8000 127.0.0.1:8000" ALLOWED_HOSTS="some.domain.example.com" Add EXTERNAL_HTTPS_PORT. See .env for the configuration.
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.
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
2020-08-15 12:43:38 +02:00
EXTERNAL_HTTP_PORT=
Add ALLOWED_HOSTS the proxy responds with a 421, if a host header with an invalid host name is encountered. If nothing is provided (see default .env) all hosts are allowed. Examples: ALLOWED_HOSTS="localhost:8000 127.0.0.1:8000" ALLOWED_HOSTS="some.domain.example.com" Add EXTERNAL_HTTPS_PORT. See .env for the configuration.
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".
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
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=
Docker: Rename proxy-related variables HAProxy was replaced by Caddy, so obviously variables should not longer carry HAPROXY in their names to avoid confusion. To hopefully make future changes less likely to break configurations, we'll keep variable and image names generic (proxy instead of caddy).
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=
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
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=
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
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=
OpenSlides3+: External Autoupdate Service - Removing channels. Going back to a wsgi deployment - Removed server projector code - Autoupdate throttling is now in the client - New communication stack in the client - Adopted all deployment methods: Docker stack and docker compose (prod and dev) - Added autoupdate service as submodule
2020-05-28 11:40:41 +02:00
DOCKER_OPENSLIDES_AUTOUPDATE_TAG=
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
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=
OpenSlides3+: External Autoupdate Service - Removing channels. Going back to a wsgi deployment - Removed server projector code - Autoupdate throttling is now in the client - New communication stack in the client - Adopted all deployment methods: Docker stack and docker compose (prod and dev) - Added autoupdate service as submodule
2020-05-28 11:40:41 +02:00
OPENSLIDES_AUTOUPDATE_SERVICE_REPLICAS=
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
2020-08-15 12:43:38 +02:00
REDIS_RO_SERVICE_REPLICAS=
MEDIA_SERVICE_REPLICAS=
Add env variables for media cache
2020-11-05 16:19:44 +01:00
# Media service
# -------------
CACHE_SIZE=
CACHE_DATA_MIN_SIZE_KB=
CACHE_DATA_MAX_SIZE_KB=
Docker: Add .env This file was copied from https://github.com/OpenSlides/openslides-docker-compose/ and still needs to be adjusted for the present setup.
2020-08-15 12:43:38 +02:00
# E-Mail
# ------
DEFAULT_FROM_EMAIL=
POSTFIX_MYHOSTNAME=
POSTFIX_RELAYHOST=
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
2020-08-15 12:59:47 +02:00
# OpenSlides Backend settings (settings.py)
# -----------------------------------------
# Features
ENABLE_SAML=
ENABLE_ELECTRONIC_VOTING=
Add Chat UI Components Add Chat User Interface Restructure some services Virtual Scrolling Manual change detection for message updates Enhanced Date pipe Message layout Tabbed reusable chat window Deleting messages Further permission checks Delete-prompts Mobile friendly chat usage automatically scroll to bottom
2021-02-09 16:06:44 +01:00
ENABLE_CHAT=
Add demo mode to all docker setups
2020-10-02 09:57:28 +02:00
DEMO_USERS=
Updated README
2021-02-05 09:55:54 +01:00
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
2020-08-15 12:59:47 +02:00
# Connections
AUTOUPDATE_DELAY=
CONNECTION_POOL_LIMIT=
DATABASE_HOST=
DATABASE_PASSWORD=
DATABASE_PORT=
DATABASE_USER=
Make database table configurable through .env
2021-07-14 14:41:38 +02:00
DATABASE_NAME=
Setting for the mediafile database tablename
2021-04-22 12:41:08 +02:00
MEDIAFILE_DATABASE_NAME=
MEDIAFILE_DATABASE_USER=
MEDIAFILE_DATABASE_PASSWORD=
MEDIAFILE_DATABASE_HOST=
MEDIAFILE_DATABASE_PORT=
MEDIAFILE_DATABASE_TABLENAME=
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
2020-08-15 12:59:47 +02:00
EMAIL_HOST=
EMAIL_HOST_PASSWORD=
EMAIL_HOST_USER=
EMAIL_PORT=
Expose more email settings
2020-10-28 08:34:43 +01:00
EMAIL_USE_SSL=
EMAIL_USE_TLS=
EMAIL_TIMEOUT=
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
2020-08-15 12:59:47 +02:00
JITSI_DOMAIN=
Change jitsi_password to jitsi_room_password Fixes false naming in both documentation, template and docker
2020-08-21 15:46:43 +02:00
JITSI_ROOM_PASSWORD=
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
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=
Add ENV for server-setup host and port Signed-off-by: Adrian Nöthlich <git@promasu.tech>
2021-03-12 01:07:39 +01:00
SERVER_SETUP_HOST=
SERVER_SETUP_PORT=
Updated README
2021-02-05 09:55:54 +01:00
Docker: Add backend variables to .env and templates This setup chooses to avoid the env_file option available for Docker Compose files. Docker has a peculiar way of parsing variables which makes it, for example, include quotes verbatim. This is both confusing and incompatible with shells parsing the same file which is a requirement. For this reason, the configuration does not import the complete environment using env_file but assigns variables explicitly on a need-to-know basis in the YAML file, much like Docker secrets. Since the configuration is generated automatically, the burden on users is the same as with env_file: they only need to edit .env for customizations.
2020-08-15 12:59:47 +02:00
# Logging
DJANGO_LOG_LEVEL=
OPENSLIDES_LOG_LEVEL=
RESET_PASSWORD_VERBOSE_ERRORS=
Reference in New Issue Copy Permalink