Compare commits
45
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
89291f8707 | ||
|
|
9eca253229 | ||
|
|
a06ebfe6f6 | ||
|
|
6e41477a0b | ||
|
|
8a0e16cabd | ||
|
|
d9f023762e | ||
|
|
d32c74052c | ||
|
|
0716e2acd8 | ||
|
|
8eb3201b38 | ||
|
|
811ae9d2cc | ||
|
|
b2cab883d6 | ||
|
|
46d0e98424 | ||
|
|
db2f523028 | ||
|
|
b06f422837 | ||
|
|
f2d8a12aa7 | ||
|
|
7cf68b6850 | ||
|
|
894dd5277e | ||
|
|
0386474118 | ||
|
|
b8a088d2a6 | ||
|
|
8f35ab23a3 | ||
|
|
1e4922d6a3 | ||
|
|
0587f18063 | ||
|
|
7c10c9591e | ||
|
|
3ad2fef28e | ||
|
|
e16ce42785 | ||
|
|
246774e3eb | ||
|
|
3e6f210f46 | ||
|
|
3213f8c41b | ||
|
|
6cdac33ca4 | ||
|
|
6b39bd931e | ||
|
|
e1b2c8575c | ||
|
|
54bdada04d | ||
|
|
8a2867e64b | ||
|
|
2e6e8e72b8 | ||
|
|
d36c782e56 | ||
|
|
ad7d735739 | ||
|
|
4bb2dd4449 | ||
|
|
8aea38fc67 | ||
|
|
963bc87c54 | ||
|
|
85c58d5ed0 | ||
|
|
8e5cdf50b5 | ||
|
|
d3f389cab1 | ||
|
|
f7ce35c636 | ||
|
|
a52d6a89bc | ||
|
|
adeb872abb |
No files matched your search
@@ -31,6 +31,20 @@ jobs:
|
||||
- name: Run ESLint
|
||||
run: npx eslint --ext .js hookshot/
|
||||
|
||||
readme-no-webhook-ids:
|
||||
name: No Hookshot webhook IDs in README
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
# A Hookshot webhook URL's UUID is its only secret, and this repo is public.
|
||||
- name: Reject full UUIDs
|
||||
run: |
|
||||
if grep -nE '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}' README.md; then
|
||||
echo "::error::README.md contains a full UUID. Webhook IDs are secrets: list only the first 8 characters."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
hooks-no-secrets:
|
||||
name: No secrets in webhook configs
|
||||
runs-on: ubuntu-latest
|
||||
@@ -82,19 +96,20 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install Python 3.10 and pip-audit
|
||||
- name: Install Python 3.13 and pip-audit
|
||||
run: |
|
||||
# Debian Bullseye only ships Python 3.9; use a prebuilt standalone binary
|
||||
curl -sSL "https://github.com/indygreg/python-build-standalone/releases/download/20241002/cpython-3.10.15+20241002-x86_64-unknown-linux-gnu-install_only.tar.gz" \
|
||||
# Debian Bullseye only ships Python 3.9; use a prebuilt standalone binary.
|
||||
# 3.13 matches the bot's runtime on LXC 151 (Debian trixie).
|
||||
curl -sSL "https://github.com/astral-sh/python-build-standalone/releases/download/20250317/cpython-3.13.2+20250317-x86_64-unknown-linux-gnu-install_only.tar.gz" \
|
||||
| tar -xz -C /opt
|
||||
# Install bot deps + pip-audit into the same env; --local below avoids
|
||||
# pip-audit creating an internal venv (ensurepip fails on standalone builds)
|
||||
/opt/python/bin/pip install --upgrade pip setuptools
|
||||
/opt/python/bin/pip install pip-audit -r matrixbot/requirements.txt
|
||||
/opt/python/bin/pip install --upgrade pip-audit -r matrixbot/requirements.txt
|
||||
|
||||
- name: Audit matrixbot dependencies
|
||||
# --local scans the env without spawning a venv (required for standalone Python)
|
||||
# CVE-2026-3219 is in pip itself, not our code — ignore it explicitly
|
||||
# CVE-2026-3219 is in pip itself, not our code — ignore it explicitly.
|
||||
run: /opt/python/bin/pip-audit --local --ignore-vuln CVE-2026-3219
|
||||
|
||||
secret-scan:
|
||||
@@ -116,7 +131,7 @@ jobs:
|
||||
run: |
|
||||
# Scan application code directories — deploy/ is excluded because
|
||||
# it contains intentional Gitea webhook HMAC secrets in hooks-lxc*.json
|
||||
for dir in matrixbot/ hookshot/ .gitea/ systemd/ cinny/ landing/; do
|
||||
for dir in matrixbot/ hookshot/ .gitea/ systemd/ cinny/ landing/ discord-bridge/; do
|
||||
[ -d "$dir" ] || continue
|
||||
gitleaks detect --source "$dir" --no-git --config .gitleaks.toml \
|
||||
--redact --exit-code 1
|
||||
|
||||
@@ -26,6 +26,9 @@ matrix/
|
||||
│ └── index.html # matrix.lotusguild.org landing page
|
||||
├── draupnir/
|
||||
│ └── production.yaml # Draupnir config (access token is redacted — see rotation docs below)
|
||||
├── discord-bridge/
|
||||
│ ├── config.yaml # mautrix-discord config (DB password filled in on the server, never committed)
|
||||
│ └── install.sh # One-time installer, run on the Proxmox node hosting LXC 109 + 151
|
||||
├── deploy/ # Auto-deployment infrastructure
|
||||
│ ├── lxc151-hookshot.sh # Deploy script for LXC 151 (matrix/hookshot/livekit)
|
||||
│ ├── lxc106-cinny.sh # Deploy script for LXC 106 (cinny)
|
||||
@@ -41,6 +44,7 @@ matrix/
|
||||
├── livekit-graceful-restart.service # oneshot — checks pending restart flag
|
||||
├── livekit-graceful-restart.timer # Runs every 5 min
|
||||
├── draupnir.service
|
||||
├── mautrix-discord.service # Discord bridge (LXC 151)
|
||||
└── cinny-upstream-check.cron # Installed to /etc/cron.d/ on LXC 106 — runs daily at noon
|
||||
```
|
||||
|
||||
@@ -50,7 +54,7 @@ matrix/
|
||||
|
||||
| Service | IP | LXC | RAM | Disk | Versions |
|
||||
|---------|----|-----|-----|------|----------|
|
||||
| Synapse | 10.10.10.29 | 151 | 12GB | 50GB | Synapse 1.159.0, LiveKit 1.9.11, hookshot 7.3.2, coturn latest |
|
||||
| Synapse | 10.10.10.29 | 151 | 12GB | 50GB | Synapse 1.164.1, LiveKit 1.9.11, hookshot 7.3.2, coturn latest |
|
||||
| PostgreSQL 17 | 10.10.10.44 | 109 | 6GB | 80GB | PostgreSQL 17.9 |
|
||||
| Cinny Web | 10.10.10.6 | 106 | 2GB | 8GB | Debian 12, nginx, Node 24, Lotus Cinny fork (custom, tracks `cinnyapp/cinny` main) |
|
||||
| Draupnir | 10.10.10.24 | 110 | 1GB | 10GB | Draupnir v2.9.0, Node.js v22 |
|
||||
@@ -187,9 +191,14 @@ Killing livekit-server while a call is active drops everyone. Instead:
|
||||
|
||||
1. Deploy to LXC 151 copies the new `livekit-server.service` and sets a `/run/livekit-restart-pending` flag
|
||||
2. `livekit-graceful-restart.timer` runs every 5 minutes
|
||||
3. The timer script counts established TCP connections on port 7881 (`ss -tn state established`)
|
||||
4. If zero connections → restarts livekit-server and clears the flag
|
||||
5. If connections exist → logs and exits, retries in 5 minutes
|
||||
3. The timer script reads LiveKit's own `livekit_participant_total` (`:6789/metrics`) and counts open
|
||||
signalling WebSockets on :7880. If the metrics can't be read it assumes a call is active.
|
||||
4. Zero participants and zero signalling connections → restarts livekit-server and clears the flag
|
||||
5. Otherwise → logs and exits, retries in 5 minutes
|
||||
|
||||
Until 2026-11-03 it counted `ESTAB` lines on :7881, which was always 0 (an `ss` state filter drops the
|
||||
State column, and :7881 is only the ICE-TCP fallback), so it would have restarted mid-call (matrix #54).
|
||||
To stage a restart by hand, for example after replacing the binary: `touch /run/livekit-restart-pending`.
|
||||
|
||||
---
|
||||
|
||||
@@ -206,6 +215,7 @@ Every Matrix client must fetch a LiveKit JWT from lk-jwt-service before it can j
|
||||
- **Participant limit** — it forwards to lk-jwt-service, and if a token is issued decodes the JWT to get the LiveKit alias (`video.room`) + requester (`sub`), then asks LiveKit `ListParticipants` how many **distinct Matrix users** are in the room. requester already present (rejoin) → allow · distinct users ≥ limit → **403** · otherwise → allow.
|
||||
- **Publish permissions (screenshare / camera)** — LiveKit is a pure SFU and **cannot cap a publisher's bitrate/framerate** (no such field exists in the grant/config/API — that stays a Lotus-client-cooperative setting). But the JWT's `video.canPublishSources` **is** SFU-enforced for every client. Since the guard holds the LiveKit signing secret, when a room forbids a source it **decodes the issued token, drops `screen_share`/`screen_share_audio` (and/or `camera`) from `canPublishSources`, and re-signs it** (HS256, same key). Microphone is always kept. The SFU then rejects those tracks for **all** clients — nothing to opt into.
|
||||
- **Live (mid-call) enforcement** — the JWT re-sign covers anyone *joining* after a policy change. For people **already in the call**, a background **reconcile loop** (every `GUARD_RECONCILE_INTERVAL`, default 3 s) calls LiveKit `UpdateParticipant` to narrow their `canPublishSources`, which **unpublishes an in-progress screenshare/camera server-side for all clients** and blocks re-publish (confirmed LiveKit 1.9.11 behavior: reducing `can_publish_sources` removes the offending live track). So flipping a room to audio-only kills existing cameras/screenshares within ~one interval. The loop learns each LiveKit room's Matrix id from tokens it issues, only ever **removes** forbidden sources (never grants), preserves every other permission flag (full-replace safety), and no-ops once compliant. Disable with `GUARD_RECONCILE=0`.
|
||||
- **Connect-time limit (matrix #25)** — the token check can't stop a token fetched while there was space (lk-jwt tokens last an hour) from being used once the room is full. The same reconcile loop compares each limited room's **distinct Matrix users** with `max_users`, and when people who **arrived since the previous sweep** take it over the limit it calls LiveKit `RemoveParticipant` on them, newest first (all their devices). People already in the call are never removed, so **lowering a limit mid-call kicks nobody**; a person's extra devices never count twice. The first sweep of a room only records who is there. Simultaneous joins are already handled at token issue (per-room lock + 30 s slot reservations).
|
||||
- **Fail-open:** any error (admin API down, bad/absent token, LiveKit unreachable, unparseable room id, unexpected JWT shape) returns the upstream response **unchanged**, so calls keep working even if enforcement is degraded. The limit check and the source-policy re-sign are **independent** (a LiveKit-admin outage during the limit count can't skip the source restriction, and vice-versa). Before re-signing, the guard **verifies its own secret actually signed the token** — on a `LIVEKIT_SECRET` mismatch it skips the restriction and passes the original token through (so a secret drift can never emit a token the SFU rejects). A room with no policy set takes a zero-overhead fast path (token untouched).
|
||||
|
||||
> `LIVEKIT_KEY`/`LIVEKIT_SECRET` live in `/etc/matrix-deploy.env` (0600, not in git). The same pair must
|
||||
@@ -285,6 +295,7 @@ The token in `draupnir/production.yaml` in this repo is **intentionally redacted
|
||||
| 9002 | Hookshot bridge (appservice) | 127.0.0.1 |
|
||||
| 9003 | Hookshot webhooks | 0.0.0.0 |
|
||||
| 9004 | Hookshot metrics | 0.0.0.0 |
|
||||
| 29334 | mautrix-discord (appservice + avatar proxy for NPM) | 0.0.0.0 |
|
||||
| 9100 | node_exporter | 0.0.0.0 |
|
||||
| 9101 | matrix-admin exporter | 0.0.0.0 |
|
||||
| 9500 | webhook (auto-deploy) | 0.0.0.0 |
|
||||
@@ -324,6 +335,7 @@ The token in `draupnir/production.yaml` in this repo is **intentionally redacted
|
||||
| Commands | `!ou56mVZQ8ZB7AhDYPmBV5_BR28WMZ4x5zwZkPCqjq1s` | restricted (Space members) |
|
||||
| Memes | `!GK6v5cLEEnowIooQJv5jECfISUjADjt8aKhWv9VbG5U` | restricted (Space members) |
|
||||
| Music | `!ktQu0gavhjpCMkgxk8SYdb6mnJRY-u7mY7_KfksV0SU` | restricted (Space members) |
|
||||
| Discord bridge (Discord channel `1565159372122882070`) | `!hm4ghdqvSYMokV30Ow-0TKK5hMZRSXfDiHOIzrK-c_A` | invite |
|
||||
| Voice Room | `!ARbRFSPNp2U0MslWTBGoTT3gbmJJ25dPRL6enQntvPo` | restricted (Space members) |
|
||||
| Management | `!mEvR5fe3jMmzwd-FwNygD72OY_yu8H3UP_N-57oK7MI` | invite |
|
||||
| Cool Kids | `!R7DT3QZHG9P8QQvX6zsZYxjkKgmUucxDz_n31qNrC94` | invite |
|
||||
@@ -336,27 +348,34 @@ The token in `draupnir/production.yaml` in this repo is **intentionally redacted
|
||||
|
||||
---
|
||||
|
||||
## Webhook Integrations (matrix-hookshot 7.3.2)
|
||||
## Webhook Integrations (matrix-hookshot 7.5.0)
|
||||
|
||||
Generic webhooks bridged into **Spam and Stuff**.
|
||||
Each service gets its own virtual user (`@hookshot_<service>`) with a unique avatar.
|
||||
Webhook URL format: `https://matrix.lotusguild.org/webhook/<uuid>`
|
||||
|
||||
> The UUID **is** the secret: anyone who has it can post into the room. This repo is public, so
|
||||
> the table lists only the first 8 characters (enough to match Hookshot's logs); the full URLs
|
||||
> live in each sender's settings. Full UUIDs were in this file from 2026-02-20 to 2026-11-03,
|
||||
> so the IDs below are exposed in git history until rotated (see *Webhook secrets — rotating*).
|
||||
> Grafana, Proxmox, Uptime Kuma and Ci-Alert were rotated on 2026-11-03 (the old IDs now return 404).
|
||||
> CI (`readme-no-webhook-ids`) rejects full UUIDs in this README.
|
||||
|
||||
| Service | Webhook UUID | Notes |
|
||||
|---------|-------------|-------|
|
||||
| Grafana | `df4a1302-2d62-4a01-b858-fb56f4d3781a` | Unified alerting contact point |
|
||||
| Proxmox | `9b3eafe5-7689-4011-addd-c466e524661d` | Notification system (8.1+), Discord embed format |
|
||||
| Sonarr | `aeffc311-0686-42cb-9eeb-6757140c072e` | All event types |
|
||||
| Radarr | `34913454-c1ac-4cda-82ea-924d4a9e60eb` | All event types |
|
||||
| Readarr | `e57ab4f3-56e6-4dc4-8b30-2f4fd4bbeb0b` | All event types |
|
||||
| Lidarr | `66ac6fdd-69f6-4f47-bb00-b7f6d84d7c1c` | All event types |
|
||||
| Uptime Kuma | `1a02e890-bb25-42f1-99fe-bba6a19f1811` | Status change notifications |
|
||||
| Seerr | `555185af-90a1-42ff-aed5-c344e11955cf` | Request/approval events |
|
||||
| Owncast (Livestream) | `9993e911-c68b-4271-a178-c2d65ca88499` | STREAM_STARTED / STREAM_STOPPED |
|
||||
| Bazarr | `470fb267-3436-4dd3-a70c-e6e8db1721be` | Subtitle events (Apprise JSON notifier) |
|
||||
| Tinker-Tickets | `6e306faf-8eea-4ba5-83ef-bf8f421f929e` | Custom transformation code |
|
||||
| Ci-Alert | `5e7051e7-fd0c-4930-a711-9c67daf6f0b9` | Gitea Actions `notify-failure` jobs (org secret `MATRIX_WEBHOOK_URL`); transform `hookshot/ci-alert.js` |
|
||||
| Devdesk | `4a3ccfc9-e1fe-4124-b014-7842fe51b9dc` | DevDesk "Claude needs you" (CT 126 `devdesk-notify-matrix`, URL in `/etc/devdesk/matrix-webhook`); transform `hookshot/devdesk.js`; avatar set via the appservice token |
|
||||
| Grafana | `e713b383…` | Unified alerting contact point |
|
||||
| Proxmox | `ca27432c…` | Notification system (8.1+), Discord embed format |
|
||||
| Sonarr | `aeffc311…` | All event types |
|
||||
| Radarr | `34913454…` | All event types |
|
||||
| Readarr | `e57ab4f3…` | All event types |
|
||||
| Lidarr | `66ac6fdd…` | All event types |
|
||||
| Uptime Kuma | `4b3fb94b…` | Status change notifications |
|
||||
| Seerr | `555185af…` | Request/approval events |
|
||||
| Owncast (Livestream) | `9993e911…` | STREAM_STARTED / STREAM_STOPPED |
|
||||
| Bazarr | `470fb267…` | Subtitle events (Apprise JSON notifier) |
|
||||
| Tinker-Tickets | `6e306faf…` | Custom transformation code |
|
||||
| Ci-Alert | `66c1aa17…` | Gitea Actions `notify-failure` jobs (org secret `MATRIX_WEBHOOK_URL`); transform `hookshot/ci-alert.js` |
|
||||
| Devdesk | `4a3ccfc9…` | DevDesk "Claude needs you" (CT 126 `devdesk-notify-matrix`, URL in `/etc/devdesk/matrix-webhook`); transform `hookshot/devdesk.js`; avatar set via the appservice token |
|
||||
|
||||
**Hookshot notes:**
|
||||
- Spam and Stuff is intentionally **unencrypted** — hookshot bridges cannot join E2EE rooms
|
||||
@@ -380,6 +399,121 @@ bash /opt/matrix-config/hookshot/deploy.sh proxmox.js # deploy one
|
||||
|
||||
---
|
||||
|
||||
## Discord Bridge (mautrix-discord v0.7.7)
|
||||
|
||||
Bridges Discord channels to Matrix rooms on LXC 151. The bridge logs in as a **Discord bot**
|
||||
(not anyone's personal account, which breaks Discord's ToS): Discord users appear in Matrix as
|
||||
`@discord_<id>:matrix.lotusguild.org` ghosts, and Matrix users are relayed into Discord through a
|
||||
channel webhook with their own display name.
|
||||
|
||||
- Bridge bot: `@discordbot:matrix.lotusguild.org`
|
||||
- Config: `/opt/mautrix-discord/config.yaml` (template in `discord-bridge/config.yaml`; the bridge
|
||||
rewrites it on start, so it is **not** auto-deployed)
|
||||
- Registration: `/etc/matrix-synapse/discord-registration.yaml` (listed in `app_service_config_files`)
|
||||
- Database: `mautrix_discord` on LXC 109, role `mautrix_discord`, allowed from 10.10.10.29 in `pg_hba.conf`
|
||||
- Service: `systemctl status mautrix-discord`, logs in `journalctl -u mautrix-discord` and `/var/log/mautrix-discord/`
|
||||
- End-to-bridge encryption is allowed, so it can join encrypted rooms
|
||||
|
||||
**Install (one time):** after this repo's `main` has reached `/opt/matrix-config` on LXC 151, run this
|
||||
on the Proxmox node hosting LXC 109 and 151. It restarts Synapse once and is safe to re-run.
|
||||
|
||||
```bash
|
||||
pct exec 151 -- cat /opt/matrix-config/discord-bridge/install.sh | bash
|
||||
```
|
||||
|
||||
**Discord side:** Developer Portal → application → Bot. Turn on the **Message Content** and
|
||||
**Server Members** intents. Invite the bot with the `bot` scope and View Channels, Send Messages,
|
||||
Read Message History, Manage Webhooks, Attach Files, Add Reactions, Manage Messages and Embed Links.
|
||||
|
||||
**Linking a room:**
|
||||
1. DM `@discordbot:matrix.lotusguild.org`: `login-token bot <bot token>` (the token lives only in the bridge DB)
|
||||
2. `guilds bridge <discord server id>` — the server ID comes from Discord Developer Mode → right-click
|
||||
3. In the Matrix room: invite `@discordbot`, then `!discord bridge <channel id>` and `!discord set-relay --create <webhook name>`
|
||||
|
||||
Skip `guilds bridge`: it sets the guild to create a Matrix room for every channel on its first message.
|
||||
`bridge` alone bumps the guild to `if-portal-exists`. To move a link to another room, run
|
||||
`!discord bridge --replace <channel id>` there (never `--replace=delete`, which kicks everyone from the
|
||||
old room). The relay webhook stays with the channel. Keep `@discordbot` at the default power level so it
|
||||
can't overwrite the room's name and icon with the Discord channel's.
|
||||
|
||||
**Bot profile:** `@discordbot` shows as "Discord Bridge" with the Discord logo
|
||||
(`discord-bridge/bot-avatar.png`). To reapply it: `pct exec 151 -- bash /opt/matrix-config/discord-bridge/set-bot-profile.sh`.
|
||||
|
||||
**Who the Discord bot login belongs to:** `@jared` holds it. The account holding the login sends its
|
||||
own messages to Discord *as the bot* ("matrix-bridge APP"), because the bridge prefers a real Discord
|
||||
connection over the webhook. Everyone else is relayed through the channel webhook under their own name
|
||||
and avatar. To change that, log the bot in from a dedicated non-chatting account; that automatically
|
||||
logs out whichever account held it before.
|
||||
|
||||
**Rotating the bot token:** reset it in the Developer Portal, then DM the bridge bot `logout` and
|
||||
`login-token bot <new token>`.
|
||||
|
||||
**Matrix avatars on Discord:** relayed messages carry the sender's avatar as a signed URL under
|
||||
`bridge.public_address` (`https://matrix.lotusguild.org`), which Discord fetches. NPM proxies
|
||||
`/mautrix-discord/avatar/` → `http://10.10.10.29:29334` (hand-added location in
|
||||
`/data/nginx/proxy_host/49.conf` on LXC 139, like `/sfu/get` — **re-add it after any NPM UI save of
|
||||
proxy host 49**). The bridge listens on `0.0.0.0:29334` for this; the appservice API on that port
|
||||
still requires the `hs_token`, and only the avatar path is proxied publicly.
|
||||
|
||||
**Catch-up after downtime:** `backfill.forward_limits.missed.channel: -1`, so Discord messages sent
|
||||
while the bridge or Synapse was down are bridged when it starts again.
|
||||
|
||||
---
|
||||
|
||||
## Voice Bridge (nether-voicebridge, Lotus-patched)
|
||||
|
||||
Bridges Discord voice into a Lotus voice room. People on Discord appear **inside the Matrix call**
|
||||
under their Discord names, with a speaking indicator. People in Lotus appear in the Discord channel
|
||||
as `[Matrix] <name>`, with mute mirrored to Discord.
|
||||
|
||||
| | Text | Voice |
|
||||
|---|---|---|
|
||||
| Discord (Lotus Guild server) | #matrix-bridge | matrix-bridge |
|
||||
| Matrix (Lotus) | Discord Bridge (mautrix-discord) | Discord Voice Bridge (`!yS_ZIHL3sOKQJBt4NiIQyiHKt3cv6HrIDeq7OxDpSM0`) |
|
||||
|
||||
- **Build:** upstream [nether-voicebridge](https://nether.codes/nether/nether-voicebridge) `cf52945`
|
||||
plus 12 patches to report upstream and 1 Lotus-only patch: Discord users without an avatar get
|
||||
Discord's default one. Patches, bug log and issue drafts live in
|
||||
`/root/code/voice-bridge-trial/`. **Don't run the unpatched release**. Without the patches the
|
||||
bridge can't see anyone using current Element Call or Lotus Call (`livekit_alias`), and encrypted
|
||||
voice breaks after a restart on Synapse.
|
||||
- **Accounts:** the bot is `@lotus-voice_bot`, shown as "Discord Voice Bridge" with the Discord logo.
|
||||
It has **no special power** in the room; it only needs calls at power level 0. The room has the
|
||||
Discord logo, a topic, and an `m.bridge` record, so Lotus shows the Discord chip linking to the channel.
|
||||
Discord speakers are `@lotus-voice_<discord id>`. The appservice registration is
|
||||
`/etc/matrix-synapse/lotus-voice-registration.yaml`.
|
||||
- **Discord bots:** Lotus Voice 1–3, one per Matrix person speaking at once. Each has only Connect,
|
||||
Speak, Use Voice Activity and Change Nickname, and none can see #matrix-bridge text.
|
||||
- **Files on LXC 151:**
|
||||
- binary: `/opt/lotus-voice/lotus-voice-bridge`
|
||||
- config: `/etc/lotus-voice/config.toml` (0600, holds the bot tokens)
|
||||
- state: `/var/lib/lotus-voice`
|
||||
- service: `lotus-voice-bridge`, logs via `journalctl -u lotus-voice-bridge`
|
||||
- **Voice limits:** `voice-limit-guard` ignores `@lotus-voice_bot` (`VOICE_LIMIT_EXEMPT_USERS`), so
|
||||
the bot never takes a slot. Discord speakers count like anyone else. When a room is full the
|
||||
bridge stops trying cleanly, and the Discord user just isn't heard.
|
||||
- **Install / upgrade:** on the Proxmox node hosting LXC 151, run
|
||||
`bash voice-bridge/install.sh <binary> <secrets file with BOT1..BOT3>`. The first install
|
||||
registers the appservice, restarts Synapse once and creates the bot account. Then invite
|
||||
`@lotus-voice_bot:matrix.lotusguild.org` to the voice room. **To upgrade:** push the new binary to
|
||||
`/opt/lotus-voice/lotus-voice-bridge` (keep the old one as `.prev`), then run
|
||||
`systemctl restart lotus-voice-bridge`. Synapse isn't touched.
|
||||
|
||||
## Bot profiles
|
||||
|
||||
Every bot account has a proper name and an avatar in one style (white glyph on a coloured square). Image sources are in `avatars/` and `discord-bridge/bot-avatar.png`.
|
||||
|
||||
| Account | Name | How it's set |
|
||||
|---------|------|--------------|
|
||||
| `@discordbot` | Discord Bridge | `discord-bridge/set-bot-profile.sh` (bridge config `appservice.bot`, applied on bridge start) |
|
||||
| `@discord-relay` | Discord Relay | Set by hand while signed in as it (`avatars/discord-relay.png`); holds the Discord bot login |
|
||||
| `@hookshot` | Lotus Webhooks | `bot:` section in `/opt/hookshot/config.yml` on LXC 151 (`avatars/hookshot.png`), applied on hookshot start |
|
||||
| `@draupnir` | Draupnir | Profile API with Draupnir's token (Draupnir doesn't manage its own profile) |
|
||||
| `@lotusbot` | Lotus Bot | Already set |
|
||||
| `@notices` | Server Notices | `server_notices.system_mxid_avatar_url` in `homeserver.yaml` (Lotus logo); needs a Synapse restart |
|
||||
|
||||
---
|
||||
|
||||
## Moderation (Draupnir v2.9.0)
|
||||
|
||||
Draupnir runs on LXC 110, manages moderation across all protected rooms (including the Lotus Guild space) via `#management:matrix.lotusguild.org`.
|
||||
@@ -822,6 +956,7 @@ Leaving a space does **not** leave its child rooms; they are independent rooms w
|
||||
- [x] Per-service JS transformation functions (stored in git, auto-deployed)
|
||||
- [x] Per-service virtual user avatars
|
||||
- [x] NPM reverse proxy for `/webhook` path
|
||||
- [x] mautrix-discord bridge (bot login + webhook relay) — config and installer in `discord-bridge/`, live since 2026-10-28
|
||||
|
||||
### Room Structure
|
||||
- [x] The Lotus Guild space with all core rooms
|
||||
@@ -861,6 +996,47 @@ Leaving a space does **not** leave its child rooms; they are independent rooms w
|
||||
|
||||
---
|
||||
|
||||
## Hookshot Upgrade Notes
|
||||
|
||||
Hookshot is a **git checkout built from source** at `/opt/hookshot` (`ExecStart=node lib/App/BridgeApp.js`).
|
||||
Only `config.yml` and `passkey.pem` in it are not generated; storage is in-memory (connections are room state).
|
||||
|
||||
- **7.4.1+ builds with pnpm**, and `scripts/build-app.sh` calls `pnpm` directly. Without a global pnpm,
|
||||
put a wrapper first in `PATH`: `printf '#!/bin/sh\nexec corepack pnpm@<version> "$@"\n'` (version from
|
||||
`devEngines.packageManager` in `package.json`). The Rust layer needs `~/.cargo/bin` in `PATH`.
|
||||
- **7.6.0 drops Node 22** (LXC 151 runs Node 22), so 7.5.0 is the newest that runs as-is.
|
||||
- Build the new tag in a separate directory (`git clone --depth 1 --branch <tag> … /opt/hookshot-<tag>`,
|
||||
`pnpm install --frozen-lockfile && pnpm run build`), copy in `config.yml` + `passkey.pem`, then stop the
|
||||
service, swap the directories (keep the old one for rollback) and start it. Check the log says
|
||||
`Bridge is now ready. Found N connections`.
|
||||
- 2026-11-03: 7.3.2 → 7.5.0 (GHSA-5c49-6fvm-2xvc: `/metrics` exposed webhook URLs, plus two DoS fixes).
|
||||
Old build kept at `/opt/hookshot-7.3.2`.
|
||||
|
||||
## Call Stack Upgrade (lk-jwt-service 0.4.1 → 0.9.0, LiveKit 1.9.11 → 1.13.11) — planned
|
||||
|
||||
Tested on the local stack on 2026-11-03 (calls through the guard, voice-bridge e2e audio both ways,
|
||||
encrypted and not). Required changes, all on LXC 151:
|
||||
|
||||
1. **lk-jwt-service 0.9.0** (a Rust rewrite; fixes GHSA-rq24-fh66-rq7x). Existing env vars carry over.
|
||||
Add `LIVEKIT_SANITY_CHECK_INTERVAL_SECONDS=30`.
|
||||
2. **LiveKit webhook → lk-jwt.** 0.9.0 serves `/delegate_delayed_leave`, so Element Call hands it the
|
||||
job of removing a crashed client's call membership and sets its own fallback timer to **1 hour**.
|
||||
lk-jwt only learns that someone left from LiveKit webhooks; without them crashed clients linger for an
|
||||
hour (also on Discord, via the voice bridge). In `/etc/livekit/config.yaml`:
|
||||
```yaml
|
||||
webhook:
|
||||
api_key: <the key under keys:, same as LIVEKIT_KEY>
|
||||
urls:
|
||||
- http://127.0.0.1:8071/sfu_webhook
|
||||
```
|
||||
3. **`prometheus_port: 6789` → `prometheus: {port: 6789}`.** LiveKit 1.13.8 removed the old key (1.9.11
|
||||
already accepts the new one). Otherwise metrics and the *LiveKit Down* alert stop working.
|
||||
4. Restart lk-jwt-service only when no calls are active: its leave jobs are in memory (or set
|
||||
`LIVEKIT_REDIS_URL`). LiveKit: replace the binary and `touch /run/livekit-restart-pending`.
|
||||
|
||||
Not affected: TURN (external coturn with `ttl` set, as 1.13.1 requires), `room.auto_create: false`,
|
||||
the voice bridge (uses the legacy `/sfu/get`, still served).
|
||||
|
||||
## Synapse Upgrade Runbook
|
||||
|
||||
Synapse is installed from the **matrix.org apt repo** (`matrix-synapse-py3`) on **LXC 151** — it is
|
||||
@@ -946,6 +1122,7 @@ Checklist in this file.
|
||||
| PostgreSQL Down | `pg_up` < 1 for 2m | critical |
|
||||
| LiveKit Down | `up{job="livekit"}` < 1 for 2m | critical |
|
||||
| Hookshot Down | `up{job="hookshot"}` < 1 for 2m | critical |
|
||||
| Discord Bridge Down | `node_systemd_unit_state{name="mautrix-discord.service",state="active"}` < 1 (or no data) for 3m | critical |
|
||||
| Draupnir Down | `up{job="draupnir-node"}` < 0.5 for 2m | critical |
|
||||
| PG Connection Saturation | connections > 80% of max for 5m | warning |
|
||||
| Federation Queue Backing Up | pending PDUs > 100 for 10m | warning |
|
||||
@@ -1052,10 +1229,11 @@ All commands use the `!` prefix. Run `!help` in any room for the full list.
|
||||
| Database | PostgreSQL | 17.9 |
|
||||
| TURN | coturn | latest |
|
||||
| Video/voice calls | LiveKit SFU | 1.9.11 |
|
||||
| LiveKit JWT | lk-jwt-service | latest |
|
||||
| LiveKit JWT | lk-jwt-service | 0.4.1 (0.9.0 planned, see *Call stack upgrade*) |
|
||||
| Moderation | Draupnir | 2.9.0 |
|
||||
| SSO | Authelia (OIDC) + LLDAP | — |
|
||||
| Webhook bridge | matrix-hookshot | 7.3.2 |
|
||||
| Webhook bridge | matrix-hookshot | 7.5.0 |
|
||||
| Discord bridge | mautrix-discord | 0.7.7 |
|
||||
| Reverse proxy | Nginx Proxy Manager | — |
|
||||
| Web client | Lotus Cinny (fork of `cinnyapp/cinny` main) | custom |
|
||||
| Element Call embed | `@lotusguild/element-call-embedded` (self-built fork of `element-hq/element-call`) | 0.20.1-lotus.1 |
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
+56
-3
@@ -164,9 +164,62 @@ echo "[$(date '+%Y-%m-%d %H:%M:%S')] Deploying to $WEBROOT..."
|
||||
# still holding an older index.html (or service-worker precache) asks for its
|
||||
# assets/index-<old hash>.js, and deleting them on every deploy broke the app
|
||||
# for those users until their cached shell expired. Prune after 14 days.
|
||||
rsync -a --delete --exclude config.json --exclude assets/ dist/ "$WEBROOT/"
|
||||
rsync -a dist/assets/ "$WEBROOT/assets/"
|
||||
find "$WEBROOT/assets" -type f -mtime +14 -delete
|
||||
# The asset excludes are ANCHORED (leading /): an unanchored `assets/` also
|
||||
# matched public/element-call/assets/, so the call page's index.html was
|
||||
# updated while its hashed scripts never were, and calls failed to load.
|
||||
# config.json stays unanchored on purpose: public/element-call/config.json is
|
||||
# the production call config too.
|
||||
rsync -a --delete --exclude config.json \
|
||||
--exclude /assets/ --exclude /public/element-call/assets/ dist/ "$WEBROOT/"
|
||||
for dir in assets public/element-call/assets; do
|
||||
mkdir -p "$WEBROOT/$dir"
|
||||
rsync -a "dist/$dir/" "$WEBROOT/$dir/"
|
||||
find "$WEBROOT/$dir" -type f -mtime +14 -delete
|
||||
done
|
||||
|
||||
# Every script/stylesheet the app and call pages reference must exist in the
|
||||
# webroot. 2026-10-20: the call page's index.html pointed at scripts the deploy
|
||||
# never copied and calls failed to load; this check would have caught it.
|
||||
missing_assets() { # <index.html> <its directory>
|
||||
grep -oE '(src|href)="[^"]+\.(js|css)"' "$1" | sed -E 's/^(src|href)="//; s/"$//' |
|
||||
while read -r ref; do
|
||||
case "$ref" in
|
||||
http://*|https://*|//*) continue ;;
|
||||
/*) path="$WEBROOT$ref" ;;
|
||||
*) path="$2/${ref#./}" ;;
|
||||
esac
|
||||
[ -f "$path" ] || echo "$ref"
|
||||
done
|
||||
}
|
||||
deploy_alert() { # best effort: the upstream checker's Matrix credentials
|
||||
[ -r /etc/cinny-monitor.env ] || return 0
|
||||
(
|
||||
set -a
|
||||
# shellcheck source=/dev/null
|
||||
source /etc/cinny-monitor.env
|
||||
set +a
|
||||
_ALERT="$1" python3 - <<'PYEOF'
|
||||
import json, os, time, urllib.parse, urllib.request
|
||||
server = os.environ.get("MATRIX_SERVER", "").rstrip("/")
|
||||
room, token = os.environ.get("MATRIX_ROOM", ""), os.environ.get("MATRIX_TOKEN", "")
|
||||
if server and room and token:
|
||||
url = f"{server}/_matrix/client/v3/rooms/{urllib.parse.quote(room, safe='')}/send/m.room.message/deploy{int(time.time() * 1000)}"
|
||||
req = urllib.request.Request(url, method="PUT", data=json.dumps({"msgtype": "m.text", "body": os.environ["_ALERT"]}).encode(),
|
||||
headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"})
|
||||
try:
|
||||
urllib.request.urlopen(req, timeout=10)
|
||||
except Exception as exc:
|
||||
print(f"alert failed: {exc}")
|
||||
PYEOF
|
||||
) || true
|
||||
}
|
||||
MISSING=$(missing_assets "$WEBROOT/index.html" "$WEBROOT"; missing_assets "$WEBROOT/public/element-call/index.html" "$WEBROOT/public/element-call")
|
||||
if [ -n "$MISSING" ]; then
|
||||
echo "[$(date '+%Y-%m-%d %H:%M:%S')] ERROR: deployed pages reference missing files:"
|
||||
echo "$MISSING"
|
||||
deploy_alert "⚠️ Lotus Chat deploy ($VITE_APP_VERSION): the live pages reference files that are not on the server, so the app or calls may not load: $(echo "$MISSING" | tr '\n' ' ')"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "[$(date '+%Y-%m-%d %H:%M:%S')] ===== Deploy complete ($VITE_APP_VERSION) ====="
|
||||
|
||||
|
||||
@@ -7,6 +7,25 @@ map $uri $lotus_shell_cache_control {
|
||||
default "";
|
||||
}
|
||||
|
||||
# All traffic arrives through Nginx Proxy Manager (10.10.10.27), so without
|
||||
# realip every visitor shared ONE chat_limit bucket (20 r/s, keyed by
|
||||
# $binary_remote_addr = the proxy): a scanner burst got real users 503s.
|
||||
# Each server block below trusts X-Real-IP from the proxy only (NPM sets it
|
||||
# to the client address, overwriting anything the client sent).
|
||||
#
|
||||
# [matrix #22] Decorations get their own, larger budget: opening the profile
|
||||
# decoration picker can fetch hundreds of thumbnails, which would otherwise use
|
||||
# up chat_limit and 503 the app's own files.
|
||||
limit_req_zone $binary_remote_addr zone=decorations_limit:10m rate=100r/s;
|
||||
#
|
||||
# [cinny #201 follow-up] Content-hashed app files (js/css/fonts/images/wasm)
|
||||
# likewise: a cold page load fires ~75 requests within a second, and the
|
||||
# service worker precaches all ~126 build files at once (every deploy renames
|
||||
# them), both past chat_limit's burst of 60, so chunks 503ed and pages
|
||||
# rendered blank / the precache install failed. Immutable files, cheap to
|
||||
# serve; pages and the webhook keep chat_limit.
|
||||
limit_req_zone $binary_remote_addr zone=assets_limit:10m rate=100r/s;
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
listen [::]:80;
|
||||
@@ -23,6 +42,8 @@ server {
|
||||
server_tokens off;
|
||||
client_max_body_size 50m;
|
||||
|
||||
set_real_ip_from 10.10.10.27;
|
||||
real_ip_header X-Real-IP;
|
||||
limit_req zone=chat_limit burst=60 nodelay;
|
||||
limit_conn chat_conn 25;
|
||||
index index.html;
|
||||
@@ -72,6 +93,8 @@ server {
|
||||
}
|
||||
location ~* \.(?:js|css|woff2?|png|svg|ico|webp|wasm)$ {
|
||||
include snippets/cinny-security-headers-framed.conf;
|
||||
# Own budget (replaces the server-level chat_limit; see assets_limit).
|
||||
limit_req zone=assets_limit burst=400 nodelay;
|
||||
expires 1y;
|
||||
add_header Cache-Control "public, immutable" always;
|
||||
}
|
||||
@@ -80,6 +103,8 @@ server {
|
||||
# Cache content-addressed static assets aggressively
|
||||
location ~* \.(?:js|css|woff2?|png|svg|ico|webp)$ {
|
||||
include snippets/cinny-security-headers.conf;
|
||||
# Own budget (replaces the server-level chat_limit; see assets_limit).
|
||||
limit_req zone=assets_limit burst=400 nodelay;
|
||||
expires 1y;
|
||||
add_header Cache-Control "public, immutable" always;
|
||||
}
|
||||
@@ -113,6 +138,9 @@ server {
|
||||
# can be replaced in place under the same name, so a week, not immutable.
|
||||
location ^~ /decorations/ {
|
||||
alias /var/www/decorations/;
|
||||
# Replaces the server-level chat_limit here (nginx doesn't inherit
|
||||
# limit_req into a location that sets its own).
|
||||
limit_req zone=decorations_limit burst=700 nodelay;
|
||||
include snippets/cinny-security-headers.conf;
|
||||
add_header Cache-Control "public, max-age=604800" always;
|
||||
location ~ /MANIFEST\.sha256$ { return 404; }
|
||||
@@ -151,6 +179,8 @@ server {
|
||||
|
||||
root /var/www/html;
|
||||
server_tokens off;
|
||||
set_real_ip_from 10.10.10.27;
|
||||
real_ip_header X-Real-IP;
|
||||
limit_req zone=chat_limit burst=60 nodelay;
|
||||
limit_conn chat_conn 25;
|
||||
|
||||
@@ -171,6 +201,8 @@ server {
|
||||
}
|
||||
location ~* \.(?:js|css|woff2?|png|svg|ico|webp|wasm)$ {
|
||||
include snippets/cinny-security-headers-call.conf;
|
||||
# Own budget (replaces the server-level chat_limit; see assets_limit).
|
||||
limit_req zone=assets_limit burst=400 nodelay;
|
||||
expires 1y;
|
||||
add_header Cache-Control "public, immutable" always;
|
||||
}
|
||||
|
||||
@@ -1,18 +1,31 @@
|
||||
#!/bin/bash
|
||||
# Checks every 5 minutes if a livekit restart is pending.
|
||||
# Only restarts when there are no active WebSocket connections on port 7881
|
||||
# (established connections = active call participants).
|
||||
# Only restarts when LiveKit reports no participants AND nobody holds a
|
||||
# signalling connection, so a restart never drops a call.
|
||||
# Run by: livekit-graceful-restart.timer (systemd)
|
||||
|
||||
if [ ! -f /run/livekit-restart-pending ]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Count established WebSocket signaling connections on livekit port 7881
|
||||
ACTIVE=$(ss -tn state established '( dport = :7881 or sport = :7881 )' | grep -c ESTAB || true)
|
||||
# Participants LiveKit itself counts, across all rooms. Counting TCP connections
|
||||
# on :7881 (the old check) only saw clients on the ICE-TCP fallback: signalling
|
||||
# is on :7880 and media is normally UDP, so most calls looked idle.
|
||||
METRICS_URL="${LIVEKIT_METRICS_URL:-http://127.0.0.1:6789/metrics}"
|
||||
if ! METRICS=$(curl -sf --max-time 5 "$METRICS_URL") \
|
||||
|| ! printf '%s\n' "$METRICS" | grep -q '^livekit_participant_total'; then
|
||||
echo "$(date): Livekit restart pending but its metrics are unreadable — assuming a call is active, waiting."
|
||||
exit 0
|
||||
fi
|
||||
PARTICIPANTS=$(printf '%s\n' "$METRICS" | awk '/^livekit_participant_total/ {s += $NF} END {printf "%d", s}')
|
||||
|
||||
if [ "$ACTIVE" -gt 0 ]; then
|
||||
echo "$(date): Livekit restart pending but $ACTIVE active connection(s) — waiting."
|
||||
# Belt and braces: open signalling WebSockets (a client mid-join may not be a
|
||||
# participant yet). Count lines (-H drops the header): with a `state` filter ss
|
||||
# omits the State column, so the old `grep -c ESTAB` was always 0.
|
||||
SIGNALLING=$(ss -Htn state established '( sport = :7880 )' | wc -l)
|
||||
|
||||
if [ "$PARTICIPANTS" -gt 0 ] || [ "$SIGNALLING" -gt 0 ]; then
|
||||
echo "$(date): Livekit restart pending but $PARTICIPANTS participant(s), $SIGNALLING signalling connection(s) — waiting."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
|
||||
@@ -47,6 +47,13 @@ else
|
||||
echo "Restart pending — will apply when no active calls."
|
||||
fi
|
||||
|
||||
# The graceful-restart check itself (run by livekit-graceful-restart.timer)
|
||||
if echo "$CHANGED" | grep -q '^deploy/livekit-graceful-restart\.sh'; then
|
||||
echo "Deploying livekit-graceful-restart.sh..."
|
||||
bash -n "$REPO_DIR/deploy/livekit-graceful-restart.sh" \
|
||||
&& install -m755 "$REPO_DIR/deploy/livekit-graceful-restart.sh" /usr/local/bin/livekit-graceful-restart.sh
|
||||
fi
|
||||
|
||||
# Voice-limit / quality guard (fronts lk-jwt-service on :8070)
|
||||
if echo "$CHANGED" | grep -qE '^livekit/voice-limit-guard\.py|^systemd/voice-limit-guard\.service'; then
|
||||
echo "Deploying voice-limit-guard..."
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
@@ -0,0 +1,386 @@
|
||||
# Homeserver details.
|
||||
homeserver:
|
||||
# The address that this appservice can use to connect to the homeserver.
|
||||
address: http://127.0.0.1:8008
|
||||
# The domain of the homeserver (also known as server_name, used for MXIDs, etc).
|
||||
domain: matrix.lotusguild.org
|
||||
|
||||
# What software is the homeserver running?
|
||||
# Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
|
||||
software: standard
|
||||
# The URL to push real-time bridge status to.
|
||||
# If set, the bridge will make POST requests to this URL whenever a user's discord connection state changes.
|
||||
# The bridge will use the appservice as_token to authorize requests.
|
||||
status_endpoint: null
|
||||
# Endpoint for reporting per-message status.
|
||||
message_send_checkpoint_endpoint: null
|
||||
# Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
|
||||
async_media: false
|
||||
|
||||
# Should the bridge use a websocket for connecting to the homeserver?
|
||||
# The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
|
||||
# mautrix-asmux (deprecated), and hungryserv (proprietary).
|
||||
websocket: false
|
||||
# How often should the websocket be pinged? Pinging will be disabled if this is zero.
|
||||
ping_interval_seconds: 0
|
||||
|
||||
# Application service host/registration related details.
|
||||
# Changing these values requires regeneration of the registration.
|
||||
appservice:
|
||||
# The address that the homeserver can use to connect to this appservice.
|
||||
address: http://127.0.0.1:29334
|
||||
|
||||
# The hostname and port where this appservice should listen.
|
||||
hostname: 0.0.0.0
|
||||
port: 29334
|
||||
|
||||
# Database config.
|
||||
database:
|
||||
# The database type. "sqlite3-fk-wal" and "postgres" are supported.
|
||||
type: postgres
|
||||
# The database URI.
|
||||
# SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
|
||||
# https://github.com/mattn/go-sqlite3#connection-string
|
||||
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
|
||||
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
|
||||
# Password is filled in on the server by install.sh; never commit it.
|
||||
uri: postgres://mautrix_discord:DB_PASSWORD@10.10.10.44/mautrix_discord?sslmode=disable
|
||||
# Maximum number of connections. Mostly relevant for Postgres.
|
||||
max_open_conns: 20
|
||||
max_idle_conns: 2
|
||||
# Maximum connection idle time and lifetime before they're closed. Disabled if null.
|
||||
# Parsed with https://pkg.go.dev/time#ParseDuration
|
||||
max_conn_idle_time: null
|
||||
max_conn_lifetime: null
|
||||
|
||||
# The unique ID of this appservice.
|
||||
id: discord
|
||||
# Appservice bot details.
|
||||
bot:
|
||||
# Username of the appservice bot.
|
||||
username: discordbot
|
||||
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
||||
# to leave display name/avatar as-is.
|
||||
displayname: Discord Bridge
|
||||
avatar: mxc://maunium.net/nIdEykemnwdisvHbpxflpDlC
|
||||
|
||||
# Whether or not to receive ephemeral events via appservice transactions.
|
||||
# Requires MSC2409 support (i.e. Synapse 1.22+).
|
||||
ephemeral_events: true
|
||||
|
||||
# Should incoming events be handled asynchronously?
|
||||
# This may be necessary for large public instances with lots of messages going through.
|
||||
# However, messages will not be guaranteed to be bridged in the same order they were sent in.
|
||||
async_transactions: false
|
||||
|
||||
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
||||
as_token: "This value is generated when generating the registration"
|
||||
hs_token: "This value is generated when generating the registration"
|
||||
|
||||
# Bridge config
|
||||
bridge:
|
||||
# Localpart template of MXIDs for Discord users.
|
||||
# {{.}} is replaced with the internal ID of the Discord user.
|
||||
username_template: discord_{{.}}
|
||||
# Displayname template for Discord users. This is also used as the room name in DMs if private_chat_portal_meta is enabled.
|
||||
# Available variables:
|
||||
# .ID - Internal user ID
|
||||
# .Username - Legacy display/username on Discord
|
||||
# .GlobalName - New displayname on Discord
|
||||
# .Discriminator - The 4 numbers after the name on Discord
|
||||
# .Bot - Whether the user is a bot
|
||||
# .System - Whether the user is an official system user
|
||||
# .Webhook - Whether the user is a webhook and is not an application
|
||||
# .Application - Whether the user is an application
|
||||
displayname_template: '{{if .Webhook}}Webhook{{else}}{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}}{{end}}'
|
||||
# Displayname template for Discord channels (bridged as rooms, or spaces when type=4).
|
||||
# Available variables:
|
||||
# .Name - Channel name, or user displayname (pre-formatted with displayname_template) in DMs.
|
||||
# .ParentName - Parent channel name (used for categories).
|
||||
# .GuildName - Guild name.
|
||||
# .NSFW - Whether the channel is marked as NSFW.
|
||||
# .Type - Channel type (see values at https://github.com/bwmarrin/discordgo/blob/v0.25.0/structs.go#L251-L267)
|
||||
channel_name_template: '{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}'
|
||||
# Displayname template for Discord guilds (bridged as spaces).
|
||||
# Available variables:
|
||||
# .Name - Guild name
|
||||
guild_name_template: '{{.Name}}'
|
||||
# Whether to explicitly set the avatar and room name for private chat portal rooms.
|
||||
# If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms.
|
||||
# If set to `always`, all DM rooms will have explicit names and avatars set.
|
||||
# If set to `never`, DM rooms will never have names and avatars set.
|
||||
private_chat_portal_meta: default
|
||||
|
||||
# Publicly accessible base URL that Discord can use to reach the bridge, used for avatars in relay mode.
|
||||
# If not set, avatars will not be bridged. Only the /mautrix-discord/avatar/{server}/{id}/{hash} endpoint is used on this address.
|
||||
# This should not have a trailing slash, the endpoint above will be appended to the provided address.
|
||||
public_address: https://matrix.lotusguild.org
|
||||
# A random key used to sign the avatar URLs. The bridge will only accept requests with a valid signature.
|
||||
avatar_proxy_key: generate
|
||||
|
||||
portal_message_buffer: 128
|
||||
|
||||
# Number of private channel portals to create on bridge startup.
|
||||
# Other portals will be created when receiving messages.
|
||||
startup_private_channel_create_limit: 5
|
||||
# Should the bridge send a read receipt from the bridge bot when a message has been sent to Discord?
|
||||
delivery_receipts: false
|
||||
# Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
|
||||
message_status_events: false
|
||||
# Whether the bridge should send error notices via m.notice events when a message fails to bridge.
|
||||
message_error_notices: true
|
||||
# Should the bridge use space-restricted join rules instead of invite-only for guild rooms?
|
||||
# This can avoid unnecessary invite events in guild rooms when members are synced in.
|
||||
restricted_rooms: false
|
||||
# Should the bridge automatically join the user to threads on Discord when the thread is opened on Matrix?
|
||||
# This only works with clients that support thread read receipts (MSC3771 added in Matrix v1.4).
|
||||
autojoin_thread_on_open: true
|
||||
# Should inline fields in Discord embeds be bridged as HTML tables to Matrix?
|
||||
# Tables aren't supported in all clients, but are the only way to emulate the Discord inline field UI.
|
||||
embed_fields_as_tables: true
|
||||
# Should guild channels be muted when the portal is created? This only meant for single-user instances,
|
||||
# it won't mute it for all users if there are multiple Matrix users in the same Discord guild.
|
||||
mute_channels_on_create: false
|
||||
# Should the bridge update the m.direct account data event when double puppeting is enabled.
|
||||
# Note that updating the m.direct event is not atomic (except with mautrix-asmux)
|
||||
# and is therefore prone to race conditions.
|
||||
sync_direct_chat_list: false
|
||||
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
|
||||
# This field will automatically be changed back to false after it, except if the config file is not writable.
|
||||
resend_bridge_info: false
|
||||
# Should incoming custom emoji reactions be bridged as mxc:// URIs?
|
||||
# If set to false, custom emoji reactions will be bridged as the shortcode instead, and the image won't be available.
|
||||
custom_emoji_reactions: true
|
||||
# Should the bridge attempt to completely delete portal rooms when a channel is deleted on Discord?
|
||||
# If true, the bridge will try to kick Matrix users from the room. Otherwise, the bridge only makes ghosts leave.
|
||||
delete_portal_on_channel_delete: false
|
||||
# Should the bridge delete all portal rooms when you leave a guild on Discord?
|
||||
# This only applies if the guild has no other Matrix users on this bridge instance.
|
||||
delete_guild_on_leave: true
|
||||
# Whether or not created rooms should have federation enabled.
|
||||
# If false, created portal rooms will never be federated.
|
||||
federate_rooms: true
|
||||
# Prefix messages from webhooks with the profile info? This can be used along with a custom displayname_template
|
||||
# to better handle webhooks that change their name all the time (like ones used by bridges).
|
||||
#
|
||||
# This will use the fallback mode in MSC4144, which means clients that support MSC4144 will not show the prefix
|
||||
# (and will instead show the name and avatar as the message sender).
|
||||
prefix_webhook_messages: true
|
||||
# Bridge webhook avatars?
|
||||
enable_webhook_avatars: false
|
||||
# Should the bridge upload media to the Discord CDN directly before sending the message when using a user token,
|
||||
# like the official client does? The other option is sending the media in the message send request as a form part
|
||||
# (which is always used by bots and webhooks).
|
||||
use_discord_cdn_upload: true
|
||||
# Should the bridge forbid direct messages from users to other users who they aren't friends with? Discord generally
|
||||
# considers this to be a "risky" action. Note that the bridge will conservatively reject all outgoing DMs from users
|
||||
# until it has synced that user's relationships from Discord.
|
||||
forbid_dming_strangers: true
|
||||
# Proxy for Discord connections
|
||||
proxy:
|
||||
# Should mxc uris copied from Discord be cached?
|
||||
# This can be `never` to never cache, `unencrypted` to only cache unencrypted mxc uris, or `always` to cache everything.
|
||||
# If you have a media repo that generates non-unique mxc uris, you should set this to never.
|
||||
cache_media: unencrypted
|
||||
# Settings for converting Discord media to custom mxc:// URIs instead of reuploading.
|
||||
# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
|
||||
direct_media:
|
||||
# Should custom mxc:// URIs be used instead of reuploading media?
|
||||
enabled: false
|
||||
# The server name to use for the custom mxc:// URIs.
|
||||
# This server name will effectively be a real Matrix server, it just won't implement anything other than media.
|
||||
# You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
|
||||
server_name: discord-media.example.com
|
||||
# Optionally a custom .well-known response. This defaults to `server_name:443`
|
||||
well_known_response:
|
||||
# The bridge supports MSC3860 media download redirects and will use them if the requester supports it.
|
||||
# Optionally, you can force redirects and not allow proxying at all by setting this to false.
|
||||
allow_proxy: true
|
||||
# Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
|
||||
# This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
|
||||
server_key: generate
|
||||
# Settings for converting animated stickers.
|
||||
animated_sticker:
|
||||
# Format to which animated stickers should be converted.
|
||||
# disable - No conversion, send as-is (lottie JSON)
|
||||
# png - converts to non-animated png (fastest)
|
||||
# gif - converts to animated gif
|
||||
# webm - converts to webm video, requires ffmpeg executable with vp9 codec and webm container support
|
||||
# webp - converts to animated webp, requires ffmpeg executable with webp codec/container support
|
||||
target: webp
|
||||
# Arguments for converter. All converters take width and height.
|
||||
args:
|
||||
width: 320
|
||||
height: 320
|
||||
fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended)
|
||||
# Servers to always allow double puppeting from
|
||||
double_puppet_server_map:
|
||||
example.com: https://example.com
|
||||
# Allow using double puppeting from any server with a valid client .well-known file.
|
||||
double_puppet_allow_discovery: false
|
||||
# Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth
|
||||
#
|
||||
# If set, double puppeting will be enabled automatically for local users
|
||||
# instead of users having to find an access token and run `login-matrix`
|
||||
# manually.
|
||||
login_shared_secret_map:
|
||||
example.com: foobar
|
||||
|
||||
# The prefix for commands. Only required in non-management rooms.
|
||||
command_prefix: '!discord'
|
||||
# Messages sent upon joining a management room.
|
||||
# Markdown is supported. The defaults are listed below.
|
||||
management_room_text:
|
||||
# Sent when joining a room.
|
||||
welcome: "Hello, I'm a Discord bridge bot."
|
||||
# Sent when joining a management room and the user is already logged in.
|
||||
welcome_connected: "Use `help` for help."
|
||||
# Sent when joining a management room and the user is not logged in.
|
||||
welcome_unconnected: "Use `help` for help or `login` to log in."
|
||||
# Optional extra text sent when joining a management room.
|
||||
additional_help: ""
|
||||
|
||||
# Settings for backfilling messages.
|
||||
backfill:
|
||||
# Limits for forward backfilling.
|
||||
forward_limits:
|
||||
# Initial backfill (when creating portal). 0 means backfill is disabled.
|
||||
# A special unlimited value is not supported, you must set a limit. Initial backfill will
|
||||
# fetch all messages first before backfilling anything, so high limits can take a lot of time.
|
||||
initial:
|
||||
dm: 0
|
||||
channel: 0
|
||||
thread: 0
|
||||
# Missed message backfill (on startup).
|
||||
# 0 means backfill is disabled, -1 means fetch all messages since last bridged message.
|
||||
# When using unlimited backfill (-1), messages are backfilled as they are fetched.
|
||||
# With limits, all messages up to the limit are fetched first and backfilled afterwards.
|
||||
missed:
|
||||
dm: 0
|
||||
channel: -1
|
||||
thread: 0
|
||||
# Maximum members in a guild to enable backfilling. Set to -1 to disable limit.
|
||||
# This can be used as a rough heuristic to disable backfilling in channels that are too active.
|
||||
# Currently only applies to missed message backfill.
|
||||
max_guild_members: -1
|
||||
|
||||
# End-to-bridge encryption support options.
|
||||
#
|
||||
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
|
||||
encryption:
|
||||
# Allow encryption, work in group chat rooms with e2ee enabled
|
||||
allow: true
|
||||
# Default to encryption, force-enable encryption in all portals the bridge creates
|
||||
# This will cause the bridge bot to be in private chats for the encryption to work properly.
|
||||
default: false
|
||||
# Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
|
||||
# Changing this option requires updating the appservice registration file.
|
||||
appservice: false
|
||||
# Whether to use MSC4190 instead of appservice login to create the bridge bot device.
|
||||
# Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
|
||||
# Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
|
||||
# Changing this option requires updating the appservice registration file.
|
||||
msc4190: false
|
||||
# Require encryption, drop any unencrypted messages.
|
||||
require: false
|
||||
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
|
||||
# You must use a client that supports requesting keys from other users to use this feature.
|
||||
allow_key_sharing: false
|
||||
# Should users mentions be in the event wire content to enable the server to send push notifications?
|
||||
plaintext_mentions: false
|
||||
# Options for deleting megolm sessions from the bridge.
|
||||
delete_keys:
|
||||
# Beeper-specific: delete outbound sessions when hungryserv confirms
|
||||
# that the user has uploaded the key to key backup.
|
||||
delete_outbound_on_ack: false
|
||||
# Don't store outbound sessions in the inbound table.
|
||||
dont_store_outbound: false
|
||||
# Ratchet megolm sessions forward after decrypting messages.
|
||||
ratchet_on_decrypt: false
|
||||
# Delete fully used keys (index >= max_messages) after decrypting messages.
|
||||
delete_fully_used_on_decrypt: false
|
||||
# Delete previous megolm sessions from same device when receiving a new one.
|
||||
delete_prev_on_new_session: false
|
||||
# Delete megolm sessions received from a device when the device is deleted.
|
||||
delete_on_device_delete: false
|
||||
# Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
|
||||
periodically_delete_expired: false
|
||||
# Delete inbound megolm sessions that don't have the received_at field used for
|
||||
# automatic ratcheting and expired session deletion. This is meant as a migration
|
||||
# to delete old keys prior to the bridge update.
|
||||
delete_outdated_inbound: false
|
||||
# What level of device verification should be required from users?
|
||||
#
|
||||
# Valid levels:
|
||||
# unverified - Send keys to all device in the room.
|
||||
# cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
|
||||
# cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
|
||||
# cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
|
||||
# Note that creating user signatures from the bridge bot is not currently possible.
|
||||
# verified - Require manual per-device verification
|
||||
# (currently only possible by modifying the `trust` column in the `crypto_device` database table).
|
||||
verification_levels:
|
||||
# Minimum level for which the bridge should send keys to when bridging messages from WhatsApp to Matrix.
|
||||
receive: unverified
|
||||
# Minimum level that the bridge should accept for incoming Matrix messages.
|
||||
send: unverified
|
||||
# Minimum level that the bridge should require for accepting key requests.
|
||||
share: cross-signed-tofu
|
||||
# Options for Megolm room key rotation. These options allow you to
|
||||
# configure the m.room.encryption event content. See:
|
||||
# https://spec.matrix.org/v1.3/client-server-api/#mroomencryption for
|
||||
# more information about that event.
|
||||
rotation:
|
||||
# Enable custom Megolm room key rotation settings. Note that these
|
||||
# settings will only apply to rooms created after this option is
|
||||
# set.
|
||||
enable_custom: false
|
||||
# The maximum number of milliseconds a session should be used
|
||||
# before changing it. The Matrix spec recommends 604800000 (a week)
|
||||
# as the default.
|
||||
milliseconds: 604800000
|
||||
# The maximum number of messages that should be sent with a given a
|
||||
# session before changing it. The Matrix spec recommends 100 as the
|
||||
# default.
|
||||
messages: 100
|
||||
|
||||
# Disable rotating keys when a user's devices change?
|
||||
# You should not enable this option unless you understand all the implications.
|
||||
disable_device_change_key_rotation: false
|
||||
|
||||
# Settings for provisioning API
|
||||
provisioning:
|
||||
# Prefix for the provisioning API paths.
|
||||
prefix: /_matrix/provision
|
||||
# Shared secret for authentication. If set to "generate", a random secret will be generated,
|
||||
# or if set to "disable", the provisioning API will be disabled.
|
||||
shared_secret: generate
|
||||
# Enable debug API at /debug with provisioning authentication.
|
||||
debug_endpoints: false
|
||||
|
||||
# Permissions for using the bridge.
|
||||
# Permitted values:
|
||||
# relay - Talk through the relaybot (if enabled), no access otherwise
|
||||
# user - Access to use the bridge to chat with a Discord account.
|
||||
# admin - User level and some additional administration tools
|
||||
# Permitted keys:
|
||||
# * - All Matrix users
|
||||
# domain - All users on that homeserver
|
||||
# mxid - Specific user
|
||||
permissions:
|
||||
"*": relay
|
||||
"matrix.lotusguild.org": user
|
||||
"@jared:matrix.lotusguild.org": admin
|
||||
|
||||
# Logging config. See https://github.com/tulir/zeroconfig for details.
|
||||
logging:
|
||||
min_level: info
|
||||
writers:
|
||||
- type: stdout
|
||||
format: pretty-colored
|
||||
- type: file
|
||||
format: json
|
||||
filename: /var/log/mautrix-discord/mautrix-discord.log
|
||||
max_size: 100
|
||||
max_backups: 10
|
||||
compress: true
|
||||
Executable
+103
@@ -0,0 +1,103 @@
|
||||
#!/bin/bash
|
||||
# One-time install of the mautrix-discord bridge.
|
||||
# Run on the Proxmox node that hosts LXC 109 (PostgreSQL) and LXC 151 (Synapse):
|
||||
# pct exec 151 -- cat /opt/matrix-config/discord-bridge/install.sh | bash
|
||||
# Needs this repo's main branch already pulled to /opt/matrix-config on LXC 151
|
||||
# (the auto-deploy does that). Restarts Synapse once (~30-60s of downtime).
|
||||
# Safe to re-run: existing database, user, config and registration are kept.
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="v0.7.7"
|
||||
SHA256="1f3b6953b4eae00d141ce706f6e97c1b5d0e50268a447bc605df2fa4f44c5d9d"
|
||||
PG_CT=109
|
||||
SYNAPSE_CT=151
|
||||
SYNAPSE_IP="10.10.10.29"
|
||||
|
||||
# Only used if the database role does not exist yet; never printed.
|
||||
DB_PASSWORD="$(openssl rand -hex 24 </dev/null)"
|
||||
|
||||
echo "== [1/3] PostgreSQL (LXC $PG_CT): role, database, pg_hba =="
|
||||
pct exec "$PG_CT" -- bash -s "$DB_PASSWORD" "$SYNAPSE_IP" <<'PG'
|
||||
set -euo pipefail
|
||||
PW="$1"; SRC="$2"
|
||||
HBA=/etc/postgresql/17/main/pg_hba.conf
|
||||
if su postgres -c "psql -Atc \"select 1 from pg_roles where rolname='mautrix_discord'\"" | grep -q 1; then
|
||||
echo "role mautrix_discord exists, keeping it"
|
||||
echo "EXISTS" > /root/.mautrix-discord-role-existed
|
||||
else
|
||||
su postgres -c "psql -v ON_ERROR_STOP=1 -q" <<SQL
|
||||
CREATE ROLE mautrix_discord LOGIN PASSWORD '$PW';
|
||||
SQL
|
||||
rm -f /root/.mautrix-discord-role-existed
|
||||
fi
|
||||
if ! su postgres -c "psql -Atc \"select 1 from pg_database where datname='mautrix_discord'\"" | grep -q 1; then
|
||||
su postgres -c "psql -v ON_ERROR_STOP=1 -q -c \"CREATE DATABASE mautrix_discord OWNER mautrix_discord ENCODING 'UTF8' LC_COLLATE 'C' LC_CTYPE 'C' TEMPLATE template0\""
|
||||
fi
|
||||
if ! grep -q '^host *mautrix_discord ' "$HBA"; then
|
||||
cp "$HBA" "$HBA.bak-$(date +%Y%m%d%H%M%S)-discord"
|
||||
sed -i "/^host *synapse *synapse_user/a host mautrix_discord mautrix_discord $SRC/32 scram-sha-256" "$HBA"
|
||||
fi
|
||||
su postgres -c "psql -Atqc 'select pg_reload_conf()'" >/dev/null
|
||||
echo "ok"
|
||||
PG
|
||||
|
||||
ROLE_EXISTED=$(pct exec "$PG_CT" -- sh -c 'test -f /root/.mautrix-discord-role-existed && echo yes || echo no' </dev/null)
|
||||
|
||||
echo "== [2/3] Bridge (LXC $SYNAPSE_CT): binary, config, registration, service =="
|
||||
pct exec "$SYNAPSE_CT" -- bash -s "$DB_PASSWORD" "$ROLE_EXISTED" "$VERSION" "$SHA256" <<'BR'
|
||||
set -euo pipefail
|
||||
PW="$1"; ROLE_EXISTED="$2"; VERSION="$3"; SHA256="$4"
|
||||
DIR=/opt/mautrix-discord
|
||||
SRC=/opt/matrix-config
|
||||
id mautrix-discord >/dev/null 2>&1 || useradd --system --home "$DIR" --shell /usr/sbin/nologin mautrix-discord
|
||||
mkdir -p "$DIR" /var/log/mautrix-discord
|
||||
|
||||
curl -fsSL -o "$DIR/mautrix-discord.new" "https://github.com/mautrix/discord/releases/download/$VERSION/mautrix-discord-amd64"
|
||||
echo "$SHA256 $DIR/mautrix-discord.new" | sha256sum -c -
|
||||
chmod 755 "$DIR/mautrix-discord.new"
|
||||
mv "$DIR/mautrix-discord.new" "$DIR/mautrix-discord"
|
||||
|
||||
if [ ! -f "$DIR/config.yaml" ]; then
|
||||
if [ "$ROLE_EXISTED" = yes ]; then
|
||||
echo "ERROR: DB role already existed but there is no config; set the password in $DIR/config.yaml by hand" >&2
|
||||
exit 1
|
||||
fi
|
||||
sed "s/DB_PASSWORD/$PW/" "$SRC/discord-bridge/config.yaml" > "$DIR/config.yaml"
|
||||
fi
|
||||
if [ ! -f "$DIR/registration.yaml" ]; then
|
||||
(cd "$DIR" && ./mautrix-discord -g -c config.yaml -r registration.yaml)
|
||||
fi
|
||||
chown -R mautrix-discord:mautrix-discord "$DIR" /var/log/mautrix-discord
|
||||
chmod 600 "$DIR/config.yaml"
|
||||
install -m 640 -o root -g matrix-synapse "$DIR/registration.yaml" /etc/matrix-synapse/discord-registration.yaml
|
||||
|
||||
install -m 644 "$SRC/systemd/mautrix-discord.service" /etc/systemd/system/mautrix-discord.service
|
||||
systemctl daemon-reload
|
||||
|
||||
HS=/etc/matrix-synapse/homeserver.yaml
|
||||
if ! grep -q discord-registration.yaml "$HS"; then
|
||||
cp "$HS" "$HS.bak-$(date +%Y%m%d%H%M%S)-discord"
|
||||
sed -i '/^ - \/etc\/matrix-synapse\/hookshot-registration.yaml/a \ - /etc/matrix-synapse/discord-registration.yaml' "$HS"
|
||||
fi
|
||||
grep -A3 '^app_service_config_files' "$HS"
|
||||
echo "ok"
|
||||
BR
|
||||
|
||||
echo "== [3/3] Restart Synapse, start bridge =="
|
||||
pct exec "$SYNAPSE_CT" -- bash -s <<'RS'
|
||||
set -euo pipefail
|
||||
systemctl restart matrix-synapse
|
||||
for i in $(seq 1 60); do
|
||||
curl -fsS -o /dev/null http://127.0.0.1:8008/health && break
|
||||
sleep 2
|
||||
done
|
||||
curl -fsS http://127.0.0.1:8008/health && echo " (synapse healthy)"
|
||||
systemctl enable --now mautrix-discord
|
||||
sleep 5
|
||||
systemctl --no-pager --lines=15 status mautrix-discord
|
||||
RS
|
||||
|
||||
pct exec "$PG_CT" -- rm -f /root/.mautrix-discord-role-existed </dev/null
|
||||
echo
|
||||
echo "Done. In Lotus Chat, start a DM with @discordbot:matrix.lotusguild.org and send:"
|
||||
echo " login-token bot <your new bot token>"
|
||||
Executable
+34
@@ -0,0 +1,34 @@
|
||||
#!/bin/bash
|
||||
# Gives @discordbot the Discord logo and the display name "Discord Bridge".
|
||||
# Run inside LXC 151 (from the Proxmox node):
|
||||
# pct exec 151 -- bash /opt/matrix-config/discord-bridge/set-bot-profile.sh
|
||||
# Uploads bot-avatar.png as the bridge bot, points config.yaml at it and
|
||||
# restarts the bridge, which applies the profile on startup. Safe to re-run.
|
||||
set -euo pipefail
|
||||
|
||||
DIR=/opt/mautrix-discord
|
||||
CFG="$DIR/config.yaml"
|
||||
AVATAR=/opt/matrix-config/discord-bridge/bot-avatar.png
|
||||
BOT="@discordbot:matrix.lotusguild.org"
|
||||
|
||||
AS_TOKEN=$(awk '/^as_token:/ {gsub(/"/, "", $2); print $2; exit}' "$DIR/registration.yaml")
|
||||
[ -n "$AS_TOKEN" ] || { echo "no as_token in $DIR/registration.yaml" >&2; exit 1; }
|
||||
|
||||
MXC=$(curl -fsS -X POST \
|
||||
-H "Authorization: Bearer $AS_TOKEN" \
|
||||
-H "Content-Type: image/png" \
|
||||
--data-binary "@$AVATAR" \
|
||||
"http://127.0.0.1:8008/_matrix/media/v3/upload?filename=discord.png&user_id=${BOT/@/%40}" |
|
||||
python3 -c 'import json, sys; print(json.load(sys.stdin)["content_uri"])')
|
||||
echo "uploaded $MXC"
|
||||
|
||||
# Only the bot block's two lines; the 8-space indent is unique to appservice.bot.
|
||||
sed -i -E \
|
||||
-e 's|^( displayname: ).*$|\1Discord Bridge|' \
|
||||
-e "s|^( avatar: )mxc://.*$|\1$MXC|" \
|
||||
"$CFG"
|
||||
grep -A7 '^ bot:' "$CFG"
|
||||
|
||||
systemctl restart mautrix-discord
|
||||
sleep 3
|
||||
systemctl is-active mautrix-discord
|
||||
@@ -77,4 +77,13 @@ if (event === 'ticket_created') {
|
||||
html = '[tinker-tickets] event: <code>' + event + '</code> ticket #' + id;
|
||||
}
|
||||
|
||||
result = { version: 'v2', plain: plain, html: html, msgtype: 'm.text' };
|
||||
// Explicit mentions (m.mentions): from Synapse 1.164 the legacy push rules
|
||||
// that pinged on a user ID or display name in the body are off by default
|
||||
// (MSC4210), so the people to notify must be listed here.
|
||||
result = {
|
||||
version: 'v2',
|
||||
plain: plain,
|
||||
html: html,
|
||||
msgtype: 'm.text',
|
||||
mentions: { user_ids: notifyUsers }
|
||||
};
|
||||
@@ -417,3 +417,118 @@ class SlotReservationTests(unittest.TestCase):
|
||||
r = guard.SlotReservations()
|
||||
self.assertIs(r.room_lock("a"), r.room_lock("a"))
|
||||
self.assertIsNot(r.room_lock("a"), r.room_lock("b"))
|
||||
|
||||
|
||||
def _p(identity, joined_ms):
|
||||
return {"identity": identity, "joined_at_ms": str(joined_ms),
|
||||
"permission": {"canPublish": True, "canPublishSources": ["MICROPHONE"]}}
|
||||
|
||||
|
||||
class TestOverLimitRemovals(unittest.TestCase):
|
||||
"""[matrix #25] connect-time enforcement of the voice limit."""
|
||||
|
||||
def test_first_sweep_records_and_removes_nobody(self):
|
||||
parts = [_p("@a:x:DEV1", 1), _p("@b:x:DEV1", 2)]
|
||||
removals, seen = guard.over_limit_removals(parts, 1, None)
|
||||
self.assertEqual(removals, [])
|
||||
self.assertEqual(seen, {"@a:x", "@b:x"})
|
||||
|
||||
def test_a_newcomer_past_the_limit_is_removed_with_all_devices(self):
|
||||
parts = [_p("@a:x:DEV1", 1), _p("@b:x:DEV1", 5), _p("@b:x:DEV2", 6)]
|
||||
removals, seen = guard.over_limit_removals(parts, 1, {"@a:x"})
|
||||
self.assertEqual(sorted(removals), ["@b:x:DEV1", "@b:x:DEV2"])
|
||||
self.assertEqual(seen, {"@a:x"})
|
||||
|
||||
def test_newest_newcomers_go_first(self):
|
||||
parts = [_p("@a:x:D", 1), _p("@b:x:D", 10), _p("@c:x:D", 20)]
|
||||
removals, _ = guard.over_limit_removals(parts, 2, {"@a:x"})
|
||||
self.assertEqual(removals, ["@c:x:D"])
|
||||
|
||||
def test_lowering_the_limit_mid_call_kicks_nobody(self):
|
||||
parts = [_p("@a:x:D", 1), _p("@b:x:D", 2), _p("@c:x:D", 3)]
|
||||
removals, seen = guard.over_limit_removals(parts, 1, {"@a:x", "@b:x", "@c:x"})
|
||||
self.assertEqual(removals, [])
|
||||
self.assertEqual(seen, {"@a:x", "@b:x", "@c:x"})
|
||||
|
||||
def test_extra_devices_of_a_present_user_are_not_newcomers(self):
|
||||
parts = [_p("@a:x:DEV1", 1), _p("@a:x:DEV2", 9)]
|
||||
removals, _ = guard.over_limit_removals(parts, 1, {"@a:x"})
|
||||
self.assertEqual(removals, [])
|
||||
|
||||
def test_no_limit_removes_nobody(self):
|
||||
parts = [_p("@a:x:D", 1), _p("@b:x:D", 2)]
|
||||
self.assertEqual(guard.over_limit_removals(parts, 0, {"@a:x"})[0], [])
|
||||
|
||||
def test_joined_at_seconds_are_understood(self):
|
||||
parts = [{"identity": "@a:x:D", "joined_at": "100"}, {"identity": "@b:x:D", "joined_at": "200"},
|
||||
{"identity": "@c:x:D", "joinedAt": "150"}]
|
||||
removals, _ = guard.over_limit_removals(parts, 1, set())
|
||||
self.assertEqual(sorted(removals), ["@b:x:D", "@c:x:D"])
|
||||
|
||||
|
||||
class TestReconcileRoomLimit(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self._orig = (guard.room_state, guard.livekit_list_participants,
|
||||
guard.livekit_update_participant, guard.livekit_remove_participant)
|
||||
self.removed, self.updates = [], []
|
||||
guard.livekit_remove_participant = lambda a, i: self.removed.append(i)
|
||||
guard.livekit_update_participant = lambda a, i, p: self.updates.append(i)
|
||||
guard._seen_users.clear()
|
||||
|
||||
def tearDown(self):
|
||||
(guard.room_state, guard.livekit_list_participants,
|
||||
guard.livekit_update_participant, guard.livekit_remove_participant) = self._orig
|
||||
guard._seen_users.clear()
|
||||
|
||||
def test_a_late_connect_with_an_early_token_is_removed(self):
|
||||
guard.room_state = lambda rid, max_age=0: {"max_users": 1, "allow_screenshare": True, "allow_camera": True}
|
||||
guard.livekit_list_participants = lambda a: [_p("@a:x:D", 1)]
|
||||
guard.reconcile_room("alias", "!room:x") # first sweep: @a is there
|
||||
self.assertEqual(self.removed, [])
|
||||
guard.livekit_list_participants = lambda a: [_p("@a:x:D", 1), _p("@late:x:D", 50)]
|
||||
guard.reconcile_room("alias", "!room:x")
|
||||
self.assertEqual(self.removed, ["@late:x:D"])
|
||||
self.assertEqual(self.updates, []) # nothing forbidden in this room
|
||||
|
||||
def test_unlimited_unrestricted_room_is_not_listed(self):
|
||||
guard.room_state = lambda rid, max_age=0: {"max_users": 0, "allow_screenshare": True, "allow_camera": True}
|
||||
guard.livekit_list_participants = lambda a: (_ for _ in ()).throw(AssertionError("listed"))
|
||||
guard.reconcile_room("alias", "!room:x")
|
||||
self.assertEqual(self.removed, [])
|
||||
|
||||
|
||||
class LimitExemptTests(unittest.TestCase):
|
||||
"""A voice bridge's bot listens in the call but isn't a person."""
|
||||
|
||||
BOT = "@lotus-voice_bot:matrix.lotusguild.org"
|
||||
GHOST = "@lotus-voice_1565220670265360514:matrix.lotusguild.org"
|
||||
|
||||
def setUp(self):
|
||||
self._saved = guard.LIMIT_EXEMPT
|
||||
guard.LIMIT_EXEMPT = guard.re.compile(r"@lotus-voice_bot:matrix\.lotusguild\.org")
|
||||
|
||||
def tearDown(self):
|
||||
guard.LIMIT_EXEMPT = self._saved
|
||||
|
||||
def test_bot_does_not_use_a_slot(self):
|
||||
self.assertFalse(guard.should_block(2, {"@a:x", self.BOT}, "@b:x"))
|
||||
self.assertTrue(guard.should_block(2, {"@a:x", "@c:x", self.BOT}, "@b:x"))
|
||||
|
||||
def test_bot_is_never_blocked(self):
|
||||
self.assertFalse(guard.should_block(1, {"@a:x"}, self.BOT))
|
||||
|
||||
def test_relayed_discord_speakers_still_count(self):
|
||||
self.assertTrue(guard.should_block(2, {"@a:x", self.GHOST}, "@b:x"))
|
||||
|
||||
def test_reconcile_never_removes_or_counts_the_bot(self):
|
||||
parts = [
|
||||
{"identity": "@a:x:D1", "joined_at_ms": 1},
|
||||
{"identity": self.BOT + ":voice-1", "joined_at_ms": 3},
|
||||
]
|
||||
removals, users = guard.over_limit_removals(parts, 1, {"@a:x"})
|
||||
self.assertEqual(removals, [])
|
||||
self.assertEqual(users, {"@a:x"})
|
||||
|
||||
def test_no_exemption_configured_counts_everyone(self):
|
||||
guard.LIMIT_EXEMPT = None
|
||||
self.assertTrue(guard.should_block(2, {"@a:x", self.BOT}, "@b:x"))
|
||||
@@ -52,6 +52,7 @@ import hashlib
|
||||
import hmac
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import threading
|
||||
import time
|
||||
import urllib.error
|
||||
@@ -72,6 +73,11 @@ MATRIX_TOKEN = os.environ.get("MATRIX_TOKEN", "")
|
||||
# from participants who joined BEFORE a policy tightened. New joins are already
|
||||
# handled by the JWT re-sign at issue time; this closes the mid-call-flip gap.
|
||||
RECONCILE_ENABLED = os.environ.get("GUARD_RECONCILE", "1") not in ("0", "false", "")
|
||||
# Matrix users the participant limit ignores (full-match regex), e.g. a voice
|
||||
# bridge's own bot, which joins the call to listen but is not a person. The
|
||||
# Discord speakers the bridge relays (its ghost users) are people and still count.
|
||||
_EXEMPT = os.environ.get("VOICE_LIMIT_EXEMPT_USERS", "")
|
||||
LIMIT_EXEMPT = re.compile(_EXEMPT) if _EXEMPT else None
|
||||
# Floor the interval so a misconfigured 0 can't busy-loop the admin/Synapse APIs.
|
||||
RECONCILE_INTERVAL = max(0.5, float(os.environ.get("GUARD_RECONCILE_INTERVAL", "3.0")))
|
||||
|
||||
@@ -131,18 +137,26 @@ def room_id_from_request(path: str, data: dict) -> str:
|
||||
return data.get("room") or ""
|
||||
|
||||
|
||||
def limit_exempt(user: str) -> bool:
|
||||
"""True for users the participant limit ignores (VOICE_LIMIT_EXEMPT_USERS)."""
|
||||
return bool(LIMIT_EXEMPT and user and LIMIT_EXEMPT.fullmatch(user))
|
||||
|
||||
|
||||
def should_block(limit: int, present_users: set, requester: str) -> bool:
|
||||
"""Pure decision: should this token be refused?
|
||||
|
||||
- limit <= 0 -> never block (no limit configured)
|
||||
- requester exempt -> never block (e.g. a bridge's bot)
|
||||
- requester already present -> never block (rejoin / extra device)
|
||||
- distinct users >= limit -> block
|
||||
- distinct non-exempt users >= limit -> block
|
||||
"""
|
||||
if limit <= 0:
|
||||
return False
|
||||
if limit_exempt(requester):
|
||||
return False
|
||||
if requester and requester in present_users:
|
||||
return False
|
||||
return len(present_users) >= limit
|
||||
return len({u for u in present_users if not limit_exempt(u)}) >= limit
|
||||
|
||||
|
||||
# [matrix #25] Tokens issued but not yet connected weren't counted, so two
|
||||
@@ -405,6 +419,7 @@ def remember_room(alias: str, room_id: str) -> None:
|
||||
def forget_room(alias: str) -> None:
|
||||
with _alias_lock:
|
||||
_alias_to_room.pop(alias, None)
|
||||
_seen_users.pop(alias, None)
|
||||
|
||||
|
||||
def forbidden_sources(policy: dict) -> set:
|
||||
@@ -451,6 +466,65 @@ def normalize_permission(perm: dict) -> dict:
|
||||
return out
|
||||
|
||||
|
||||
def _joined_at(participant: dict) -> float:
|
||||
"""When this device joined, in ms (ParticipantInfo joined_at_ms, else s)."""
|
||||
for key in ("joined_at_ms", "joinedAtMs"):
|
||||
if participant.get(key) not in (None, "", 0, "0"):
|
||||
return float(participant[key])
|
||||
for key in ("joined_at", "joinedAt"):
|
||||
if participant.get(key) not in (None, "", 0, "0"):
|
||||
return float(participant[key]) * 1000.0
|
||||
return 0.0
|
||||
|
||||
|
||||
def over_limit_removals(participants: list, limit: int, seen):
|
||||
"""[matrix #25] Pure: which devices to remove so the room is back within
|
||||
its limit, and the set of users now known to be in the room.
|
||||
|
||||
Only users who ARRIVED since the previous sweep (not in `seen`) can be
|
||||
removed, newest first: a token fetched while there was space can be used
|
||||
to connect up to an hour later, past the limit, but lowering the limit
|
||||
mid-call must not kick people already there. Users are distinct Matrix
|
||||
users (matrix_user), so a person's extra devices never count twice, and
|
||||
removing a user removes all their devices. `seen is None` means the room
|
||||
hasn't been swept yet: record it, remove nobody.
|
||||
"""
|
||||
first_join = {}
|
||||
identities = {}
|
||||
for p in participants:
|
||||
identity = p.get("identity") or ""
|
||||
user = matrix_user(identity)
|
||||
if not user or limit_exempt(user):
|
||||
continue
|
||||
identities.setdefault(user, []).append(identity)
|
||||
joined = _joined_at(p)
|
||||
first_join[user] = min(first_join.get(user, joined), joined)
|
||||
users = set(first_join)
|
||||
if seen is None or limit <= 0 or len(users) <= limit:
|
||||
return [], users
|
||||
newcomers = sorted(
|
||||
(u for u in users if u not in seen),
|
||||
key=lambda u: (first_join[u], u),
|
||||
reverse=True,
|
||||
)
|
||||
removed = newcomers[: len(users) - limit]
|
||||
return [i for u in removed for i in identities[u]], users - set(removed)
|
||||
|
||||
|
||||
def livekit_remove_participant(alias: str, identity: str) -> None:
|
||||
"""Disconnect a participant (livekit RemoveParticipant). Already gone ->
|
||||
Twirp not_found (HTTP 404), which is benign."""
|
||||
try:
|
||||
_livekit_admin_post(alias, "RemoveParticipant", {"room": alias, "identity": identity})
|
||||
except urllib.error.HTTPError as exc:
|
||||
if exc.code != 404:
|
||||
log(f"remove_participant {identity} in {alias} -> HTTP {exc.code}")
|
||||
|
||||
|
||||
# alias -> set of users present at the previous sweep (see over_limit_removals)
|
||||
_seen_users = {}
|
||||
|
||||
|
||||
def reconcile_participant(alias: str, participant: dict, forbidden: set) -> bool:
|
||||
"""Enforce the forbidden-source policy on one live participant. Returns True
|
||||
if an UpdateParticipant call was issued."""
|
||||
@@ -483,8 +557,10 @@ def reconcile_room(alias: str, room_id: str) -> None:
|
||||
# Read the policy fresh-ish so a flip is picked up within ~one interval.
|
||||
policy = room_state(room_id, max_age=RECONCILE_INTERVAL)
|
||||
forbidden = forbidden_sources(policy)
|
||||
if not forbidden:
|
||||
return # nothing restricted; leave permissions untouched
|
||||
limit = int(policy.get("max_users", 0) or 0)
|
||||
if not forbidden and limit <= 0:
|
||||
_seen_users.pop(alias, None)
|
||||
return # nothing restricted; leave the room alone
|
||||
try:
|
||||
participants = livekit_list_participants(alias)
|
||||
except urllib.error.HTTPError as exc:
|
||||
@@ -501,7 +577,18 @@ def reconcile_room(alias: str, room_id: str) -> None:
|
||||
# empty_timeout). Don't forget on an empty read — only a 404 (room gone)
|
||||
# prunes — so a transient empty/race can't drop mid-call enforcement.
|
||||
return
|
||||
# [matrix #25] Connect-time limit: the token check alone can't stop a token
|
||||
# fetched earlier (valid for an hour) from being used once the room is full.
|
||||
removals, now_seen = over_limit_removals(participants, limit, _seen_users.get(alias))
|
||||
_seen_users[alias] = now_seen
|
||||
for identity in removals:
|
||||
livekit_remove_participant(alias, identity)
|
||||
log(f"removed {identity} from {alias}: over the voice limit of {limit}")
|
||||
if not forbidden:
|
||||
return
|
||||
for p in participants:
|
||||
if p.get("identity") in removals:
|
||||
continue
|
||||
try:
|
||||
reconcile_participant(alias, p, forbidden)
|
||||
except Exception as exc:
|
||||
|
||||
@@ -2273,7 +2273,9 @@ async def cmd_roast(client: AsyncClient, room_id: str, sender: str, args: str):
|
||||
f'<blockquote>{roast}</blockquote>'
|
||||
f'<sup><em>via {_model_label(CREATIVE_MODEL)}</em></sup>'
|
||||
)
|
||||
await send_html(client, room_id, plain, html)
|
||||
# Ping the person being roasted when they were named by Matrix ID.
|
||||
target_id = target_raw if re.fullmatch(r"@[^\s:]+:[^\s]+", target_raw) else None
|
||||
await send_html(client, room_id, plain, html, mention_user_ids=[target_id] if target_id else None)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
+15
-7
@@ -70,17 +70,25 @@ async def send_text(client: AsyncClient, room_id: str, text: str):
|
||||
return resp
|
||||
|
||||
|
||||
async def send_html(client: AsyncClient, room_id: str, plain: str, html: str):
|
||||
async def send_html(
|
||||
client: AsyncClient, room_id: str, plain: str, html: str, mention_user_ids: list[str] | None = None
|
||||
):
|
||||
logger = logging.getLogger("matrixbot")
|
||||
content = {
|
||||
"msgtype": "m.text",
|
||||
"body": plain,
|
||||
"format": "org.matrix.custom.html",
|
||||
"formatted_body": html,
|
||||
}
|
||||
# Explicit mentions (m.mentions). From Synapse 1.164 a name or user ID in
|
||||
# the body no longer pings anyone (MSC4210), so a message that should
|
||||
# notify someone has to say so.
|
||||
if mention_user_ids:
|
||||
content["m.mentions"] = {"user_ids": mention_user_ids}
|
||||
resp = await _room_send_trusted(
|
||||
client, room_id,
|
||||
message_type="m.room.message",
|
||||
content={
|
||||
"msgtype": "m.text",
|
||||
"body": plain,
|
||||
"format": "org.matrix.custom.html",
|
||||
"formatted_body": html,
|
||||
},
|
||||
content=content,
|
||||
)
|
||||
if not isinstance(resp, RoomSendResponse):
|
||||
logger.error("send_html failed: %s", resp)
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
[Unit]
|
||||
Description=Lotus voice bridge (Discord voice <-> Matrix calls, nether-voicebridge)
|
||||
After=network-online.target matrix-synapse.service
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=lotus-voice
|
||||
Group=lotus-voice
|
||||
Environment=CONFIG_PATH=/etc/lotus-voice/config.toml
|
||||
Environment=RUST_LOG=info
|
||||
ExecStart=/opt/lotus-voice/lotus-voice-bridge
|
||||
ExecReload=/bin/kill -HUP $MAINPID
|
||||
Restart=on-failure
|
||||
RestartSec=10
|
||||
StandardOutput=journal
|
||||
StandardError=journal
|
||||
SyslogIdentifier=lotus-voice-bridge
|
||||
|
||||
# Resource limits (Opus encode/decode + LiveKit + Discord voice per call)
|
||||
MemoryMax=1G
|
||||
CPUQuota=150%
|
||||
|
||||
# Hardening
|
||||
NoNewPrivileges=yes
|
||||
ProtectSystem=strict
|
||||
ProtectHome=yes
|
||||
PrivateTmp=yes
|
||||
ReadWritePaths=/var/lib/lotus-voice /etc/lotus-voice
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
@@ -0,0 +1,30 @@
|
||||
[Unit]
|
||||
Description=mautrix-discord Matrix-Discord bridge
|
||||
After=network-online.target matrix-synapse.service
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=mautrix-discord
|
||||
Group=mautrix-discord
|
||||
WorkingDirectory=/opt/mautrix-discord
|
||||
ExecStart=/opt/mautrix-discord/mautrix-discord -c /opt/mautrix-discord/config.yaml -r /opt/mautrix-discord/registration.yaml
|
||||
Restart=on-failure
|
||||
RestartSec=10
|
||||
StandardOutput=journal
|
||||
StandardError=journal
|
||||
SyslogIdentifier=mautrix-discord
|
||||
|
||||
# Resource limits
|
||||
MemoryMax=512M
|
||||
CPUQuota=80%
|
||||
|
||||
# Hardening
|
||||
NoNewPrivileges=yes
|
||||
ProtectSystem=strict
|
||||
ProtectHome=yes
|
||||
PrivateTmp=yes
|
||||
ReadWritePaths=/opt/mautrix-discord /var/log/mautrix-discord
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
@@ -19,6 +19,8 @@ Environment=GUARD_BIND_PORT=8070
|
||||
Environment=GUARD_UPSTREAM=http://127.0.0.1:8071
|
||||
Environment=LIVEKIT_API=http://127.0.0.1:7880
|
||||
Environment=SYNAPSE_API=http://127.0.0.1:8008
|
||||
# The voice bridge's bot listens in calls but is not a person (Discord speakers still count).
|
||||
Environment=VOICE_LIMIT_EXEMPT_USERS=@lotus-voice_bot:matrix\\.lotusguild\\.org
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
@@ -0,0 +1,41 @@
|
||||
# Lotus Guild voice bridge (nether-voicebridge, Lotus-patched build) — LXC 151.
|
||||
# Rendered by voice-bridge/install.sh into /etc/lotus-voice/config.toml (0600).
|
||||
# @AS_TOKEN@ and @PUPPET_TOKENS@ are filled in on the server; never commit them.
|
||||
|
||||
data_dir = "/var/lib/lotus-voice"
|
||||
|
||||
[server.lotus]
|
||||
homeserver_url = "http://127.0.0.1:8008"
|
||||
# MXIDs and .well-known discovery (https://matrix.lotusguild.org) use this domain.
|
||||
matrix_domain = "matrix.lotusguild.org"
|
||||
# Bot = @lotus-voice_bot, Discord speakers = @lotus-voice_<discord id>.
|
||||
sender_localpart = "lotus-voice"
|
||||
appservice_id = "lotus-voice"
|
||||
appservice_token = "@AS_TOKEN@"
|
||||
|
||||
[puppets]
|
||||
# Lotus Voice 1–3 (Discord apps 1565219639640858746 / 1565220427297722378 /
|
||||
# 1565220532830470207). One per Matrix person speaking at the same time.
|
||||
tokens = [@PUPPET_TOKENS@]
|
||||
nickname_prefix = "[Matrix] "
|
||||
|
||||
[[bridge]]
|
||||
name = "discord-voice-bridge"
|
||||
server = "lotus"
|
||||
# Matrix: "Discord Voice Bridge" voice room.
|
||||
room_id = "!yS_ZIHL3sOKQJBt4NiIQyiHKt3cv6HrIDeq7OxDpSM0"
|
||||
[bridge.discord]
|
||||
# Lotus Guild server, voice channel "matrix-bridge".
|
||||
guild_id = "1565159371355197570"
|
||||
channel_id = "1565159372122882071"
|
||||
[bridge.matrix]
|
||||
# Shown as a call participant in encrypted calls (it receives the media keys).
|
||||
bot_display_name = "Discord Voice Bridge"
|
||||
bot_avatar_path = "/opt/lotus-voice/avatar.png"
|
||||
|
||||
# Lotus: leave Discord promptly after the last Matrix person leaves
|
||||
# (upstream defaults 12 s + 90 s). 8 s still covers Element Call's 2-3 s membership flaps.
|
||||
# The bridge logs a "NON-DEFAULT TIMING PROFILE" warning for this; it's expected.
|
||||
[timing]
|
||||
leave_grace_ms = 8000
|
||||
anchor_idle_grace_ms = 10000
|
||||
Executable
+87
@@ -0,0 +1,87 @@
|
||||
#!/bin/bash
|
||||
# One-time install / upgrade of the Lotus voice bridge on LXC 151.
|
||||
# Run on the Proxmox node hosting LXC 151 (and LXC 109 is not needed: the bridge
|
||||
# keeps its state in sqlite under /var/lib/lotus-voice):
|
||||
#
|
||||
# bash install.sh <path to lotus-voice-bridge binary> <secrets file>
|
||||
#
|
||||
# The secrets file holds the three Lotus Voice bot tokens as BOT1=…, BOT2=…, BOT3=…
|
||||
# (shell syntax); it is copied in, used to render the config, then deleted.
|
||||
# Needs this repo's main pulled to /opt/matrix-config on LXC 151 (auto-deploy).
|
||||
# First install restarts Synapse once (new appservice registration). Re-running
|
||||
# with only a new binary just swaps it and restarts the bridge. Safe to re-run.
|
||||
set -euo pipefail
|
||||
|
||||
BIN=${1:?usage: install.sh <binary> <secrets file>}
|
||||
SECRETS=${2:?usage: install.sh <binary> <secrets file>}
|
||||
CT=151
|
||||
[ -x "$BIN" ] || { echo "binary not found/executable: $BIN" >&2; exit 1; }
|
||||
|
||||
echo "== [1/4] copy binary + secrets into LXC $CT"
|
||||
pct push "$CT" "$BIN" /root/lotus-voice-bridge.new --perms 0755
|
||||
pct push "$CT" "$SECRETS" /root/lotus-voice.secrets --perms 0600
|
||||
|
||||
echo "== [2/4] install files, user, config, registration"
|
||||
pct exec "$CT" -- bash -s <<'IN'
|
||||
set -euo pipefail
|
||||
SRC=/opt/matrix-config
|
||||
id lotus-voice >/dev/null 2>&1 || useradd --system --home /var/lib/lotus-voice --shell /usr/sbin/nologin lotus-voice
|
||||
install -d -o lotus-voice -g lotus-voice -m 0750 /var/lib/lotus-voice /etc/lotus-voice
|
||||
install -d -m 0755 /opt/lotus-voice
|
||||
mv /root/lotus-voice-bridge.new /opt/lotus-voice/lotus-voice-bridge
|
||||
install -m 0644 "$SRC/discord-bridge/bot-avatar.png" /opt/lotus-voice/avatar.png
|
||||
|
||||
REG=/etc/matrix-synapse/lotus-voice-registration.yaml
|
||||
if [ ! -f "$REG" ]; then
|
||||
AS=$(openssl rand -hex 32); HS=$(openssl rand -hex 32)
|
||||
sed -e "s/@AS_TOKEN@/$AS/" -e "s/@HS_TOKEN@/$HS/" "$SRC/voice-bridge/registration.yaml.template" > "$REG"
|
||||
chown root:matrix-synapse "$REG"; chmod 0640 "$REG"
|
||||
echo "registration written"
|
||||
fi
|
||||
AS=$(awk '/^as_token:/ {gsub(/"/, "", $2); print $2; exit}' "$REG")
|
||||
|
||||
set -a; . /root/lotus-voice.secrets; set +a
|
||||
rm -f /root/lotus-voice.secrets
|
||||
for v in BOT1 BOT2 BOT3; do [ -n "${!v:-}" ] || { echo "secrets file is missing $v" >&2; exit 1; }; done
|
||||
TOKENS="\"$BOT1\", \"$BOT2\", \"$BOT3\""
|
||||
umask 077
|
||||
sed -e "s/@AS_TOKEN@/$AS/" -e "s|@PUPPET_TOKENS@|$TOKENS|" "$SRC/voice-bridge/config.toml.template" > /etc/lotus-voice/config.toml
|
||||
unset BOT1 BOT2 BOT3 TOKENS
|
||||
chown lotus-voice:lotus-voice /etc/lotus-voice/config.toml
|
||||
install -m 0644 "$SRC/systemd/lotus-voice-bridge.service" /etc/systemd/system/lotus-voice-bridge.service
|
||||
systemctl daemon-reload
|
||||
echo "files ok"
|
||||
IN
|
||||
|
||||
echo "== [3/4] register with Synapse (restart only if newly added)"
|
||||
pct exec "$CT" -- bash -s <<'RS'
|
||||
set -euo pipefail
|
||||
HSY=/etc/matrix-synapse/homeserver.yaml
|
||||
if grep -q lotus-voice-registration.yaml "$HSY"; then
|
||||
echo "already registered — no Synapse restart"
|
||||
else
|
||||
cp "$HSY" "$HSY.bak-$(date +%Y%m%d%H%M%S)-voicebridge"
|
||||
sed -i '/^ - \/etc\/matrix-synapse\/discord-registration.yaml/a \ - /etc/matrix-synapse/lotus-voice-registration.yaml' "$HSY"
|
||||
grep -A4 '^app_service_config_files' "$HSY"
|
||||
systemctl restart matrix-synapse
|
||||
for i in $(seq 1 60); do curl -fsS -o /dev/null http://127.0.0.1:8008/health && break; sleep 2; done
|
||||
curl -fsS http://127.0.0.1:8008/health && echo " (synapse healthy)"
|
||||
fi
|
||||
# Create the bot account now so it can be invited before the bridge first starts.
|
||||
AS=$(awk '/^as_token:/ {gsub(/"/, "", $2); print $2; exit}' /etc/matrix-synapse/lotus-voice-registration.yaml)
|
||||
curl -sS -X POST -H "Authorization: Bearer $AS" -H 'Content-Type: application/json' \
|
||||
-d '{"type":"m.login.application_service","username":"lotus-voice_bot","inhibit_login":true}' \
|
||||
http://127.0.0.1:8008/_matrix/client/v3/register | grep -qE 'user_id|M_USER_IN_USE' && echo "bot account @lotus-voice_bot ready"
|
||||
RS
|
||||
|
||||
echo "== [4/4] (re)start the bridge"
|
||||
pct exec "$CT" -- bash -s <<'ST'
|
||||
set -euo pipefail
|
||||
systemctl enable lotus-voice-bridge >/dev/null 2>&1
|
||||
systemctl restart lotus-voice-bridge
|
||||
sleep 8
|
||||
systemctl --no-pager --lines=0 status lotus-voice-bridge | head -5
|
||||
journalctl -u lotus-voice-bridge --since "-15 sec" --no-pager -o cat | grep -E "puppet connected|initial call snapshot|LiveKit focus|bridge failed|ERROR" | sed -E 's/\x1b\[[0-9;]*m//g' | cut -c1-160 | head -10
|
||||
ST
|
||||
echo
|
||||
echo "Done. In Lotus, invite @lotus-voice_bot:matrix.lotusguild.org to the Discord Voice Bridge room."
|
||||
@@ -0,0 +1,15 @@
|
||||
# Synapse appservice registration for the voice bridge. Rendered by install.sh to
|
||||
# /etc/matrix-synapse/lotus-voice-registration.yaml with fresh random tokens.
|
||||
# The bridge talks to Synapse only as a client (as_token + ?user_id=), so no URL.
|
||||
id: lotus-voice
|
||||
url: null
|
||||
as_token: "@AS_TOKEN@"
|
||||
hs_token: "@HS_TOKEN@"
|
||||
sender_localpart: lotus-voice_as
|
||||
namespaces:
|
||||
users:
|
||||
- exclusive: true
|
||||
regex: "@lotus-voice_.*:matrix\\.lotusguild\\.org"
|
||||
aliases: []
|
||||
rooms: []
|
||||
rate_limited: false
|
||||
Reference in new issue
Block a user