Skip to content

voidauth/voidauth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

GitHub Actions Workflow Status GitHub License GitHub Release GitHub Repo stars


VoidAuth logo

Single Sign-On for Your Self-Hosted Universe



Login Portal

What is VoidAuth

VoidAuth is an open-source SSO authentication and user management provider that stands guard in front of your self-hosted applications. The goal of VoidAuth is to be easy-to-use for admins and end-users, supporting nice-to-have features like passkeys, user invitation, self-registration, email support, and more!

Key Features:

  • 🌐 OpenID Connect (OIDC) Provider
  • πŸ”„ Proxy ForwardAuth
  • πŸ‘€ User Management
  • πŸ“¨ User Self-Registration and Invitations
  • 🎨 Customizable Branding (Logo, Title, Theme Color, Email Templates)
  • πŸ”‘ Passkeys and Passkey-Only Accounts
  • πŸ“§ Secure Password Reset with Email Verification
  • πŸ”’ Encryption-At-Rest with Postgres or SQLite Database

Admin Panel

Administrators can access the Admin Panel in the sidebar menu, where they can manage users, groups, and settings of the VoidAuth instance.

An Admin Page with the Admin Side Panel Open

Quick Start

Getting started with VoidAuth is straightforward, the recommended approach is to add VoidAuth to a compose.yml file:

services:
  # ---------------------------------
  # Your reverse-proxy service here:
  # caddy, traefik, nginx, etc.
  # ---------------------------------

  voidauth: 
    image: voidauth/voidauth:latest
    restart: unless-stopped
    volumes:
      - /your/config/directory:/app/config
    environment:
      # Required environment variables
      # More environment variable options can be found 
      #   on the Getting Started page.
      APP_URL: # required
      STORAGE_KEY: # required
      DB_PASSWORD: # required, same as voidauth-db POSTGRES_PASSWORD
      DB_HOST: voidauth-db # required
    depends_on:
      - voidauth-db

  voidauth-db:
    image: postgres:18
    restart: unless-stopped
    environment:
      POSTGRES_PASSWORD: # required, same as voidauth DB_PASSWORD
    volumes:
      - db:/var/lib/postgresql/18/docker

volumes:
  db:

After creating/updating the compose.yml file and filling in the required environment variables, run docker compose up -d and visit your APP_URL to get started.

Important

After VoidAuth starts for the first time, find the initial administrator username and password in the logs: docker compose logs voidauth

Please see the Getting Started page for setup details and configuration options.

Support

Issues, Suggestions, and Feature Requests should be added as Issues of the appropriate type. For Help and Support, Q&A, or anything else; open a Discussion. This project is actively monitored, I will likely respond quickly.

Contributing

Please read the CONTRIBUTING.md

Disclaimer

I am not a security expert! Please do not use VoidAuth for any purpose that is security critical or high risk. VoidAuth has not been audited and uses 3rd party packages for much of its functionality.

Credits

This project would not be possible without the incredible work of others including but not limited to:

node-oidc-provider Handles OIDC Provider functionality

SimpleWebAuthn Used for webauthn/passkey support

Angular Frontend web framework

Knex Database connection and query builder

zxcvbn-ts Password strength calculator

About

Single Sign-On for Your Self-Hosted Universe πŸˆβ€β¬›πŸ”’

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors 2

  •  
  •