コンテンツにスキップ

クイックスタート

Authrimインスタンスを数分で起動しましょう。

前提条件

開始前に、以下を確認してください:

1. リポジトリをクローン

Terminal window
git clone https://github.com/sgrastar/authrim.git
cd authrim

2. 依存関係をインストール

Terminal window
pnpm install

3. Cloudflareにログイン

Terminal window
wrangler login

4. セットアップウィザードを実行

@authrim/setup CLIツールを使用して環境を自動設定します:

Terminal window
npx @authrim/setup --cli

または、対話式Web UIを起動:

Terminal window
npx @authrim/setup

セットアップウィザードは以下を行います:

  • 暗号鍵の生成(JWT署名用のRSA)
  • 環境変数を含む.dev.varsの作成
  • ローカル開発用のwrangler.tomlの生成
  • デフォルト設定でのKV名前空間のセットアップ
  • D1データベースの作成
  • Durable Objectsのデプロイ

セットアップオプション

オプション説明
--cliCLIモードを使用(Web UIなし)
--env=<env>環境を指定(dev / prod
--lang=ja日本語を使用

5. 開発サーバーを起動

Terminal window
pnpm run dev

すべてのワーカーが開発モードで起動します。エンドポイントはhttp://localhost:8787でアクセスできます。

6. セットアップを確認

ディスカバリーエンドポイントをテスト:

Terminal window
curl http://localhost:8787/.well-known/openid-configuration | jq

以下のようなOpenID Connectディスカバリードキュメントが表示されるはずです:

{
"issuer": "http://localhost:8787",
"authorization_endpoint": "http://localhost:8787/authorize",
"token_endpoint": "http://localhost:8787/token",
"userinfo_endpoint": "http://localhost:8787/userinfo",
"jwks_uri": "http://localhost:8787/.well-known/jwks.json"
}

JWKSエンドポイントをテスト:

Terminal window
curl http://localhost:8787/.well-known/jwks.json | jq

クイックテスト:認可フロー

ブラウザで以下のURLにアクセスして認可フローをテスト:

http://localhost:8787/authorize?response_type=code&client_id=test-client&redirect_uri=http://localhost:3000/callback&scope=openid&state=random-state

セットアップフローの概要

git clone + pnpm install
wrangler login
npx @authrim/setup --cli ← すべてを自動設定
pnpm run dev

レガシーセットアップ(手動)

詳細なカスタマイズやトラブルシューティングには、個別のスクリプトを使用できます:

Terminal window
# 鍵を生成
./scripts/setup-keys.sh
# ローカル環境を設定
./scripts/setup-local-vars.sh
./scripts/setup-local-wrangler.sh
# クラウドリソースをセットアップ
./scripts/setup-kv.sh --env=dev
./scripts/setup-d1.sh
./scripts/setup-durable-objects.sh
# オプション:メール設定(OTP認証用)
./scripts/setup-resend.sh --env=local

次のステップ