Name: AuthMe
Author: AuthMe

Documentation

Learn AuthMe

Everything you need to deploy, configure, and integrate AuthMe into your applications.

Getting Started

Up and Running

Install, configure, and deploy AuthMe in minutes.

Getting Started

Deploy AuthMe in 30 seconds with Docker Compose. Clone, configure, and launch your identity server.

Configuration

Environment variables, SMTP settings, rate limiting, base URL, and per-realm configuration options.

Deployment

Docker production builds, horizontal scaling, clustering with Nginx load balancer.

Tutorials

Framework Integrations

Step-by-step integration guides for popular frameworks and runtimes.

Next.js

App Router setup, AuthProvider, middleware route protection, server component auth, and API route guards.

React SPA

AuthProvider, useAuth hook, ProtectedRoute component, login/logout flows, and token management.

Vue 3

AuthMe Vue plugin, useAuth composable, and Vue Router navigation guards.

Express.js

Token validation middleware, protecting API routes, and role-based access control.

NestJS

AuthMe guard, CurrentUser decorator, and role-based access control with metadata reflectors.

Protocol Guides

Auth Protocols

Configure OpenID Connect and SAML 2.0 for your applications.

OIDC Guide

Create an OIDC client, configure redirect URIs, understand token endpoints and scopes, and test with curl.

SAML Guide

Set up AuthMe as a SAML 2.0 Identity Provider, configure your Service Provider, and test SSO end-to-end.

Reference & Help

Reference & Support

API docs, architecture deep dives, and troubleshooting guides.

Troubleshooting

Top 10 common issues: Docker startup, database connections, SMTP, CORS, token validation, LDAP, migrations, and more.

Client & Server SDK

TypeScript SDK with React hooks and server-side token verification. Vanilla JS, React, Next.js, Express, and OIDC library integration.

Admin Console

Manage realms, users, clients, roles, sessions, and identity providers from the web dashboard.

REST API Reference

Complete reference for 100+ REST API endpoints covering admin management, OAuth 2.0, OpenID Connect, SAML 2.0, and operations.

Architecture

System design, NestJS module map, authentication flow diagrams, database schema, and the plugin system.

Database Schema

Complete Prisma schema with 27 models covering users, clients, tokens, sessions, roles, groups, and federation.