nix/matrix: add breaking-change note to serverName description (argus #661)
argus on #661 🟡: "matrix IDs embed server_name irrevocably — anyone already running with the old default would be broken." Append a `**Breaking change as of #660**` paragraph to the `serverName` option description with the exact opt-back-in string, matching the pattern from #651's openFirewall flip. PR body + commit already documented the breakage; this surfaces it in the option's own description so it shows up in `nix flake show` + the auto- generated options docs right next to the option.
This commit is contained in:
parent
3164d8cec3
commit
71211e5722
1 changed files with 7 additions and 0 deletions
|
|
@ -84,6 +84,13 @@ in
|
|||
different server_name shape (e.g. `matrix.<domain>` if you
|
||||
want the subdomain split, or `chat.example.org` for a
|
||||
bespoke hostname).
|
||||
|
||||
**Breaking change as of #660**: this used to default to
|
||||
`matrix.''${services.hyperhive.domain}`. matrix IDs embed
|
||||
the server_name irrevocably, so existing homeservers must
|
||||
set `services.hyperhive.matrix.serverName = "matrix.''${services.hyperhive.domain}";`
|
||||
explicitly to preserve their pre-#660 user / room IDs
|
||||
before rebuilding.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue