diff --git a/deploy/matrix/README.md b/deploy/matrix/README.md index e8d687a..4166989 100644 --- a/deploy/matrix/README.md +++ b/deploy/matrix/README.md @@ -49,8 +49,11 @@ Entra だけ(Tuwunel の `[[global.identity_provider]]`)。パスワードのロ なので、権限は最上位で外されない - **暗号化していない。** hookshot は暗号化したルームに書けない。暗号化を後から入れると戻せないので、入れないこと (Element は非公開のルームを既定で暗号化するので、作るときに切る) -- webhook は [hookshot.yaml](hookshot.yaml) の `connections`。URL は `https://m.doany.io/webhook/` で、ID は - [secrets.sops.yaml](secrets.sops.yaml) の `matrix` の `hook-<部屋>`(公開のリポジトリなので平文では置かない) +- webhook の置き場は 2 通り。URL はどちらも `https://m.doany.io/webhook/` + - **静的な接続**: [hookshot.yaml](hookshot.yaml) の `connections`。ID は [secrets.sops.yaml](secrets.sops.yaml) の `matrix` の + `hook-<部屋>`(公開のリポジトリなので平文では置かない)。変換のスクリプト(Slack の attachments など)が要るものと、gitops の中のもの + - **ルームの state**: 部屋で `!hookshot webhook <名前>` を打って作る(下の「webhook」)。gitops には何も書かないので、 + gitops の外のアプリはこちらにする(アプリを消しても gitops を直さなくてよい)。今は `denpa` - **投稿は全部 m.notice(bot の発言)**。通知と音は Element の設定で決める: グループの会話は「音あり」、bot のメッセージは「オン」(音無しで通知)、要らない部屋は部屋ごとに「メンションのみ」。 @@ -62,12 +65,31 @@ Entra だけ(Tuwunel の `[[global.identity_provider]]`)。パスワードのロ | `ashi` | ashi | ashi のリポジトリの `deploy/secrets.sops.yaml`(`ashi-secrets` の `notify-webhook-url`) | | `todoroku` | todoroku | todoroku のリポジトリの `deploy/secrets.sops.yaml`(`todoroku-secrets` の `mattermost-webhook-url`) | | `worklog` | worklog | worklog のリポジトリの `deploy/secrets.sops.yaml`(`worklog-secrets` の `mattermost-webhook-url`) | -| `denpa` | denpa | denpa の DB(`webhooks` テーブル。画面の設定) | +| `denpa` | denpa(webhook はルームの state) | denpa の DB(`webhooks` テーブル。画面の設定) | | `forgejo` | Forgejo | Forgejo の組織 `doa` の webhook(種類は Slack。DB の `webhook` id 2) | | `contact` | doany.io のお問い合わせフォーム(danything/corp) | corp のリポジトリの `deploy/secrets.sops.yaml`(`corp-secrets` の `contact-webhook-url`) | -足すとき:ルームを暗号化なしで作り、hookshot を招待して権限を上げる → secrets.sops.yaml に `hook-<部屋>` を足す(`sops edit`) → -`connections` と render の env に足す。 +足すとき:ルームを暗号化なしで作り、hookshot を招待して権限を上げる → 下の「webhook」で作る。 +静的な接続にするときだけ、secrets.sops.yaml に `hook-<部屋>` を足し(`sops edit`)、`connections` と render の env に足す。 + +### webhook(ルームの state) + +hookshot の汎用の webhook はルームの state(`uk.half-shot.matrix-hookshot.generic.hook`、state key は名前)に置ける。 +ID(URL の秘密の部分)は hookshot の bot の room account data にあり、Tuwunel の DB(VolSync で取っている)に残るので、 +Redis が無くても再起動で変わらない(hookshot の `src/Connections/GenericHook.ts`)。 + +- **作る**: 部屋で `!hookshot webhook <名前>`(3〜64 文字)。部屋には「See admin room for secret url.」とだけ返り、 + **URL は管理用の部屋に届く**。それを送り元(アプリの設定など)に入れる。本文 `{"text": …}` はそのまま m.notice で投稿される +- **消す**: `!hookshot webhook remove <名前>`。一覧は `!hookshot webhook list`(名前だけ。URL は出ない) +- **作り直すときは、必ず先に remove する。** 同じ名前でもう一度 `!hookshot webhook <名前>` を打つと、1 つの名前に ID が 2 つできる。 + 再起動のあとどちらの URL が効くかは account data の並び順で決まり、選べない +- **管理用の部屋**は `@info:doany.io` と `@hookshot:doany.io` の暗号化なしの DM。hookshot は起動するときに、 + account data に `admin_user` のある部屋を管理用の部屋として読む。1 人に 1 つだけにしておく(複数あると、どれに届くか選べない) + - **DM を招待で作ったときは、hookshot を再起動するまで管理用の部屋にならない。** hookshot は招待に入ってから account data を書くが、 + 管理用の部屋にするかは入った時点で見るため(`src/Bridge.ts` の `onRoomInvite`・`onRoomJoin`)。それまでは `help` などにも答えない。 + 再起動は hookshot.yaml の ConfigMap を変える PR で起こす(Reloader が入れ替える) + - 古い管理用の部屋を自分が抜けていても、hookshot はそこに URL を送り続ける(相手がまだ居るかを見ない)。 + 使わなくなった管理用の部屋は、Tuwunel の管理用の部屋で `!admin users force-leave-room @hookshot:doany.io <部屋の ID>` で hookshot を出してから再起動する ## GitHub 連携(hookshot) diff --git a/deploy/matrix/hookshot.yaml b/deploy/matrix/hookshot.yaml index 7e77f4c..3a1f130 100644 --- a/deploy/matrix/hookshot.yaml +++ b/deploy/matrix/hookshot.yaml @@ -57,7 +57,8 @@ data: services: - service: "*" level: admin - # 通知のルームごとの webhook。 + # 通知のルームごとの webhook(静的な接続)。gitops の外のアプリの webhook はここに書かず、ルームの state に置く + # (`!hookshot webhook <名前>`。README「webhook」)。アプリを消しても gitops を直さなくてよい。 # stateKey は推測されない乱数で、secrets.sops.yaml の matrix の hook-<部屋>(公開のリポジトリなので平文では置かない)。 # 下の render が HOOK_ で始まる変数(stateKey)を差し替える。 # @@ -115,13 +116,6 @@ data: state: name: worklog transformationFunction: *slack - # 部屋 denpa: denpa(録画の節目) - - connectionType: uk.half-shot.matrix-hookshot.generic.hook - stateKey: ${HOOK_DENPA} - roomId: "!CQd-N3QSuFJdX04nG7hg90kLuVi86uXrxOQXgva1oMs" - state: - name: denpa - transformationFunction: *slack # 部屋 forgejo: Forgejo の組織 doa の webhook(種類は Slack) - connectionType: uk.half-shot.matrix-hookshot.generic.hook stateKey: ${HOOK_FORGEJO} @@ -227,8 +221,6 @@ spec: valueFrom: {secretKeyRef: {name: matrix, key: hook-todoroku}} - name: HOOK_WORKLOG valueFrom: {secretKeyRef: {name: matrix, key: hook-worklog}} - - name: HOOK_DENPA - valueFrom: {secretKeyRef: {name: matrix, key: hook-denpa}} - name: HOOK_FORGEJO valueFrom: {secretKeyRef: {name: matrix, key: hook-forgejo}} - name: HOOK_CONTACT diff --git a/deploy/matrix/secrets.sops.yaml b/deploy/matrix/secrets.sops.yaml index 57e3f14..32aa215 100644 --- a/deploy/matrix/secrets.sops.yaml +++ b/deploy/matrix/secrets.sops.yaml @@ -21,7 +21,6 @@ spec: hook-ashi: ENC[AES256_GCM,data:niviVb7h2V6HQtTc6alPKhlLoIW6VZWfbvQLm0FxFQ+UFHpXUCklAZl0HKnIFOUl,iv:cmkIloOzXhnErW5Qfwvh2QVlDzQGVjtC28byfKPhd88=,tag:qHCENtoYzVAxDseYc6QILA==,type:str] hook-cloudflare: ENC[AES256_GCM,data:EuyZEzyXCMI8Ab9Ogh2NZU6JIerJrQSmUjL/Y5NY74OAD0Uy+ivi7wy8lW/MEQyb,iv:C72joWascJa+zMAgA/UI7gxh52a5q4NY7Esyy8H5efc=,tag:QWLYyd3XG84L2xthfLmHyg==,type:str] hook-contact: ENC[AES256_GCM,data:yKDtxoeU3rI7r0IVr6hA3Wz8l3Evyd3QdwgjZj4Spo3cKMYj4FkXJlHvUyf6X0dR,iv:GZL/f5vd9s3w/lCNQcHFJa7MsbUUgue4885zBBrVe7o=,tag:gE+ftwBS4tLAFn6OvGHpgQ==,type:str] - hook-denpa: ENC[AES256_GCM,data:fc1dRNG4eQPjhvK2p06fNT6eyFvHj5sxeywePNIwmPZWR7AjNpwV7DVvCNWxD0TY,iv:PZU/jZnyb65fVQnVZmTKtxcZ6zd3zHXoQ4D8oGGdT+g=,tag:SHpZk2VLhTTeUPpWYVExAA==,type:str] hook-forgejo: ENC[AES256_GCM,data:lBa0/9wmzkfUb+iSWu98dZwco651QhsjD6C86Xw3QLRVOHxFPA70Tpe92pm24d3s,iv:wGFlhHA5T/px2mEgU8HFQcLI/PJ3pNI3SWLogNdJhz4=,tag:39uLuwGPeNXH49FQpmbFaw==,type:str] hook-server: ENC[AES256_GCM,data:GFXv4n1A7CujipdIlCWNNcIG2FWOGC1lFkhH1hLQt58YwLW+hPpR12H9ahFELNDn,iv:wSK/q4Cu/uoW91P2ScFR9pXVsHHAHmak75zCPBMaf4Y=,tag:0HZUTVIOgoeH8Oi6iIIBzg==,type:str] hook-todoroku: ENC[AES256_GCM,data:/t935bBlWPgAxZZeQ1km0M/D/1nCRhqndUy7N76QccloQIY6dvroQiVY5XE9jHhu,iv:lFXUD3uUR/+PDrBfviQuigF+b5TI6QqOzS/TwcJFWq4=,tag:ZIzYECtkA2b+1CeZjYBk/g==,type:str] @@ -59,7 +58,7 @@ sops: -----END AGE ENCRYPTED FILE----- recipient: age1z36xmmvjmwg4sus6k8nx6wgp8qyew7tj76077rvv5sagcgudd4tszrmwml encrypted_regex: ^(data|stringData)$ - lastmodified: "2026-11-02T07:27:03Z" - mac: ENC[AES256_GCM,data:JgaGj5qMWeQqG63uk2gjzBBS9yrzBTf0nF1R6s5xpjGb/go53Zx4q++XX4sOZKHvH3ow1/Wr2mRnl1iySH6yNJczqwQkdqfML0WGTdtY5mAJCXEsuOA/6lqmSc+1yJx/BGmCxHt933JyRJjlx0Tdv4AgprNv2UUlshPUdYz7T4I=,iv:aEljV22VyF2C5wDstLCb1AHDFz/uZfOcW7AgGinJuzc=,tag:KyMKyWMOkXnFRzIByzQt1w==,type:str] + lastmodified: "2026-11-15T14:12:37Z" + mac: ENC[AES256_GCM,data:mLUAUjGA5E6pEYwDSt4Q6yuJrffx6V+uuN3bDZAYM7NhOykc2ghvRWxEhOD/C1WyOCV7u37cYgUYH9LfhcaEKJPBNW2cEcbRp6fYD4zPavSRIleqw5g8vqDWNeFqnWnQWHSTgyUGS3J7X2zTQEXVSPUTrmzLAIULHSBfyeXeWiY=,iv:o+u4sHIkG55eNDNgJ/IcWfbagEjXZRweLQnzzbMWInM=,tag:y6qoDAltLWh+QOlP+VSzrA==,type:str] mac_only_encrypted: true version: 3.13.3