vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(matrix): trim upgrade notes per review

Browse source 
- serverName upgrade note: state that it changed, drop the historical
  list of what it changed from/to
- openFirewall upgrade note: remove entirely, change is old enough
  that it's no longer worth flagging
This commit is contained in:
iris 2026-08-19 20:01:45 +02:00
commit 149f745e76
1 changed files with 4 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/matrix.md
View file

@ -56,12 +56,10 @@ longer answers.
### Upgrading a homeserver that already has ids ### Upgrading a homeserver that already has ids
`serverName`'s default has changed across releases (from `serverName`'s default has changed across releases. A homeserver that
`matrix.${services.hyperhive.domain}`, to the bare hive domain, to the has already minted ids under an older default must **pin the value it
current swarm domain). A homeserver that has already minted ids under actually minted them under**, not adopt the new default — see above
an older default must **pin the value it actually minted them for why adopting a new one strands existing users and rooms:
under**, not adopt the new default — see above for why adopting a new
one strands existing users and rooms:
```nix ```nix
services.hyperhive.swarm.matrix = { services.hyperhive.swarm.matrix = {
@ -86,10 +84,6 @@ matters for access from *outside* the host. Flip to `true` when
announcing the homeserver to other hives or when an external matrix announcing the homeserver to other hives or when an external matrix
client needs to reach the client-server API directly. client needs to reach the client-server API directly.
**Upgrading:** earlier releases defaulted `openFirewall` to `true`.
Operators relying on external reach need to add
`services.hyperhive.swarm.matrix.openFirewall = true;` explicitly now.
Federation port 8448 is intentionally not opened here — tuwunel Federation port 8448 is intentionally not opened here — tuwunel
serves the federation API on the same `httpPort` as client-server serves the federation API on the same `httpPort` as client-server
by default. Reaching it on 8448 needs either an explicit tuwunel by default. Reaching it on 8448 needs either an explicit tuwunel