matrix-synapse: fix release notes and doc for #158605 changes
This commit is contained in:
parent
605f21e375
commit
9fad223ad1
|
@ -432,6 +432,12 @@
|
||||||
still supported, because you can set arbitrary values in this
|
still supported, because you can set arbitrary values in this
|
||||||
freeform type.
|
freeform type.
|
||||||
</para>
|
</para>
|
||||||
|
<para>
|
||||||
|
The <literal>listeners.*.bind_address</literal> option was
|
||||||
|
renamed to <literal>bind_addresses</literal> in order to match
|
||||||
|
the upstream <literal>homeserver.yaml</literal> option name.
|
||||||
|
It is now also a list of strings instead of a string.
|
||||||
|
</para>
|
||||||
<para>
|
<para>
|
||||||
An example to make the required migration clearer:
|
An example to make the required migration clearer:
|
||||||
</para>
|
</para>
|
||||||
|
@ -493,7 +499,7 @@
|
||||||
|
|
||||||
listeners = [ {
|
listeners = [ {
|
||||||
port = 8448;
|
port = 8448;
|
||||||
bind_address = [
|
bind_addresses = [
|
||||||
"::"
|
"::"
|
||||||
"0.0.0.0"
|
"0.0.0.0"
|
||||||
];
|
];
|
||||||
|
@ -524,7 +530,14 @@
|
||||||
Additionally a few option defaults have been synced up with
|
Additionally a few option defaults have been synced up with
|
||||||
upstream default values, for example the
|
upstream default values, for example the
|
||||||
<literal>max_upload_size</literal> grew from
|
<literal>max_upload_size</literal> grew from
|
||||||
<literal>10M</literal> to <literal>50M</literal>.
|
<literal>10M</literal> to <literal>50M</literal>. For the same
|
||||||
|
reason, the default <literal>media_store_path</literal> was
|
||||||
|
changed from <literal>${dataDir}/media</literal> to
|
||||||
|
<literal>${dataDir}/media_store</literal> if
|
||||||
|
<literal>system.stateVersion</literal> is at least
|
||||||
|
<literal>22.05</literal>. Files will need to be manually moved
|
||||||
|
to the new location if the <literal>stateVersion</literal> is
|
||||||
|
updated.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
|
@ -141,6 +141,9 @@ In addition to numerous new and upgraded packages, this release has the followin
|
||||||
module (`services.matrix-synapse`) now need to be moved into `services.matrix-synapse.settings`. And while not all options you
|
module (`services.matrix-synapse`) now need to be moved into `services.matrix-synapse.settings`. And while not all options you
|
||||||
may use are defined in there, they are still supported, because you can set arbitrary values in this freeform type.
|
may use are defined in there, they are still supported, because you can set arbitrary values in this freeform type.
|
||||||
|
|
||||||
|
The `listeners.*.bind_address` option was renamed to `bind_addresses` in order to match the upstream `homeserver.yaml` option
|
||||||
|
name. It is now also a list of strings instead of a string.
|
||||||
|
|
||||||
An example to make the required migration clearer:
|
An example to make the required migration clearer:
|
||||||
|
|
||||||
Before:
|
Before:
|
||||||
|
@ -198,7 +201,7 @@ In addition to numerous new and upgraded packages, this release has the followin
|
||||||
|
|
||||||
listeners = [ {
|
listeners = [ {
|
||||||
port = 8448;
|
port = 8448;
|
||||||
bind_address = [
|
bind_addresses = [
|
||||||
"::"
|
"::"
|
||||||
"0.0.0.0"
|
"0.0.0.0"
|
||||||
];
|
];
|
||||||
|
@ -223,7 +226,9 @@ In addition to numerous new and upgraded packages, this release has the followin
|
||||||
|
|
||||||
The secrets in your original config should be migrated into a YAML file that is included via `extraConfigFiles`.
|
The secrets in your original config should be migrated into a YAML file that is included via `extraConfigFiles`.
|
||||||
|
|
||||||
Additionally a few option defaults have been synced up with upstream default values, for example the `max_upload_size` grew from `10M` to `50M`.
|
Additionally a few option defaults have been synced up with upstream default values, for example the `max_upload_size` grew from `10M` to `50M`. For the same reason, the default
|
||||||
|
`media_store_path` was changed from `${dataDir}/media` to `${dataDir}/media_store` if `system.stateVersion` is at least `22.05`. Files will need to be manually moved to the new
|
||||||
|
location if the `stateVersion` is updated.
|
||||||
|
|
||||||
- The MoinMoin wiki engine (`services.moinmoin`) has been removed, because Python 2 is being retired from nixpkgs.
|
- The MoinMoin wiki engine (`services.moinmoin`) has been removed, because Python 2 is being retired from nixpkgs.
|
||||||
|
|
||||||
|
|
|
@ -119,7 +119,7 @@ in {
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners">listeners</link> = [
|
<link linkend="opt-services.matrix-synapse.settings.listeners">listeners</link> = [
|
||||||
{
|
{
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners._.port">port</link> = 8008;
|
<link linkend="opt-services.matrix-synapse.settings.listeners._.port">port</link> = 8008;
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners._.bind_addresses">bind_address</link> = [ "::1" ];
|
<link linkend="opt-services.matrix-synapse.settings.listeners._.bind_addresses">bind_addresses</link> = [ "::1" ];
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners._.type">type</link> = "http";
|
<link linkend="opt-services.matrix-synapse.settings.listeners._.type">type</link> = "http";
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners._.tls">tls</link> = false;
|
<link linkend="opt-services.matrix-synapse.settings.listeners._.tls">tls</link> = false;
|
||||||
<link linkend="opt-services.matrix-synapse.settings.listeners._.x_forwarded">x_forwarded</link> = true;
|
<link linkend="opt-services.matrix-synapse.settings.listeners._.x_forwarded">x_forwarded</link> = true;
|
||||||
|
@ -152,10 +152,10 @@ in {
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
If you want to run a server with public registration by anybody, you can
|
If you want to run a server with public registration by anybody, you can
|
||||||
then enable <literal><link linkend="opt-services.matrix-synapse.settings.enable_registration">services.matrix-synapse.enable_registration</link> =
|
then enable <literal><link linkend="opt-services.matrix-synapse.settings.enable_registration">services.matrix-synapse.settings.enable_registration</link> =
|
||||||
true;</literal>. Otherwise, or you can generate a registration secret with
|
true;</literal>. Otherwise, or you can generate a registration secret with
|
||||||
<command>pwgen -s 64 1</command> and set it with
|
<command>pwgen -s 64 1</command> and set it with
|
||||||
<option><link linkend="opt-services.matrix-synapse.settings.registration_shared_secret">services.matrix-synapse.registration_shared_secret</link></option>.
|
<option><link linkend="opt-services.matrix-synapse.settings.registration_shared_secret">services.matrix-synapse.settings.registration_shared_secret</link></option>.
|
||||||
To create a new user or admin, run the following after you have set the secret
|
To create a new user or admin, run the following after you have set the secret
|
||||||
and have rebuilt NixOS:
|
and have rebuilt NixOS:
|
||||||
<screen>
|
<screen>
|
||||||
|
|
Loading…
Reference in a new issue