diff --git a/docker/start.py b/docker/start.py
index a7a54dacf7..40a861f200 100755
--- a/docker/start.py
+++ b/docker/start.py
@@ -1,109 +1,243 @@
#!/usr/local/bin/python
-import jinja2
+import codecs
+import glob
import os
-import sys
import subprocess
-import glob
-import codecs
+import sys
+
+import jinja2
+
# Utility functions
-convert = lambda src, dst, environ: open(dst, "w").write(
- jinja2.Template(open(src).read()).render(**environ)
-)
+def log(txt):
+ print(txt, file=sys.stderr)
+
+
+def error(txt):
+ log(txt)
+ sys.exit(2)
-def check_arguments(environ, args):
- for argument in args:
- if argument not in environ:
- print("Environment variable %s is mandatory, exiting." % argument)
- sys.exit(2)
+def convert(src, dst, environ):
+ """Generate a file from a template
+ Args:
+ src (str): path to input file
+ dst (str): path to file to write
+ environ (dict): environment dictionary, for replacement mappings.
+ """
+ with open(src) as infile:
+ template = infile.read()
+ rendered = jinja2.Template(template).render(**environ)
+ with open(dst, "w") as outfile:
+ outfile.write(rendered)
+
+
+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
+ """
+ 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."
+ % (v,)
+ )
+
+ # populate some params from data files (if they exist, else create new ones)
+ environ = environ.copy()
+ secrets = {
+ "registration": "SYNAPSE_REGISTRATION_SHARED_SECRET",
+ "macaroon": "SYNAPSE_MACAROON_SECRET_KEY",
+ }
-def generate_secrets(environ, secrets):
for name, secret in secrets.items():
if secret not in environ:
filename = "/data/%s.%s.key" % (environ["SYNAPSE_SERVER_NAME"], name)
+
+ # if the file already exists, load in the existing value; otherwise,
+ # generate a new secret and write it to a file
+
if os.path.exists(filename):
+ log("Reading %s from %s" % (secret, filename))
with open(filename) as handle:
value = handle.read()
else:
- print("Generating a random secret for {}".format(name))
+ log("Generating a random secret for {}".format(secret))
value = codecs.encode(os.urandom(32), "hex").decode()
with open(filename, "w") as handle:
handle.write(value)
environ[secret] = value
+ environ["SYNAPSE_APPSERVICES"] = glob.glob("/data/appservices/*.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:
+ tlsanswerstring = str.lower(environ["SYNAPSE_NO_TLS"])
+ if tlsanswerstring in ("true", "on", "1", "yes"):
+ environ["SYNAPSE_NO_TLS"] = True
+ else:
+ if tlsanswerstring in ("false", "off", "0", "no"):
+ environ["SYNAPSE_NO_TLS"] = False
+ else:
+ error(
+ 'Environment variable "SYNAPSE_NO_TLS" found but value "'
+ + tlsanswerstring
+ + '" 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)
+
+ log_config_file = environ["SYNAPSE_LOG_CONFIG"]
+ log("Generating log config file " + log_config_file)
+ convert("/conf/log.config", log_config_file, environ)
-# Prepare the configuration
-mode = sys.argv[1] if len(sys.argv) > 1 else None
-environ = os.environ.copy()
-ownership = "{}:{}".format(environ.get("UID", 991), environ.get("GID", 991))
-args = ["python", "-m", "synapse.app.homeserver"]
+ subprocess.check_output(["chown", "-R", ownership, "/data"])
-# In generate mode, generate a configuration, missing keys, then exit
-if mode == "generate":
- check_arguments(
- environ, ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS", "SYNAPSE_CONFIG_PATH")
+ # Hopefully we already have a signing key, but generate one if not.
+ subprocess.check_output(
+ [
+ "su-exec",
+ ownership,
+ "python",
+ "-m",
+ "synapse.app.homeserver",
+ "--config-path",
+ config_path,
+ # tell synapse to put generated keys in /data rather than /compiled
+ "--keys-directory",
+ config_dir,
+ "--generate-keys",
+ ]
)
- args += [
+
+
+def run_generate_config(environ, ownership):
+ """Run synapse with a --generate-config param to generate a template config file
+
+ Args:
+ environ (dict): env var dict
+ ownership (str): "userid:groupid" arg for chmod
+
+ Never returns.
+ """
+ for v in ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"):
+ if v not in environ:
+ error("Environment variable '%s' is mandatory in `generate` mode." % (v,))
+
+ server_name = environ["SYNAPSE_SERVER_NAME"]
+ config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+ config_path = environ.get("SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml")
+ data_dir = environ.get("SYNAPSE_DATA_DIR", "/data")
+
+ # create a suitable log config from our template
+ log_config_file = "%s/%s.log.config" % (config_dir, server_name)
+ if not os.path.exists(log_config_file):
+ log("Creating log config %s" % (log_config_file,))
+ convert("/conf/log.config", log_config_file, environ)
+
+ # make sure that synapse has perms to write to the data dir.
+ subprocess.check_output(["chown", ownership, data_dir])
+
+ args = [
+ "python",
+ "-m",
+ "synapse.app.homeserver",
"--server-name",
- environ["SYNAPSE_SERVER_NAME"],
+ server_name,
"--report-stats",
environ["SYNAPSE_REPORT_STATS"],
"--config-path",
- environ["SYNAPSE_CONFIG_PATH"],
+ config_path,
+ "--config-directory",
+ config_dir,
+ "--data-directory",
+ data_dir,
"--generate-config",
+ "--open-private-ports",
]
+ # log("running %s" % (args, ))
os.execv("/usr/local/bin/python", args)
-# In normal mode, generate missing keys if any, then run synapse
-else:
- if "SYNAPSE_CONFIG_PATH" in environ:
- config_path = environ["SYNAPSE_CONFIG_PATH"]
- else:
- check_arguments(environ, ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"))
- generate_secrets(
- environ,
- {
- "registration": "SYNAPSE_REGISTRATION_SHARED_SECRET",
- "macaroon": "SYNAPSE_MACAROON_SECRET_KEY",
- },
+
+def main(args, environ):
+ mode = args[1] if len(args) > 1 else None
+ ownership = "{}:{}".format(environ.get("UID", 991), environ.get("GID", 991))
+
+ # In generate mode, generate a configuration and missing keys, then exit
+ 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
)
- environ["SYNAPSE_APPSERVICES"] = glob.glob("/data/appservices/*.yaml")
- if not os.path.exists("/compiled"):
- os.mkdir("/compiled")
+
+ 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` or `migrate_config` mode."
+ )
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,)
+ )
- # Convert SYNAPSE_NO_TLS to boolean if exists
- if "SYNAPSE_NO_TLS" in environ:
- tlsanswerstring = str.lower(environ["SYNAPSE_NO_TLS"])
- if tlsanswerstring in ("true", "on", "1", "yes"):
- environ["SYNAPSE_NO_TLS"] = True
- else:
- if tlsanswerstring in ("false", "off", "0", "no"):
- environ["SYNAPSE_NO_TLS"] = False
- else:
- print(
- 'Environment variable "SYNAPSE_NO_TLS" found but value "'
- + tlsanswerstring
- + '" unrecognized; exiting.'
- )
- sys.exit(2)
-
- convert("/conf/homeserver.yaml", config_path, environ)
- convert("/conf/log.config", "/compiled/log.config", environ)
- subprocess.check_output(["chown", "-R", ownership, "/data"])
-
- args += [
+ generate_config_from_template("/compiled", config_path, environ, ownership)
+ else:
+ config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+ config_path = environ.get(
+ "SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml"
+ )
+ if not os.path.exists(config_path):
+ error(
+ "Config file '%s' does not exist. You should either create a new "
+ "config file by running with the `generate` argument (and then edit "
+ "the resulting file before restarting) or specify the path to an "
+ "existing config file with the SYNAPSE_CONFIG_PATH variable."
+ % (config_path,)
+ )
+
+ log("Starting synapse with config file " + config_path)
+
+ args = [
+ "su-exec",
+ ownership,
+ "python",
+ "-m",
+ "synapse.app.homeserver",
"--config-path",
config_path,
- # tell synapse to put any generated keys in /data rather than /compiled
- "--keys-directory",
- "/data",
]
+ os.execv("/sbin/su-exec", args)
+
- # Generate missing keys and start synapse
- subprocess.check_output(args + ["--generate-keys"])
- os.execv("/sbin/su-exec", ["su-exec", ownership] + args)
+if __name__ == "__main__":
+ main(sys.argv, os.environ)
|
