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 Docker Pulls


VoidAuth logo

Single Sign-On for Your Self-Hosted Universe



What is VoidAuth

VoidAuth is an open-source authentication platform that streamlines user management and access control for self-hosted applications. Centered on OpenID Connect (OIDC) integration, it also offers first class support for Proxy ForwardAuth (ProxyAuth). With a focus on an intuitive end-user and administrator web interface, VoidAuth provides a seamless and professional authentication experience. Try it today!

Key Features:

  • πŸ‘€ User Management
  • 🌐 OpenID Connect (OIDC) Provider
  • πŸ”„ Proxy ForwardAuth Domains
  • πŸ“¨ 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

User Profile Settings

The default page for users logging into VoidAuth, on the Profile Settings page a user can manage their profile, password, email, and passkey settings.

Admin Panel

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

Quick Start

Getting started with VoidAuth is straightforward, with just a few lines of Docker Compose you can have it up and running.

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

  voidauth: 
    image: voidauth/voidauth:latest
    volumes:
      - config:/app/config
    environment:
      # Required environment variables
      APP_URL: # required
      STORAGE_KEY: # required
      DB_PASSWORD: # required
      DB_HOST: voidauth-db # required
    depends_on:
      - voidauth-db

  voidauth-db:
    image: postgres:17
    environment:
      POSTGRES_PASSWORD: # required
    volumes:
      - db:/var/lib/postgresql/data

volumes:
  config:
  db:

Tip

A bind mount for VoidAuth /app/config is recommended to enable customization.

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 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 researcher or expert, just a developer unsatisfied with the difficult onboarding process of existing self-hosted auth solutions. Use at your own risk.

Credits

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

node-oidc-provider Handles VoidAuth OIDC Provider functionality

SimpleWebAuthn Used by VoidAuth for webauthn/passkey support

Angular Frontend web framework used by VoidAuth

authelia An amazing project and heavy inspiration, VoidAuth aims to be less feature-complete but more user friendly

lldap Inspiration for user management, a very good self-hosted ldap service