インストール

Authrim のリソース作成とデプロイ設定の生成には Setup を使います。現在の構成は、D1 を三つ作成したり、旧来の個別スクリプトを実行したりするだけではセットアップできません。

必要なもの

リポジトリの設定に合わせた Node.js 22.18 以降の 22.x または 24.11 以降と pnpm 9。
Git と、作成するリソースに対する権限を持つ Cloudflare アカウント。
API・UI の URL に応じたドメインと DNS 設定、または Setup が提示する対応済みの Workers ドメイン構成。
メールコード認証を使う場合は、メールプロバイダーと送信元の設定。本番の認証情報が未設定ならコードがログに出る、という前提では運用しないでください。

必要な Cloudflare サービスは有効にする機能によって異なります。Workers、D1、KV、Durable Objects、Queues、R2 の利用可否と上限を確認してください。すべての構成が無料プランで動くわけではありません。

ソースからインストールする

インストールするリリースのソースを使用します。開発ブランチと公開済みリリースでは、必要なマイグレーション成果物が異なる場合があります。

git clone https://github.com/sgrastar/authrim.git
cd authrim
pnpm install
pnpm exec wrangler login
pnpm run setup init --env prod --lang ja

init はガイド付きのセットアップを開始します。ターミナル上で進める場合は次のコマンドを使います。

pnpm run setup init --env prod --cli --lang ja

pnpm setup は pnpm 自体のセットアップコマンドです。Authrim では pnpm run setup を使い、init などの前に余分な -- を入れないでください。

公開パッケージの npx @authrim/setup から始める方法もあります。このランチャーはセットアップに必要なソースを解決して実行します。デプロイ用ソース一式が不要になるわけではありません。以後の操作には同じソースディレクトリを使い、環境設定を保持してください。

Setup が管理するもの

Setup で環境名、ドメイン、機能、初期管理者などを設定します。鍵、Cloudflare リソース、Worker のバインディング、マイグレーション、デプロイ状態を準備します。

項目	現在の役割
Workers	プロトコル用サービス、Router、Control、Plugin Runner、選択した UI・機能
データベース	Core・PII・Admin・Control・Lookup・Plugin Runner のスキーマを分離。固定の三つではなく、容量とルーティングも管理
ランタイムの経路	署名付きレジストリ、データベースのバインディング識別情報、世代情報
その他のリソース	KV、Durable Objects、有効な機能に必要な Queues・R2
ローカル状態	`.authrim` 配下の環境設定とデプロイ記録。鍵は設定した保存先に置き、通常は `.authrim-keys` を使用

ウィザードをデプロイまで進め、完了時に表示された URL を使います。更新や復旧に必要な設定と鍵は安全に保管し、生成された認証情報を Git にコミットしないでください。

設定済み環境の確認とデプロイ

pnpm run setup status --env prod
pnpm run setup info --env prod
pnpm run setup config --validate --env prod
pnpm run setup deploy --env prod --dry-run

設定済みの環境へデプロイする場合は次を実行します。

pnpm run setup deploy --env prod

deploy は、未作成の環境を初期化する操作の代わりにはなりません。設定・リソース・マイグレーションのエラーを解消してから進めてください。

既存環境の更新

更新先リリースのソースで、まず変更内容を確認します。

pnpm run setup update --env prod --dry-run
pnpm run setup update --env prod

公開リリースのインストールには、確定済みのリリースマイグレーションマニフェストを使用します。新規作成用のベースラインと既存環境の更新は別の計画です。既存 DB に新しいベースラインを適用したり、SQL を手作業で連結したりしないでください。スキーマは migrations/core/、pii/、admin/、control/、lookup/、plugin-runner/ の各配下で、バックエンドごとに管理します。

--allow-draft-manifest は開発用です。通常のインストールや本番更新では使いません。リリース成果物が不足している場合は、検証を回避せず、適切な公開リリースのソースを使ってください。

ローカル開発

pnpm run dev はリポジトリの開発タスクを起動します。デプロイ済み環境を丸ごとローカルへ作成するコマンドではありません。複数 Worker 間のバインディング、DB、鍵、機能ごとの依存リソースに対応した開発設定が必要です。すべてが 8787 番ポートで動くとは限らないため、各サーバーが表示する URL を確認してください。

問題が起きたら

setup status と setup info で環境名と作業ディレクトリを確認します。
リソース作成に失敗した場合は Cloudflare の認証と権限を確認します。
バインディングとレジストリの整合性を保ちます。テナントの DB が見つからない場合に、共有 DB で代用しないでください。
開発サーバーのポートが使用中なら、該当サーバーを停止するか別のポートを選びます。無関係なプロセスを終了しないでください。

次にクイックスタートで Discovery と最初のクライアントを確認するか、アーキテクチャで構成を確認してください。