diff --git a/changelog.d/5567.feature b/changelog.d/5567.feature
new file mode 100644
index 0000000000..85380bc517
--- /dev/null
+++ b/changelog.d/5567.feature
@@ -0,0 +1 @@
+Update Docker image to deprecate the use of environment variables for configuration, and make the use of a static configuration the default.
diff --git a/docker/README.md b/docker/README.md
index 7f7d27ed33..b62417c281 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -112,3 +112,19 @@ For backwards-compatibility only, the docker image supports creating a dynamic
configuration file based on environment variables. This is now deprecated, but
is enabled when the `SYNAPSE_SERVER_NAME` variable is set (and `generate` is
not given).
+
+To migrate from a dynamic configuration file to a static one, run the docker
+container once with the environment variables set, and `migrate_config`
+commandline option. For example:
+
+```
+docker run -it --rm \
+ --mount type=volume,src=synapse-data,dst=/data \
+ -e SYNAPSE_SERVER_NAME=my.matrix.host \
+ -e SYNAPSE_REPORT_STATS=yes \
+ matrixdotorg/synapse:latest migrate_config
+```
+
+This will generate the same configuration file as the legacy mode used, but
+will store it in `/data/homeserver.yaml` instead of a temporary location. You
+can then use it as shown above at [Running synapse](#running-synapse).
diff --git a/docker/conf/homeserver.yaml b/docker/conf/homeserver.yaml
index babd5bef9e..b0267b1c60 100644
--- a/docker/conf/homeserver.yaml
+++ b/docker/conf/homeserver.yaml
@@ -21,7 +21,7 @@ server_name: "{{ SYNAPSE_SERVER_NAME }}"
pid_file: /homeserver.pid
web_client: False
soft_file_limit: 0
-log_config: "/compiled/log.config"
+log_config: "{{ SYNAPSE_LOG_CONFIG }}"
## Ports ##
diff --git a/docker/start.py b/docker/start.py
index 2a13308dae..40a861f200 100755
--- a/docker/start.py
+++ b/docker/start.py
@@ -34,22 +34,21 @@ def convert(src, dst, environ):
outfile.write(rendered)
-def generate_config_from_template(environ, ownership):
+def generate_config_from_template(config_dir, config_path, environ, ownership):
"""Generate a homeserver.yaml from environment variables
Args:
+ config_dir (str): where to put generated config files
+ config_path (str): where to put the main config file
environ (dict): environment dictionary
ownership (str): "<user>:<group>" string which will be used to set
ownership of the generated configs
-
- Returns:
- path to generated config file
"""
for v in ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"):
if v not in environ:
error(
- "Environment variable '%s' is mandatory when generating a config "
- "file on-the-fly." % (v,)
+ "Environment variable '%s' is mandatory when generating a config file."
+ % (v,)
)
# populate some params from data files (if they exist, else create new ones)
@@ -78,10 +77,8 @@ def generate_config_from_template(environ, ownership):
environ[secret] = value
environ["SYNAPSE_APPSERVICES"] = glob.glob("/data/appservices/*.yaml")
- if not os.path.exists("/compiled"):
- os.mkdir("/compiled")
-
- config_path = "/compiled/homeserver.yaml"
+ if not os.path.exists(config_dir):
+ os.mkdir(config_dir)
# Convert SYNAPSE_NO_TLS to boolean if exists
if "SYNAPSE_NO_TLS" in environ:
@@ -98,8 +95,16 @@ def generate_config_from_template(environ, ownership):
+ '" unrecognized; exiting.'
)
+ if "SYNAPSE_LOG_CONFIG" not in environ:
+ environ["SYNAPSE_LOG_CONFIG"] = config_dir + "/log.config"
+
+ log("Generating synapse config file " + config_path)
convert("/conf/homeserver.yaml", config_path, environ)
- convert("/conf/log.config", "/compiled/log.config", environ)
+
+ log_config_file = environ["SYNAPSE_LOG_CONFIG"]
+ log("Generating log config file " + log_config_file)
+ convert("/conf/log.config", log_config_file, environ)
+
subprocess.check_output(["chown", "-R", ownership, "/data"])
# Hopefully we already have a signing key, but generate one if not.
@@ -114,13 +119,11 @@ def generate_config_from_template(environ, ownership):
config_path,
# tell synapse to put generated keys in /data rather than /compiled
"--keys-directory",
- "/data",
+ config_dir,
"--generate-keys",
]
)
- return config_path
-
def run_generate_config(environ, ownership):
"""Run synapse with a --generate-config param to generate a template config file
@@ -178,15 +181,36 @@ def main(args, environ):
if mode == "generate":
return run_generate_config(environ, ownership)
+ if mode == "migrate_config":
+ # generate a config based on environment vars.
+ config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+ config_path = environ.get(
+ "SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml"
+ )
+ return generate_config_from_template(
+ config_dir, config_path, environ, ownership
+ )
+
+ if mode is not None:
+ error("Unknown execution mode '%s'" % (mode,))
+
if "SYNAPSE_SERVER_NAME" in environ:
# backwards-compatibility generate-a-config-on-the-fly mode
if "SYNAPSE_CONFIG_PATH" in environ:
error(
"SYNAPSE_SERVER_NAME and SYNAPSE_CONFIG_PATH are mutually exclusive "
- "except in `generate` mode."
+ "except in `generate` or `migrate_config` mode."
)
- config_path = generate_config_from_template(environ, ownership)
+ config_path = "/compiled/homeserver.yaml"
+ log(
+ "Generating config file '%s' on-the-fly from environment variables.\n"
+ "Note that this mode is deprecated. You can migrate to a static config\n"
+ "file by running with 'migrate_config'. See the README for more details."
+ % (config_path,)
+ )
+
+ generate_config_from_template("/compiled", config_path, environ, ownership)
else:
config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
config_path = environ.get(
|
