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

Compare commits

base: vinzenz:6d9a2fa9f66d691e9f1754e94f25a1d2b0825672
Branches Tags
vinzenz:main
...
compare: vinzenz:149f745e76a887de8a6848ce5c003048bb87574e
Branches Tags
vinzenz:main
Author SHA1 Message Date
iris
149f745e76 docs(matrix): trim upgrade notes per review 
- 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
 2026-08-19 20:01:45 +02:00
iris
47f5e57c68 docs(matrix): demote breaking-change notes to clearly-scoped upgrade sections 
serverName/gatewayHost and openFirewall both led with 'Breaking
change'/'has now moved twice' phrasing woven into the primary
explanation, reading as an active/ongoing concern rather than
settled current behaviour with a historical upgrade note attached.
Reframed to state the current default first, then a demarcated
'Upgrading...' section/note for deployments carrying an older
value forward — same pattern swarm/README.md's own upgrade notes
already use. No factual content changed, removed, or added.
 2026-08-19 19:55:21 +02:00
1 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/matrix.md
View file

@ -41,7 +41,7 @@ Two distinct hostnames:
`chat.<services.hyperhive.swarm.domain>`. Set to `null` to skip the `chat.<services.hyperhive.swarm.domain>`. Set to `null` to skip the
gateway vhost (tuwunel stays direct on `httpPort`). gateway vhost (tuwunel stays direct on `httpPort`).
Both now default under the **swarm** domain, because a swarm runs one Both default under the **swarm** domain, because a swarm runs one
homeserver: tying its identity to a single hive's domain would make homeserver: tying its identity to a single hive's domain would make
relocating the container between hives look like a different relocating the container between hives look like a different
homeserver. homeserver.
@ -54,10 +54,12 @@ adopting a new one does **not** rename the existing users and rooms —
it strands them, because their ids still name a homeserver that no it strands them, because their ids still name a homeserver that no
longer answers. longer answers.
**Breaking change — pin `serverName` before rebuilding.** Its default ### Upgrading a homeserver that already has ids
has now moved twice: from `matrix.${services.hyperhive.domain}`, to
the bare hive domain, and now to the swarm domain. Any homeserver that `serverName`'s default has changed across releases. A homeserver that
has already minted ids must name the value it minted them under: has already minted ids under an older default must **pin the value it
actually minted them 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 = {
@ -82,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.
**Breaking change**: used to default to `true`. Operators relying on
external reach must add
`services.hyperhive.swarm.matrix.openFirewall = true;` before rebuilding.
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