スタートガイド

English | 한국어 | 日本語

コマンドラインサーバがリモート transport と origin ポリシを備えている ため、このガイドはサーバモードから始めます。ライブラリモードでも同じポータブルなクライアント契約を直接利用できます が、Node.js アプリケーション側で審査済みの remote authority を用意する 必要があります。

要件

公開パッケージは Node.js 26 以降を必要とし、ECMAScript module を使います。 リポジトリでは pnpm 11 を使います。

サーバを実行する

以下の https://social.example を、ActivityPlug プロセスから到達できる 実際の Fediverse サーバの正規 HTTPS origin に置き換えてください。 コマンドラインサーバは 127.0.0.1:4000 で起動し、明示的に渡された origin のみ許可します。

npx @activityplug/cli \
  --allow-origin https://social.example

npx はパッケージと実行時の依存関係を必要に応じて取得するため、事前に インストールする必要はありません。

CLI をプロジェクトに追加する場合は、CLI パッケージをインストールし、 activityplug-server コマンドを実行します。

pnpm add @activityplug/cli
pnpm exec activityplug-server \
  --allow-origin https://social.example

サーバはフォアグラウンドで動き続けます。別のターミナルから readiness を 確認してください。

curl http://127.0.0.1:4000/health

HTTP API で設定済みの instance を検出します。

curl \
  -H 'Content-Type: application/json' \
  -d '{"origin":"https://social.example"}' \
  http://127.0.0.1:4000/api/v1/instances/detect

CLI には現在のアダプタがすべて含まれます。認証とセキュリティの状態は メモリ上にあり、access-token import はデフォルトで無効です。ブラウザ モードを有効にした場合、--browser-memory-stores を指定したときだけ ブラウザ用のインメモリ store が追加されます。永続 store やカスタム ポリシが必要なアプリケーションでは、プログラムからサーバを構成して ください。サーバの使い方を参照してください。

リポジトリのサンプルを実行する

リポジトリのサンプルはすべての統合経路を実行します。

• Bot は Mastodon または Misskey に対して ライブラリモードを使います。
• Proxy client は HTTP と GraphQL の サーバ API を呼び出します。
• Web client はメモリまたは永続ストレージと 組み合わせてブラウザ API を使います。

次に読むガイド

• TypeScript から直接統合し、実行環境ごとの remote authority を設定 する場合はライブラリの使い方を参照して ください。
• GraphQL または HTTP クライアントを開発する場合は サーバの使い方を参照してください。
• Web アプリケーションを開発する場合は ブラウザ統合を参照してください。
• サーバ固有の機能に依存する前に アダプタと capabilityを参照して ください。