Parley: プレーンIRCを話す、連合型・分散型チャット
Parley: Federated, decentralised chat that speaks plain IRC (git.mills.io)
要約
Parleyは、中央集権的な管理者を必要としない、連合型・分散型のチャットネットワークです。各ユーザーまたはチームは自身のドメインで小規模なインスタンスを実行し、DNSと公開されているIDドキュメントを通じて他のインスタンスと接続します。HTTPS経由で署名付きメッセージを交換し、通常のIRCクライアント(irssi、WeeChat、Textualなど)でプラグインなしに利用できます。このプロジェクトは現在、概念実証が機能しており、エンドツーエンドで設計を示していますが、まだ強化されていません。
全文翻訳
Parley
[画像: Build Status] [画像: Test Status] [画像: Go Reference] [画像: Docker Pulls] [画像: License: MIT]
IRCそのままに動作する、連合型・分散型チャット。
Parleyは中心を持たないチャットネットワークです。各ユーザー(またはチーム)は自身のドメイン用に小さなインスタンスを実行します。インスタンスはDNSと周知のIDドキュメントを通じて互いを見つけ、HTTPS経由で署名付きメッセージを交換し、通常のIRCクライアント(irssi、WeeChat、Textualなど)にプラグインなしで連合ネットワーク全体を提示します。
IDはメールのような形式です:alice@foo.com は foo.com 上で動作し、bob@bar.com は bar.com 上で動作します。Bobが /msg alice@foo.com hi と入力すると、たとえ両方のインスタンスが互いを初めて知ったとしても、それは機能します。
ステータス:動作する概念実証です。設計をエンドツーエンドで実証し、実際のインスタンスを実行しますが、まだ堅牢ではありません。Limitations を参照してください。
試してみる
公開登録はありません。Parleyを試すには、以下にある2インスタンスのクイックスタートを1台のマシンで実行してください。これはDNSを必要とせず、数分で完了します。または、インスタンスを実行している人にアカウントを依頼してください。実際のドメインで自身のインスタンスを実行する方法は、Running your own instance で説明されています。
Parleyの起源
Parleyは、2つの問いに対する概念実証として始まりました。
もしIRCが真に分散型だったらどうなるだろうか?ネットワークに参加する必要はなく、サービスもなく、仲介者もいない。
そして、もしそれがSalty IMのように、DNSと個人のドメイン上の周知のドキュメントを通じて人を見つけるとしたら?
どちらの問いも、以前の作業から来ています。James Millsとxuuによって設計・構築されたSalty IMは、発見モデルの由来です:メールのようなアドレス、SRVレコード、そしてドメイン自体が公開するドキュメント。Erisは、約10年間維持されているIRCサーバーで、Ergoの初期フォークとして開始されました。IRC側の多くはここから来ています。その両方の背後には、IRCの使用、ネットワークの実行、そしてそれらのためのソフトウェアの作成に約25年の経験があります。
プロトタイプは問いによく答え、継続するのに十分だったので、Parleyはそこから成長しました。
既存のクライアントで動作する
2つのインスタンス(foo.comとbar.com)、2つの標準的なWeeChatセッション。
Aliceは自身のインスタンスに接続し、Bobは自身のインスタンスに接続します:
[画像: Alice connects to foo.com] [画像: Bob connects to bar.com]
Bobが /query alice:foo.com でクエリを開くと、2つのインスタンスはその場で連合します(彼女のアドレス /msg alice@foo.com も彼女に届きます)。AliceはBobを bob:bar.com として表示し、BobはAliceを alice:foo.com として表示します:
[画像: Alice's query window with bob:bar.com] [画像: Bob's query window with alice:foo.com]
両方とも #lobby に参加します。これは、インスタンス間で複製されるグローバルチャンネルです:
[画像: Alice in #lobby] [画像: Bob in #lobby]
機能
- あらゆるIRCクライアントが接続可能。
PASSまたは SASL PLAIN をパスワードまたはIRCトークンで使用してログインします。IRCv3のserver-time、message-tags、echo-message、multi-prefix、setnameは、それらを要求するクライアントに提供され、TAGMSGはタイピングインジケーターのようなクライアント専用タグを、フェデレーション全体およびローカルクライアント間で中継します。メッセージ自体のタグは保持されるため、+replyは履歴から戻ってきたときも依然として返信であり、draft/multilineは貼り付けた段落を8つのメッセージではなく1つのメッセージにします。 - 履歴と既読位置はサーバーに保持される。
CHATHISTORYはチャンネルとダイレクトメッセージの両方をページングし、JOIN時に未表示のメッセージを再送し、draft/read-markerは既読位置をアカウントに記録するため、電話でチャンネルを既読にするとデスクトップでもクリアされ、クライアントはJOIN時にどこまで表示するかを知ることができます。 - クライアントがオフラインでも存在し続ける。
always_onを設定すると、アカウントは最後のクライアントが切断した後もチャンネルに残ります(不在として表示され)、次に接続したクライアントは誰も quit や rejoin を知らされることなく、中断したところから再開します。プッシュエンドポイント (soju.im/webpush) を登録したクライアントは、ダイレクトメッセージ、メンションされたチャンネルライン、およびそれ以外の通知を受け取ります。これは電話に必要なものです。 - クライアントからファイルを添付。
soju.im/FILEHOSTを話すクライアント(Goguma、gamja、senpai)は、既存のログインを使用してアップロードし、リンクを貼り付けます。これはインスタンス自身のエンドポイントから提供されるため、プロキシする追加のものはありません。リンクを持つ人なら誰でも開くことができます。 - アカウント管理は再起動なしで可能。 アカウントは設定ファイルではなく、インスタンスのデータディレクトリに保存されます。
parleyctl、管理ページ、HTTP APIで作成するか、シングルサインオン(OpenID ConnectプロバイダーまたはリバースプロキシからのIDヘッダー)でユーザーを迎え入れます。ユーザーは設定ページでクライアント用のIRCトークンを発行します。ボットはbotロールを持つアカウントです。 - DNS + WKID による発見。
_parley._tcp.<domain>SRVレコードがインスタンスを指し、https://<host>/.well-known/parley/instance.jsonがed25519公開鍵とインボックスを公開し、/.well-known/parley/<user>.jsonがユーザーの存在を確認します。これはSalty IMが人を見つける方法です。Where Parley came from を参照してください。 - 署名付きHTTPフェデレーション。 各イベントは、ピアの
/inboxにPOSTされるJSONドキュメントであり、ヘッダーに分離されたed25519署名が付いています。受信者は自身が発見した鍵に対して検証します。フェデレーションはオープンであり、署名がチェックアウトしたどのインスタンスでも通信できます。 - 自動ピアリング。 新しいドメインのユーザーにメッセージを送信すると、2つのインスタンスが自動的にリンクします。リンクされたインスタンスは、既知のピア(ゴシップ)を交換するため、設定なしでメッシュが形成されます。
- 2種類のチャンネル。
#devは グローバル で、参加しているすべてのリンクされたインスタンス間で複製されます。誰も所有していないため、トピックやオペレーターはありません。¬esは ローカル で、インスタンスから外に出ることはなく、ピアには見えず、トピックが存在する唯一の場所です。
- ユーザーまたはインスタンスによるブロック。 誰も所有していないチャンネルからキックすることはできないため、
/banはマスクによるブロックリストです:/ban quark@example.comは個人に対して、/ban *!*@example.comはインスタンス全体に対してです。あなたのブロックリストはあなたのアカウントをカバーし、管理者のブロックリストはインスタンスをカバーします。ピアリング自体はparleyctl peersで制御されます。 - アドレスは通常のIRC IDにマッピングされる。 あなたのインスタンスのユーザーは、そのニックネームのみで、インスタンスはホストです:
foo.com上のAliceはalice!alice@foo.comです。他の場所のユーザーはニックネームにドメインを含み、bar.comから見ると彼女はalice:foo.com!alice@foo.comです。プレフィックス、NAMES、WHO、WHOISはすべて一致し、NAMESで表示されるニックネームはメッセージを送信できるものです。/whois alice@foo.comは彼女のインスタンスのWKIDドキュメントを参照します。 - 履歴は保存、検索可能、ダウンタイム後もキャッチアップ可能。 各インスタンスはチャンネル履歴をSQLiteにフルテキストインデックス付きで保持し (
parleyctl search)、/channels/<name>/feedで提供します。ピアが障害から復帰すると、欠落していたものをプルし、クライアントはJOIN時に最近の履歴を再送します。
親戚との違い
Parleyはこれらを念頭に置いて設計され、それぞれから異なる選択をしています。
XMPP は同じ問題を解決し、標準です。XMPPクライアントが必要です。Parleyは逆の端から始めます:クライアントは、あなたが既に実行している任意のIRCクライアントであり、変更は不要です。
Matrix は各ルームの状態を参加サーバーすべてに複製し、それらの間の競合を解決します。Parleyのグローバルチャンネルには解決すべき状態(トピック、モード、オペレーター)がありません。インスタンスは聞いたものを保存し、自身のユーザーのみのために話します。これはMatrixが行うことよりも意図的に少ないため、インスタンスは小さなバイナリ1つで済みます。
ActivityPub はワイヤ上での最も近い親戚です:HTTPS経由でインボックスに投稿される署名付きJSON。Parleyはチャットのためにその形状を使用し、独自の小さなイベント語彙を持っています。
IRCサーバーリンキング(TS6とその関連)は、互いに信頼するサーバーを1つのグループによって実行される単一のネットワークに結合します。Parleyは、互いに信頼しておらず、会ったこともないインスタンス間でフェデレーションします。
モダンなIRCサーバーが1つだけ必要で、フェデレーションが不要な場合は、Ergo または Eris を使用してください。
クイックスタート(1台のマシンで2インスタンス、DNS不要)
次に、2つのターミナルで:
-insecure と -resolve はローカル開発専用です。本番環境では、各インスタンスは実際のドメイン、TLS証明書、SRVレコードを持ち、DNS経由でピアを見つけます。
本物:DNS + TLSデモ
demo/ は、CoreDNS(foo.com と bar.com の権威、_parley._tcp SRVレコード付き)、ローカルデモCA、およびDocker内の両方のインスタンスを起動し、スクリプト化されたIRCセッションを実行して証拠を出力します:
demo/README.md を参照してください。
独自のインスタンスを実行する
コンテナイメージは prologic/parley で、docker-compose.example.yml は出発点です。example.com 用のインスタンスで、chat.example.com で到達可能なものには以下が必要です:
-
実行場所、
/dataを永続ストレージにマウント(インスタンスキー、ピアキャッシュ、チャンネルログ、アカウントを保持):次に
parleyctl(イメージ内にもあります)または管理ページでアカウントを作成します:管理トークンがなく、アカウントがまだない場合、
parleydはブラウザで最初のアドミンを作成するワンタイム/setupURLをログに記録します。OpenID Connect またはリバースプロキシのIDヘッダーを介したシングルサインオンは、docs/AUTH.md で説明されています。SSOユーザーは設定ページでクライアント用のIRCトークンを発行します。 -
ポート8443の前面にHTTPS を
chat.example.comに配置します。TLSを終端する任意のリバースプロキシで十分です。TLS証明書とキーを指定しない限り、parleyd自体はプレーンHTTPを提供します。ファイルアップロード(
/upload、/files/)もこの同じプロキシを経由するため、Caddyには追加の設定は不要です。nginxはデフォルトでリクエストボディを1MBに制限します。uploads.max_sizeを少なくともuploads.max_sizeに設定してください。 -
SRVレコード を設定して、他のインスタンスが見つけられるようにします:
これがない場合、ピアは
https://example.com/.well-known/parley/にフォールバックします。 -
クライアント用のTLS経由IRC。
parleydのIRCリスナーはプレーンテキストなので、その前面でTLSを終端してください。例えば、Caddyのレイヤー4モジュールを使用する場合:次に、irssiで:
/connect -tls -tls_verify chat.example.com 6697 <password-or-token> alice。ここのポートはプロキシがリッスンしているポートです。6697でない場合は、
-irc-port(および-irc-host、IRCがエンドポイントと異なる名前の場合)を指定してparleydを起動するか、PARLEY_IRC_PORT/PARLEY_IRC_HOSTを設定します:ランディングページ、設定ページ、
parleyctl、インスタンスドキュメントはすべてそこからの接続ラインを出力し、設定ページはライブトークンをそのラインに出力します。正しいホスト名の下の間違ったポートでも証明書検証は通過するため、トークンはそこでリッスンしている他のものに送信されます。 -
外部からチェックする。
parleyctl checkは、ピアが行う方法でインスタンスをプローブします — SRVレコード、周知のドキュメント、広告されたエンドポイント、インボックス、IRC TLSポート — そして修正すべきことを伝えます:トークンは不要で、誰のインスタンスに対しても機能します。そのため、ピアのインスタンスに何が問題かを伝える方法でもあります。一般的な失敗はSRVレコードの欠落です。インスタンスは自身のホストで完全に到達可能ですが、IDドメインを解決する誰もそれを見つけることができません。DNSがまだ間違っている間にホストを直接プローブするには
-resolve https://chat.example.comを追加し、機械可読レポートには-jsonを追加します。チェックが失敗すると非ゼロで終了します。
連携方法
- Bobのクライアントが
PRIVMSG alice@foo.com :hiを送信します。 bar.comは_parley._tcp.foo.comをルックアップし、名前が示すホストからインスタンスドキュメントを取得し、鍵をキャッシュします。bar.comはイベントに署名し、foo.com のインボックスにPOSTします。foo.comは署名を検証するためにbar.comを同じ方法で発見し、Aliceのクライアントにメッセージを配信します。bar.comは見知らぬ人なので、helloを返します。両方の側がチャンネルのメンバーリストとピアリストを交換します。
これらを組み合わせると、インスタンスはフルメッシュを形成します:各インスタンスは、知った他のすべてのインスタンスと直接リンクし、それらは互いに知っているピアを交換することで互いを知ります。メッセージは送信者のインスタンスから、それを取得すべき各インスタンスに直接送信され、第三者を経由することはありません。そのため、依存するハブがなく、1つのリンクが失敗してもネットワーク分割が発生しません。その形状のコスト、および2つのインスタンスがリンクできない場合に何が起こるかは、docs/NETWORK.md に記載されています。
ワイヤフォーマットは docs/PROTOCOL.md で指定されており、その背後にある理由は docs/RATIONALE.md にあります。
設定
設定ファイルはありません。設定は2つの場所にあり、各項目はどちらか一方にのみ存在します。
フラグ(それぞれ環境変数あり)は、プロセスがデータベースを開く前に必要なもの、マシンとネットワークの説明、およびIDを主張できる人に関する秘密と信頼の決定を定義します。フラグは変数よりも優先されます。-domain のみが必須です。
| フラグ | 環境変数 | 意味 | デフォルト |
|---|---|---|---|
-domain | PARLEY_DOMAIN | このインスタンスが提供するIDドメイン | 必須 |
-data | PARLEY_DATA_DIR | IDキー、データベース、ピアおよびメンバーシップの状態 | ./data |
-endpoint | PARLEY_ENDPOINT | 公開されるベースURL | https://<domain> |
-irc | PARLEY_IRC_LISTEN | IRCリスナー(プレーンテキスト、前面でTLSを終端) | :6667 |
-http | PARLEY_HTTP_LISTEN | Web UI、発見、インボックス、フィード用のHTTP(S)リスナー | :8443 |
-irc-host, -irc-port | PARLEY_IRC_HOST, PARLEY_IRC_PORT | クライアントがTLS経由でIRCに接続する場所 | エンドポイントホスト、6697 |
-tls-cert, -tls-key | PARLEY_TLS_CERT, PARLEY_TLS_KEY | HTTPSを直接提供 | オフ |
-admin-token | PARLEY_ADMIN_TOKEN | 管理APIおよびparleyctl用のベアラートークン | オフ |
-admin (繰り返し) | PARLEY_ADMINS | 保存されたロールに関係なくアドミンとなるニックネーム | なし |
-seed (繰り返し) | PARLEY_SEEDS | 起動時にリンクするピアドメイン | なし |
-irc-proxy (繰り返し) | PARLEY_IRC_PROXIES | IRC接続にPROXYヘッダーを付加することを許可するCIDR | なし |
-http-proxy (繰り返し) | PARLEY_HTTP_PROXIES | Webリスナーが信じるX-Forwarded-ForのCIDR | なし |
PARLEY_TRUSTED_PROXIES および PARLEY_TRUSTED_* | リストされたプロキシからのIDヘッダー(docs/AUTH.md参照) | オフ | |
PARLEY_OIDC_* | OpenID Connectプロバイダー(docs/AUTH.md参照) | オフ | |
HAVEN_SOCKET | 家庭用同期のためのHome Cloudアプリソケット | オフ | |
-ca, -insecure, -resolve, -debug | PARLEY_DEBUG | ローカル開発 | オフ |
設定(データベース内)は、インスタンス実行中に管理者が変更できるすべてを対象とします。これらは保存された瞬間に有効になり、再起動は不要です。フラグや環境変数はありません。管理ページ、PUT /api/v1/settings(docs/API.md)、またはparleyctlで変更できます:
デフォルトから変更されたもののみが保存されるため、デフォルトを変更するアップグレードは、そのキーに触れたことのないすべてのインスタンスに影響します。
| 設定 | 意味 | デフォルト |
|---|---|---|
motd | 本日のメッセージ(空の場合は組み込みテキスト) | 組み込み |
history_replay | JOIN時の再送メッセージ(チャンネルとDM)、ログイン時の未読DM、および同じアカウントに接続するセカンドクライアントに表示されるバックログ | 50 |
history_retention | チャンネルおよびDM履歴の保持期間(-1 は無期限) | 8760h |
uploads.max_size | クライアントがアップロードできる最大のファイルサイズ(MiB単位)(0 はアップロードを無効にする) | 25 |
uploads.quota | アカウントあたりの合計(MiB単位)(-1 は無制限) | 1024 |
uploads.retention | アップロードされたファイルの保持期間(-1 は無期限) | 2160h |
message_rate, message_burst | 1アカウントあたりのメッセージ送信量:1秒あたりのメッセージ数、および同時送信数。0 は制限なし。ボットは免除される | 1, 20 |
max_conns | インスタンスへの同時IRC接続数(-1 は無制限) | 1024 |
max_conns_per_account | アカウントあたりの同時IRC接続数(-1 は無制限) | 8 |
always_on | 最後のクライアントが切断した後もアカウントをチャンネルに残す | false |
always_on_expiry | 誰も接続していない状態でアカウントがその状態を維持する期間 | 2160h |
max_conns_per_addr | クライアントアドレスあたりの同時IRC接続数(0 は無効) | 0 |
federation.policy | open または allowlist(招待のみ) | open |
federation.inbox_rate, federation.inbox_burst | ピアごとおよびアドレスごとのインボックス配信数 | 20, 200 |
federation.feed_rate, federation.feed_burst | アドレスごとのフィード読み取り数 | 2, 20 |
federation.new_peer_rate | 未招待でピアになる可能性のあるインスタンス数/時間、一度にその数まで。0 は無制限。 | 20 |
federation.catch_up_window | 再接続インスタンスが要求する期間 | 168h |
auth.local | ユーザー名/パスワードログインフォームを表示する | true |
auth.auto_link | 初回のSSOログインで未リンクのローカルニックネームを主張できる | true |
auth.session_ttl | Webログインの有効期間 | 720h |
auth.rate_limit.* | ログインレート制限(docs/AUTH.md参照) | オン |
metrics_public | 認証なしで /metrics を提供する | false |
network_name | このインスタンスが自身を呼ぶ名前(IRC上およびWeb上)。空の場合はIRC上のドメイン、Web上では「Parley」 | 空 |
theme_color | 電話がブラウザバーに着色する色(#rrggbb形式) | 組み込み |
operator | このインスタンスの運営者(Webフッターに表示) | 空 |
ユーザーは、Webインターフェースの「設定」で自身の画像を設定するか、ログイン時のIDプロバイダーの picture クレームから取得してここでホストします。これはIRCv3の avatar メタデータキーとしてIRCクライアントに、および周知のユーザードキュメントで他のインスタンスに公開されます。docs/PROTOCOL.md を参照してください。
インスタンスのロゴはこのテーブルにはありません。画像ファイルです。管理ページの「設定」->「ロゴ」で、少なくとも512ピクセル以上のPNG画像をアップロードすると、Parleyはファビコン、ホーム画面アイコン、およびIRCクライアントがネットワークの横に表示する正方形を生成します。正方形が理想的で、ワードマークでも構いません。縦横比が3倍までのものは、透明な正方形の中央に配置されます。それまでは、すべてのインスタンスがParley自身のアイコンを表示するため、クライアントのネットワークリストで2つが似たように見えます。
チャットヘルプ。 /help(または/quote HELP <topic>)は help/*.txt のページを提供し、これらはバイナリにコンパイルされます。ページを編集して再ビルドすると変更されます。最初の行がタイトルです。新しいファイルは新しいトピックです — help/index.txt にリストすると、make test がチェックします。
エンドポイント:/healthz(liveness)、/api/v1/status(ピアとチャンネルのJSONステータス)、/metrics(Prometheus)、およびAPI(docs/API.md)。
設定ファイルからのアップグレード。 parleyd -config config.json はもはやファイルを読み込みません。ファイル内の各キーについて、そのキーが対応するフラグ、変数、または設定を出力して終了します。プロセスレベルのキーをユニットファイルまたはコンポーズファイルに移動し、インスタンスを起動してから、parleyctl settings import config.json で残りを一度に適用し、スキップされたものを名前で示します。
TCPプロキシの背後にある実際のクライアントアドレス
IRCリスナーの前面でTLSが終端されている場合、すべてのクライアントはプロキシから到着します。ログには間違ったホスト名が表示され、アドレスごとの制限は何も行わないか、全員を一度にロックアウトします。プロキシを irc_proxies にリストすると、各接続にPROXYプロトコルヘッダー(v1またはv2)を付加する必要があります。
これは2つの変更であり、どちらか一方だけでは機能しません。 ヘッダーを送信しないプロキシをリストすると、そのプロキシからのすべての接続がドロップされます。リストされていないアドレスからヘッダーを送信すると、それはIRCパーサーへのゴミとしてフィードされます。安全な順序はないため、両方を同時に変更し、両方を元に戻す準備をしてください。
デフォルトは空であり、すべてが無効になっています。以下の 127.0.0.1/32 は例であり、デフォルトではありません。実際の接続が到着するアドレスを置き換えてください:
名前を注意してください:PARLEY_TRUSTED_PROXIES はWebリスナーの同等物であり、全く異なる決定です。
アドレスをリストするには、一度接続してログを読みます。各クライアントアドレスは、初めて検出されたときに報告されます:
プロキシの後ろでは、すべてのクライアントが1つのアドレスを共有するため、irc_proxies に入るべきものを正確に指定する単一の行になります。それは常にソケット上にあるアドレスであり、ヘッダーが運ぶアドレスではありません。ヘッダーアドレスはリストと一致しないため、それを報告すると失敗する値が渡されます。プロキシがリストされ、ヘッダーを送信すると、その行は trusted_proxy=true で再表示され、両方の半分が一致したことを確認します。
リストされたアドレスのみが信頼され、リストされたアドレスからのヘッダーを持たない接続は、直接接続として扱われるのではなくドロップされます。同じ場所から両方の形状を受け入れることは、ヘッダーが存在する理由であるアドレス偽装を返します。それらのドロップは parley_irc_proxy_rejected_total にカウントされ、変更中に監視すべきメトリックです。
Webリスナーも同様の盲点と独自のセッティングを持っています。リバースプロキシの後ろでは、すべてのリクエストがそのプロキシから到着するため、Webログイン、フェデレーションインボックス、フィード読み取りのアドレスごとのゲートはすべて1つのバケットを共有します。これはアドレスごとの名前を持つグローバルレート制限です。プロキシを http_proxies にリストすると、X-Forwarded-For が信頼され、それ以外は何も変更されません。
これは、仕事をするように見えるが、はるかに多くのことを行う auth.trusted_headers.proxies よりも使用してください。そのリストにあるプロキシは、ユーザーが誰であるか を主張できるため、Remote-User を持つ /login へのリクエストはパスワードなしでログインされます。レート制限の修正は、パスワードなしログインを有効にする理由にはなりません。IDリストはアドレスリストも暗示します。そのレベルまで信頼されているプロキシは、アドレスを疑うようなものではありません。アドレスリストは、ヘッダーが存在する理由であるアドレス偽装を返します。
ステップバイステップのバージョン(2回のダウンタイムではなく1回のダウンタイムで済む順序を含む)は、docs/PROXY.md にあります。
実際のアドレスが手に入ったら、max_conns_per_addr を安全に有効にでき、それを有効にすると、アドレスごとのログインバケットがIRCにも適用されます。リスナーがリストされていないプロキシの後ろにある間は 0 のままにしておきます。すべてのクライアントが1つのアドレスを共有するため、キャップは特定の誰かを制限するのではなく、全員を一度にロックアウトします。これは設定なので、有効にするには parleyctl settings set max_conns_per_addr 8 となり、再起動は不要です。アカウントごとのログインバックオフはどちらの場合も適用されます(docs/AUTH.md参照)。
メトリクス
/metrics はPrometheusテキスト形式で提供します:接続数、オンラインアカウント数、チャンネル数、リンクされたピア数、およびプッシュ、インボックスイベント、フィード読み取り、タグメッセージ、拒否されたもののカウンター。デフォルトでは管理トークンが必要です。インスタンスに何人の人がいるかはオペレーターのビジネスであるためです。公開するには metrics_public 設定を有効にします。すべてのサンプルはカウントであり、ニックネーム、チャンネル名、ピアドメインはありません。
インスタンスキーのバックアップ
<data_dir>/identity.key は再生成できない唯一のファイルです。ドメインのIDはそのキーペアです。それを失うと、古い公開鍵をキャッシュしているすべてのピアがインスタンスを拒否し、唯一の修正は新しい鍵であり、誰もが再度信頼する必要があります。ホスト上、ホスト外にバックアップしてください:
もし鍵が漏洩した場合、それを置き換えることは災害ではなくサポートされている操作です:
ピアは自分で回復します。検証できない署名は、インスタンスドキュメントを一度再読み込みさせ、そこで新しい公開鍵を見つけるため、コストはそれぞれ1回の失敗したリクエストです。そして、そのリクエストが hello であった場合、再試行する前に数分間のバックオフがあります。古い鍵は identity.key.<fingerprint>.bak として保持されます。なぜなら、ここでの唯一回復不可能な間違いは、まだ必要だった鍵を置き換えることだからです。新しい鍵を提供するように parleyd を再起動してください。
これらはAPIを経由せず、データディレクトリを直接読み書きします。なぜなら、管理トークンはネットワーク経由で秘密鍵を取得できないようにする必要があるからです。インスタンスホスト上で、-data-dir または PARLEY_DATA_DIR をデータディレクトリにポイントして実行してください。
アップグレード
実行するものは何もありません。データベースは最初の起動時に新しいテーブルを追加し、古いテーブルは変更されません。以下は、変更された少数の項目です。新しいものから順に記載します。
v0.6.0 へ
新しいインスタンスがピアになる速度が制限されました。 オープンポリシーの下では、署名が検証されたインスタンスはすべてピアとして受け入れられ、それ以降送信できるすべての制限はインスタンス自身のものです。ドメインは自由なので、1000の新しいインスタンスは1000のフルバジェットであり、それらが1024ピアのテーブルを埋めるのを止めるものはありませんでした。federation.new_peer_rate(1時間あたり20、一度にその数まで)は、こちらが要求していない、または他のインスタンスによって紹介されたインスタンスがどれだけ受け入れられるかを制限します。それを超えて到着したものは 429 で応答され、アウトボックスは再試行するため遅延しますが、何も失いません。新しいインスタンスのユーザーにメッセージを送信することや parleyctl peers add は、これに影響されません。あなたのインスタンスが20以上のインスタンスのメッシュに一度に参加する場合、残りは数時間かけて到着すると予想されるか、値を増やしてください。0 は以前の動作です:
1アカウントあたりのメッセージ送信量が制限されました。 message_rate(1秒あたり1)と message_burst(一度に20)は、ボットを除くすべての人にアカウント単位で適用されるため、ユーザーのクライアントは1つのバジェットを共有します。拒否されたメッセージは 439 で応答され、ターゲットを指定し、どこにも配信されません。このバージョンより前のすべてのインスタンスには制限がありませんでした。そのため、あなたのインスタンスにそれ以上の負荷がかかる部屋がある場合は、数値を増やすか、message_rate を 0 に設定してください(これは以前の動作です):
これは設定なので、再起動なしで適用されます。
v0.5.0 へ
他のインスタンスのユーザーは alice:foo.com であり、alice/foo.com ではありません。 区切り文字は draft/relaymsg から借用されましたが、コピーする慣習の誤った半分でした。厳密なクライアントは、サーバー名をニックネームと間違えないように、. と : の両方、またはどちらも持たないことを要求します。ドメインを持つ名前にはドットとコロンがありません。そのようなクライアントはプレフィックス全体をサーバー名として読み取り、リモートユーザーからの JOIN、PART、QUIT、NICK、AWAY をすべてドロップしました。一方、PRIVMSG は静かに低下しました。そのため、チャットは正常に見え、どのメンバーリストも更新されませんでした。ISUPPORT の PARLEYSEP は使用されている文字を示しているため、ボットはそれをハードコードするのではなく、そこから読み取る必要があります。
ネットワークがアップグレード中である場合の落とし穴:テキストメッセージはバイトとしてフェデレーションを横断します。/ を使用しているピアのユーザーが alice/foo.com と入力すると、アップグレードするまでこちらでは何も一致しません。ピアに通知してください。それが自分で見つけるのを待つのではなく。
v0.5.0 より前のピアに送信されたリアクションは、キューに入れられず失われます。 これらのバージョンは、実装していないイベントタイプを 422 で応答し、拒否は送信者のアウトボックスに対して最終的なものです。イベントはドロップされ、送信者は送信失敗を通知されます。v0.5.0 以降では、実装されていないタイプは `200 {