Documentation Menu
Documentation
Welcome to the OpenAuthster documentation. Learn how to deploy and integrate multi-tenant authentication into your applications.
What is OpenAuthster?
OpenAuthster is a multi-tenant authentication system built on OpenAuth for Cloudflare Workers. It provides:
- 🔐 Issuer Server - OAuth 2.0 / OIDC authentication at the edge
- 🏢 Multi-Tenant - Manage multiple projects from a single deployment
- 🎨 Web UI Dashboard - Configure themes, providers, and projects
- 📦 Client SDKs - TypeScript client with React integration
- ☁️ Edge Deployment - Global low-latency on Cloudflare's network
Quick Navigation
Getting Started
🚀 Getting Started
Quick introduction to OpenAuthster and basic setup
📦 Installation
Complete deployment guide for Issuer and WebUI
Integration Guides
🔌 Client SDK
Browser-side authentication with OpenAuthsterClient
⚛️ React Integration
Provider and hooks for React applications
🖥️ Server-Side
API routes, token verification, and private sessions
💾 Sessions
Managing public and private session data
Architecture
OpenAuthster follows a modular architecture:
┌─────────────────┐
│ Your App │
│ (React/Next) │
└────────┬────────┘
│ Uses OpenAuthsterClient
│
▼
┌─────────────────────────────────┐
│ OpenAuthster Issuer │
│ (Cloudflare Worker) │
│ • Multi-tenant auth │
│ • OAuth providers │
│ • D1 Database │
└────────┬────────────────────────┘
│ Managed by
│
▼
┌─────────────────────────────────┐
│ OpenAuthster WebUI │
│ (Cloudflare Pages) │
│ • Project management │
│ • Theme customization │
│ • Provider configuration │
└─────────────────────────────────┘
Deployment Sequence
To use OpenAuthster, deploy the components in this order:
- Deploy Issuer - The authentication server
- Deploy WebUI - The management dashboard
- Integrate Client - Add to your application
GitHub Repositories
All OpenAuthster components are open source:
| Repository | Description |
|---|---|
| openauthster | Main project overview |
| OpenAuthSter-issuer | Authentication server |
| OpenAuthSter-webUI | Management dashboard |
| OpenAuthSter-shared | Client SDK and types |
| openauth-react | React integration (WIP) |
| openauthster-doc | Documentation site |
Need Help?
- 💬 GitHub Discussions
- 🐛 Report Issues
- 📖 Browse the documentation using the navigation above
Start Here
👉 New to OpenAuthster? Begin with the Getting Started Guide
👉 Ready to deploy? Follow the Installation Guide