Quickstart

Get your Authrim instance up and running in minutes.

Prerequisites

Before you begin, ensure you have:

Node.js >= 22.0.0 (Download)
pnpm >= 9.0.0 (Install)
Git (Download)
Cloudflare account (Sign up)

1. Clone the Repository

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

2. Install Dependencies

pnpm install

wrangler login

4. Run the Setup Wizard

Use the @authrim/setup CLI tool to automatically configure your environment:

npx @authrim/setup --cli

Or launch the interactive Web UI:

npx @authrim/setup

The setup wizard will:

Generate cryptographic keys (RSA for JWT signing)
Create .dev.vars with environment variables
Generate wrangler.toml for local development
Set up KV namespaces with default settings
Create the D1 database
Deploy Durable Objects

Setup Options

Option	Description
`--cli`	Use CLI mode (no Web UI)
`--env=<env>`	Specify environment (`dev` / `prod`)
`--lang=ja`	Use Japanese language

5. Start Development Server

pnpm run dev

This starts all workers in development mode. Access endpoints at http://localhost:8787.

6. Verify Your Setup

Test the discovery endpoint:

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

You should see the OpenID Connect discovery document with endpoints like:

{
  "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"
}

Test the JWKS endpoint:

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

Quick Test: Authorization Flow

Navigate to this URL in your browser to test the authorization flow:

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

Setup Flow Summary

git clone + pnpm install
    ↓
wrangler login
    ↓
npx @authrim/setup --cli  ← Configures everything automatically
    ↓
pnpm run dev

Legacy Setup (Manual)

For detailed customization or troubleshooting, you can use individual scripts:

# Generate keys
./scripts/setup-keys.sh

# Configure local environment
./scripts/setup-local-vars.sh
./scripts/setup-local-wrangler.sh

# Set up cloud resources
./scripts/setup-kv.sh --env=dev
./scripts/setup-d1.sh
./scripts/setup-durable-objects.sh

# Optional: Configure email (for OTP authentication)
./scripts/setup-resend.sh --env=local

Next Steps

Installation Guide - Detailed setup instructions
OIDC Configuration - Configure OpenID Connect