Matsuura Tomoya Research Note

検索

SearchSearch

BlueskyのPDSをCloudflare Tunnel環境でセルフホストする

created: 2024/02/08 updated: 2024/03/0510 min readview history

#self-hosted#bsky

立ちました。 Bluesky @tomoya.matsuuratomoya.com on Bluesky

公式リポジトリ

日本語のリソース

基本的には公式のリソースに従うのが一番。インストールスクリプトを実行すると/pdsディレクトリ以下に必要なリソースをコピーして、Dockerのインストールも含めて面倒を見てくれるので、すでにDockerで色々立ち上げてる人には逆にめんどくさいかもしれない。（DNSの設定とかをDockerホスト側の設定含めチェックする必要があるからこういうやり方にしている…っぽい。）

私はせっかくProxmox環境なので、諦めて一個LXCコンテナを増やすことにした。

Cloudflare環境でのハンドル解決問題

BlueskyのATプロトコルはDNSレベルでのハンドル解決を行う。そのため、例えばサーバーをbsky.matsuuratomoya.comでホストすると、通常はアカウントはサブドメインのtomoya.bsky.matsuuratomoya.comで解決されなければならない。

ここで、私の環境では問題が二つ。

  • bsky.matsuuratomoya.comと${handle}.bsky.matsuuratomoya.comはどちらもpdsのサーバーのIPアドレスにAレコードで解決されなければならない。
  • また実際のトラフィックはポート80、443をサーバーまで到達できるようにしなければならない。

立ち上げたサーバーが固定グローバルIPを持つ場合特に問題ない。私のサーバーはIPoE環境なので、IPv4で任意のポートを空けることができない。そのためWebサービスの公開にはCloudflare Tunnelを使っている。

この場合、必然的にネームサーバーもCloudflareのものを使うことになる。Cloudflareは自動でHTTPの接続をSSL化してくれるので、Let’s Encryptとかの面倒な設定が要らないため便利。だが無料プランでは残念ながら二階層以上のサブドメイン、つまり${handle}.bsky.matsuuratomoya.comにはSSL証明書を発行してくれない。

解決策は次のどれかである

  1. Cloudflareにお金を払ってSSL証明書を発行してもらう
  2. サブサブドメイン部分だけどうにか別の方法で証明書を用意する
  3. 自分一人のハンドル解決だけどうにかする設定にする（今回はこれ）

シングルユーザーインスタンス限定の解法

/pds/pds.envでPDS_SERVICE_HANDLE_DOMAINS=.matsuuratomoya.comのように指定すると、PDSサーバー自体のアドレスをhttps://pds.matsuuratomoya.comにしたまま、ハンドルのIDは${handle}.matsuuratomoya.comで設定できる。

もちろん、実際にはこの状態でアカウントをいくつも作っていっても、ハンドルIDが自分の立ち上げてる他のサーバーのアドレスとかち合ったりするので普通は運用できない。

しかし、使うユーザーが一人だけの場合は、_atproto.${handle}.matsuuratomoya.comにTXTレコードでアカウントのDID（永続性のあるアカウントID）を指定することでハンドルを解決すれば問題なく動かすことができる。

というわけで、まずは公式のinstall.shでpds.matsuuratomoya.com上に一通りサーバーを立ち上げて、/pds/pds.envにPDS_SERVICE_HANDLE_DOMAINS=.matsuuratomoya.comを追記する。 ついでに、管理メールの送信用のSMTPの設定も済ましておく。

PDS_EMAIL_SMTP_URL=smtps://${_SMTP_USERNAME}:${_SMTP_PASSWORD}@${_SMTP_HOST}
[email protected]

(PDS_EMAIL_FROM_ADDRESSに関してはなぜかドキュメントに載っていなかった気がする)

その後pdsadmin create-invite-codeでアカウント招待コードを作っておく。（pdsadmin account createだと先にハンドル解決ができないため招待コードを経由する）

Cloudflare Tunnelを立ち上げる

Cloudflare Tunnelを立ち上げる。私は別の用途で色々使っているトンネルがあるのでここでは省略。 一度も使ったことがないなら、おすすめは/pds以下にcompose.override.ymlというファイルを作ってコンテナを追加するのが多分楽。

services:
  tunnel:
    container_name: cloudflared-tunnel
    image: cloudflare/cloudflared:latest
    volumes:
      - ./cloudflared:/~/.cloudflared
    restart: unless-stopped
    command: tunnel run
    privileged: true
    environment:
      - TUNNEL_TOKEN=<設定画面で出てきたトークン>

トンネルが開通したら、サーバーのローカルIP（同じdocker composeで立ち上げてるならlocalhostでいい）に転送する。特にドキュメントに書かれてないが内部的には3000番でサーバーが立ち上がっているところに、Caddyでリバースプロキシをかけている。なので、トンネルではpds.matsuuratomoa.comに来るHTTPをそのまま3000番に転送してあげれば良い。

（つまりdocker composeで立ち上がっているcaddyのサーバーは無用の長物になっているため、気になる人はオリジナルのcompose.ymlでコメントアウトしてもいいと思う。私はどうせアップデートかけた時にcompose.ymlが巻き戻る気がしててめんどくさいのでやってない）

PDSにログインする

https://bsky.app にアクセスして、アカウントを作成する。この時pdsがきちんと立ち上がっていれば、サーバーのアドレスにpds.matsuuratomoya.comを指定して次に進めるはず。

ここで先ほど作成した招待コードでアカウント作成を進める。アカウント名はなんでもいいが、meやat、bskyなどシングルユーザーインスタンスなら使っても良さそうな短いハンドル名はコード上で予約IDとして（多分スパム防止）弾かれてしまう。（これは後々設定ファイルで弄れるようにしてほしい…。）

しょうがないので私は冗長だがtomoya.matsuuratomoya.comというハンドルを設定した。

ここで重要なのは、このインスタンスでログインしている間、インスタンス上のアカウントのハンドル解決はあくまで内部的に行われるということだ。

どういうことかというと、アカウント作成後、設定画面からハンドル変更で独自ドメインを指定することができる。 ここで例えばDNSを使用してmatsuuratomoya.comというルートドメインをアカウントに設定することも、_atprotoにTXTレコードをきちんと設定すれば、できる。ログアウトした状態なら正常にこのアカウントのプロフィールも表示できる。

ただし、matsuuratomoya.comを含むハンドルはpds.matsuuratomoya.comでログインしてる限り、あくまで内部でのハンドル解決が優先されDNSへの問い合わせはされない、ということらしい。ここがドキュメントでは明言されておらず自分のプロフィールが表示されないのに丸一日悩まされた。

他サーバーとの連携

肝心のFederationだが、残念ながら現在は一通り設定を済ませた後公式のDiscord(AT Protocol PDS Admins Discord)でPDSサーバーのアドレスを添えて連携リクエストをbsky公式に出す必要がある（そうしないとbluesky.socialのアカウントからは見えないようになっている）

作れるアカウントも現在は10アカウントまで、投稿数にも（一人で使う分には問題ない程度の）制限がある。今後どのくらい盛り上がるんでしょうね。

要点まとめ

  • 自分のpdsはcloudflare tunnelでpds.matsuuratomoya.comをポート3000に転送
  • /pds/pds.envでPDS_SERVICE_HANDLE_DOMAINS=.matsuuratomoya.comのようにルートドメインにする必要あり（Cloudflareではサブサブドメインに証明書が出ないので）
  • その上で、自分のpdsでログインしてる時の、自分のドメインに属するアカウントのハンドル解決は_atprotoレコードや.well-known/atproto-didを介さず行われるので何がしかのハンドルを設定する必要がある(私の場合は@tomoya.matsuuratomoya.comに設定でき、@matsuuratomoya.comにはできない)
  • しかし以前としてログアウト状態や他のインスタンスからはDNS解決できる必要があるので、_atproto.tomoya.matsuuratomoya.comにTXTレコードでdidを指定する必要がある

グラフビュー

バックリンク

Recent writing