Skip to content

Tidy up the readme #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heskew merged 1 commit into from
Oct 30, 2025
Merged

Tidy up the readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ OAuth 2.0 and OpenID Connect authentication for Harper applications. Supports Gi

## Features

- 🔐 **Multi-provider support** - GitHub, Google, Azure AD, Auth0, and custom OIDC providers
- 🔄 **Automatic token refresh** - Proactive token renewal on every request
- 🪝 **Lifecycle hooks** - Extensible hooks for user provisioning and custom logic
- 🛡️ **CSRF protection** - Distributed token storage for cluster support
- 🎯 **ID token verification** - Full OIDC support with signature validation
- 🔧 **Zero configuration** - Works with Harper's session system automatically
- **Multi-provider support** - GitHub, Google, Azure AD, Auth0, and custom OIDC providers
- **Automatic token refresh** - Proactive token renewal on every request
- **Lifecycle hooks** - Extensible hooks for user provisioning and custom logic
- **CSRF protection** - Distributed token storage for cluster support
- **ID token verification** - Full OIDC support with signature validation
- **Zero configuration** - Works with Harper's session system automatically

## Installation

Expand Down Expand Up @@ -60,7 +60,11 @@ registerHooks({
const { User } = tables;

// Find or create user
let user = await User.findOne({ email: oauthUser.email });
let user;
for await (const existing of User.search({ email: oauthUser.email })) {
user = existing;
break;
}

if (!user) {
user = await User.create({
Expand Down Expand Up @@ -201,7 +205,7 @@ Debug endpoints:
- `GET /oauth/{provider}/user` - View current session
- `GET /oauth/{provider}/refresh` - Trigger token refresh

**⚠️ Never enable debug mode in production**
**Warning:** Never enable debug mode in production.

## License

Expand Down