Skip to content
danythingPublic

About

地震・津波の情報を家のサーバーで受けて、見て、Web Push で知らせる (SvelteKit・セルフホスト)

Resources

Stars

6 stars

Watchers

0 watching

Forks

Repository files navigation

sonae

地震・津波・火山・気象の情報を家のサーバーで受けて、ブラウザで見たり、Web Push や Discord・Slack の Webhook で通知を受けたりするアプリ。 自分と家族のために、自分のサーバーに 1 つ立てて使う (セルフホスト)。家の LAN からはログインなしで、外からは OIDC のログインで開く。

緊急地震速報 (警報) を受けると、右の列が詳しい内容に替わって先頭に赤い箱が出て、地図が震源と警報の地域を示し、OS の通知が出る。出ている間が過ぎると一覧へ戻り、続いて地震の情報を読み上げ始めると、詳しい内容が開いて地図が各地の震度で塗られる

音声つきの動画 (58 秒・2.2 MB): 試験用のデータで、緊急地震速報 → 地震の情報 → 津波注意報を受けたところ。チャイム → OS の通知 → 読み上げの流れと、読み上げ始めた報の詳しい内容が自動で開くようす、地図・一覧・吹き出しの動きが分かる。

sonae-demo.mp4

docs/images/demo.mp4 (落として開く)

地図と一覧
地図と一覧 — 津波注意報の海岸と気象の警報・注意報を地図に、全部の種類を新しい順に 1 本の一覧に
詳しい内容
詳しい内容 — 行を押すと、震源・M・各地域の震度。地図も各地の震度で塗る
通知の窓の先頭。住んでいる地域 (千葉県千葉市) と、緊急地震速報・地震・津波・火山・気象の 3 択と、それぞれ何を知らせるかの 1 文
通知 — 種類ごとに全国・住んでいる地域と現在地・知らせないを選ぶ。音と読み上げ・Web Push・Webhook も
スマホの地図
スマホ — 地図が画面いっぱいに。下に選んだものの 1 行と 5 つのタブ
スマホの一覧
スマホの一覧 — 地図の上に重ねる面。種類のチップは下に

動画と画面は、試験用のデータ (気象庁のサンプル電文を書き換えた作り物と、手で組んだ緊急地震速報) を入れて撮った。実際の地震ではない。 読み上げの声は「VOICEVOX:剣崎雌雄」(利用規約)。 動画の OS の通知は、撮ったブラウザ (ヘッドレス) に出す場所が無いので、sonae が出そうとした通知と同じ見出しと本文を、画面の右下に通知の形で描いている。

作りは docs/design.md、画面は docs/ui.md、地図の層と出典は docs/map.md に書いてある。

  • 名前は「備え」から。地震を待つのではなく、来たときに慌てないためのもの。
  • Zero Quake の機能を参考にした。コードは読んでも写してもいない (一から書いている)。
  • 地震・津波・火山 (噴火速報・噴火警報) の情報を気象庁 (防災情報 XML)・P2P地震情報・Wolfx Project から、海外の地震を USGS・EMSC・GeoNet・中央氣象署 (台湾、授権碼があるとき) から、太平洋の津波の参考情報を PTWC (米国) と気象庁ホームページ (国際津波関連情報) から受け、画面には必ず出典と「公式の情報を優先してください」という注意文を出す。気象庁の情報は加工して出しているので、その旨も書く。
  • 地図には、台湾の観測点のいまの揺れ (ExpTech の TREM の RTS。非公式) を点の色で出す。地図に出すだけで、一覧・音・読み上げ・通知では知らせない。

知らせる条件は、緊急地震速報・地震・津波・火山・気象のそれぞれで「全国のものを知らせる」「住んでいる地域と現在地のものだけ」「知らせない」から選ぶ。地震は、知らせる震度も選ぶ。 ほかの段 (注意報も知らせるかなど) は決めてあり、選んだもので何を知らせるかを画面に 1 文で出す (docs/design.md の 2.4 の表)。 特別警報にあたるもの (気象の特別警報・大津波警報・噴火警報 (レベル 4・5)) と、南海トラフ地震臨時情報・後発地震注意情報は、「知らせない」を選んでもいつも知らせる。

開いている画面では、条件に合う情報を短い音と読み上げで知らせる (「オフ」「通知音だけ」「読み上げも」から選ぶ)。読み上げの声は、sonae と一緒に動かす VOICEVOX のエンジンで作る (既定の声は「VOICEVOX:剣崎雌雄」。声は画面で選べ、この家の全部の端末で同じ声になる)。 エンジンは sonae とは別のプロセスで動かし (理由は docs/design.md の 2.4)、1 行のインストーラでも docker compose up でも Helm chart でも sonae と一緒に起きる。 エンジンが止まっているときは、ブラウザの読み上げで同じ文を読む。

タブを閉じていても、条件に合う情報を Web Push でブラウザに届ける。Discord や Slack の Incoming Webhook の URL を「通知」に足せば、同じ情報を同じ見出しと本文でチャンネルにも送る (Home Assistant のような、JSON を受ける送り先にも送れる。docs/push.md の「Webhook」)。

1 行で入れる

1 行で、sonae と VOICEVOX のエンジンが立ち上がり、ブラウザが開く。 clone は要らない。

# Linux (x86_64。Docker Compose で動かす。Docker は先に入れておく)
curl -fsSL https://raw.githubusercontent.com/danything/sonae/main/install.sh | bash
# Mac (Apple Silicon・Intel。管理者のパスワードを聞かれる)
curl -fsSL https://raw.githubusercontent.com/danything/sonae/main/install.sh | sudo bash
# Windows (x64。管理者の PowerShell で)
irm https://raw.githubusercontent.com/danything/sonae/main/install.ps1 | iex
  • Linux は Docker Compose で動かす。Mac と Windows はコンテナを使わず、配布物の bun とアプリ、公式の VOICEVOX のエンジン (CPU 版) をそのまま動かす (Mac は root の LaunchDaemon、Windows は SYSTEM のタスク)
  • 開くのは http://localhost:3030 (Linux は genkan があれば http://sonae.localhost)。もう一度流せば最新に上げ直し、--uninstall (Windows は -Uninstall) で止めて外す (DB と設定は残す)
  • 家の LAN (とそのマシンのブラウザ) からは、ログインなしで開ける (sonae.env の TRUSTED_NETWORKS)。その中の誰でも設定を変えられるので、家の外からも開くならログイン (OIDC) を足す。http の LAN の IP で開いた端末では Web Push は使えない
  • 置き場・環境変数・ログイン・VOICEVOX のバージョンと規約は docs/install.md (Mac・Windows)

Kubernetes に立てる (Helm chart)

Kubernetes には Helm chart で入れる (セルフホストの考え方は docs/design.md の 1 章)。 chart はリリースのたびに oci://ghcr.io/danything/charts/sonae に出る。中身は sonae・VOICEVOX のエンジン・Service・HTTPRoute か Ingress・PVC・NetworkPolicy で、値の意味は charts/sonae/values.yaml のコメントに書いてある。

  1. OIDC の IdP にクライアントを作り、リダイレクト URI https://<ホスト名>/auth/callback を登録する (Entra ID なら docs/entra.md)。ロール admin (sonae.oidc.role で替えられる) を持つ人だけが開ける。

  2. 秘密を Secret に入れる。chart は Secret を作らない。

    kubectl create namespace sonae
    kubectl -n sonae create secret generic sonae-secrets \
      --from-literal=oidc-client-secret=<クライアントシークレット>
    # 任意: Web Push の VAPID の秘密鍵 (docs/push.md) と、台湾の中央氣象署の授権碼 (docs/cwa.md)
    #   --from-file=vapid-private-jwk=vapid.jwk --from-literal=cwa-api-key=<授権碼>
  3. 値を書いて入れる。

    # my-values.yaml
    sonae:
      oidc:
        issuer: https://login.microsoftonline.com/<テナントの ID>/v2.0
        clientId: <クライアントの ID>
    secrets:
      name: sonae-secrets
    httpRoute:
      enabled: true
      parentRefs:
        - name: <Gateway の名前>
          namespace: <Gateway の名前空間>
      hostnames:
        - sonae.example.com
    helm install sonae oci://ghcr.io/danything/charts/sonae -n sonae -f my-values.yaml
  • 公開の URL (PUBLIC_URL・ORIGIN) は、書かなければ httpRoute.hostnames か ingress.hosts の先頭に https:// を付けたもの。違うときは sonae.publicUrl に書く。
  • OIDC の 3 つ (issuer・client id・Secret の oidc-client-secret) が揃わないと、画面は開かず /health だけ答える。chart は TRUSTED_NETWORKS を書かない (書くなら sonae.extraEnv。docs/install.md の「ログイン」)。
  • VAPID の鍵が無ければ Web Push を切って動く。授権碼が無ければ中央氣象署の受信だけを切って動く。
  • 既定の image.tag は latest (main に中身の変更が入るたびに動く)。固定するなら ghcr.io/danything/sonae のコミットの sha のタグを書く。
  • Ingress を使うなら ingress.enabled: true と ingress.hosts。SSE (/api/stream) が切れないよう、前段の読み込みのタイムアウトを長くする。
  • PVC は既定で Argo CD に消させない注釈が付く (persistence.protectFromPruning)。
  • 外向きを絞る NetworkPolicy (networkPolicy.egress.enabled) は既定で出さない。DNS の Pod のラベルがクラスタで違うため。出すとプライベートのアドレスを閉じるので、家の LAN の Webhook の送り先 (Home Assistant など) は networkPolicy.egress.extraTo に足す。

このリポジトリの持ち主の本番 (s.doany.io。家の Talos のクラスタ) も同じ chart で出している。値は deploy/application.yaml の helm.valuesObject。

開発

依存はホストに入れず、コンテナの中で動かす。

docker compose up            # https://sonae.localhost (genkan 経由)。VOICEVOX のエンジンも一緒に起きる
docker compose run --rm sonae bun run lint    # oxlint・整形の確かめ (bun fmt --check)
docker compose run --rm sonae bun run check   # 型 (svelte-check --tsgo)
docker compose run --rm sonae bun test tests
docker compose run --rm sonae bun run build

docker の代わりに wslc-compose でもよい。

手元ではログインを飛ばす (AUTH_DISABLED=1、compose.yml)。本番のログインの設定は docs/entra.md。 Web Push は VAPID の鍵が無ければ切って動く。鍵の作り方と入れ方は docs/push.md。

起動すると気象庁・P2P地震情報・Wolfx・USGS・PTWC・EMSC・気象庁ホームページ (国際津波)・GeoNet・ExpTech TREM (と、授権碼があれば中央氣象署) に実際につなぐ。台湾の中央氣象署の授権碼の取り方は docs/cwa.md。画面だけ触りたいときは SONAE_RECEIVE=off で止める。緊急地震速報の訓練・試験も一覧と地図に出すときは SONAE_TRAINING=on (知らせはしない)。

ライセンス

AGPL-3.0

使っている情報源の条件は、それぞれの規約に従う (docs/design.md の「情報源の判断」)。 台湾の観測点の揺れ (ExpTech の TREM-RTS) は、ExpTech の授權頁で「註明來源・不可商用」(出典を書けば非商用で使える) のデータです。 商用で立てる (有料のサービス・広告や課金のあるアプリ・サイトで使う) なら、ExpTech の同意が要ります。 同意が無ければ、環境変数 SONAE_TREM=off で受信を切ってください。

About

地震・津波の情報を家のサーバーで受けて、見て、Web Push で知らせる (SvelteKit・セルフホスト)

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages