#960305 matrix-synapse: No instructions on setting up TLS

Package:
matrix-synapse
Source:
matrix-synapse
Description:
Matrix reference homeserver
Submitter:
Mikko Rasa
Date:
2023-02-02 21:18:03 UTC
Severity:
normal
#960305#5
Date:
2020-05-11 16:55:06 UTC
From:
To:
Debian's homeserver configuration contains a https listener with certificate
files stored under /etc/matrix-synapse.  However these files are not supplied
nor generated by the package and there's no instructions on how to generate
them.  Due to this the server won't start and it's not immediately obvious
what should be done to correct the situation.

Most debian packages which need certificates use a self-signed "snakeoil"
certificate.  Perhaps that could also be used here?

#960305#10
Date:
2021-08-01 10:08:50 UTC
From:
To:
Mikko Rasa (12020-05-11):

Hi. I am running in the same problem, and gave up considering this
project "not mature enough".

I have a tidbit of information to add:

The systemd service configuration says:

ExecStartPre=/usr/bin/python3 -m synapse.app.homeserver --config-path=/etc/matrix-synapse/homeserver.yaml --config-path=/etc/matrix-synapse/conf.d/ --generate-keys

The "--generate-keys" exists in the source code Python files.

Yet if I run this command explicitly, it does nothing at all, and strace
shows it does nothing about the keys.

Regards,

#960305#15
Date:
2023-02-02 21:14:11 UTC
From:
To:
Hello,

yes, since synapse!4509 [1] the `--generate-keys` argument does not trigger the
creation of TLS files anymore.
(the new alias `--generate-missing-config` for that option is less misleading)
Thus it would probably be a good idea for the matrix-synapse package to disable
the TLS configuration by default and to use the new `--generate-missing-config`
(instead of `--generate-keys`) to avoid any confusion.

Disabled TLS is also the default configuration provided by
`/usr/bin/synapse_generate_config`.
Probably most users will use a separate reverse proxy. Thus, the enabled TLS
setting could infact complicate deployment for many people.

Thank you for maintaining the package!

Cheers,
Lars


[1] https://github.com/matrix-org/synapse/pull/4509