voidauth/voidauth Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

VoidAuth 镜像文档

!GitHub Actions Workflow Status !GitHub License !GitHub Release !GitHub Repo stars

自托管环境的单点登录解决方案

镜像概述和主要用途

VoidAuth 是一个开源的单点登录(SSO)认证和用户管理提供商，为您的自托管应用程序提供安全防护。VoidAuth 的目标是让管理员和终端用户都能轻松使用，支持诸如Passkeys、用户邀请、自注册、电子邮件支持等实用功能。

核心功能和特性

• 🌐 OpenID Connect (OIDC) 提供商
• 🔄 代理 ForwardAuth
• 👤 用户管理
• 📨 用户自注册和邀请功能
• 🎨 可自定义品牌（徽标、标题、主题颜色、电子邮件模板）
• 🔑 Passkeys 和仅 Passkey 账户
• 📧 带电子邮件验证的安全密码重置
• 🔒 使用Postgres或SQLite数据库进行静态加密

管理员面板

管理员可以通过侧边菜单访问管理员面板，在那里他们可以管理VoidAuth实例的用户、组和设置。

使用场景和适用范围

VoidAuth适用于需要集中身份验证和用户管理的自托管环境，特别是：

• 个人或小型团队的自托管服务
• 需要统一身份验证的多应用环境
• 重视安全性和用户体验的场景
• 希望支持现代认证方式（如Passkeys）的系统
• 需要自定义品牌和用户体验的组织

详细的使用方法和配置说明

快速开始

使用VoidAuth非常简单，推荐的方法是将VoidAuth添加到compose.yml文件中：

yaml
services:
  # ---------------------------------
  # 此处为您的反向代理服务:
  # caddy, traefik, nginx 等
  # ---------------------------------

  voidauth: 
    image: voidauth/voidauth:latest
    restart: unless-stopped
    volumes:
      - /your/config/directory:/app/config
    environment:
      # 必需的环境变量
      # 更多环境变量选项可在
      # 入门页面找到
      APP_URL: # 必需
      STORAGE_KEY: # 必需
      DB_PASSWORD: # 必需，与voidauth-db的POSTGRES_PASSWORD相同
      DB_HOST: voidauth-db # 必需
    depends_on:
      - voidauth-db

  voidauth-db:
    image: postgres:18
    restart: unless-stopped
    environment:
      POSTGRES_PASSWORD: # 必需，与voidauth的DB_PASSWORD相同
    volumes:
      - db:/var/lib/postgresql/18/docker

volumes:
  db:

创建/更新compose.yml文件并填写所需的环境变量后，运行docker compose up -d并访问您的APP_URL即可开始使用。

[!IMPORTANT] VoidAuth首次启动后，请在日志中查找初始管理员用户名和密码：docker compose logs voidauth

环境变量配置

必需环境变量

可选环境变量

更多环境变量配置选项可在官方入门页面找到。

数据持久化

为确保配置和数据持久化，需要挂载以下卷：

• /app/config: 存储配置文件
• 数据库卷: 存储用户和认证数据

反向代理配置

VoidAuth需要与反向代理配合使用，如Caddy、Traefik或Nginx。请确保正确配置反向代理以将请求转发到VoidAuth服务。

支持

问题、建议和功能请求应作为相应类型的Issues提交。如需帮助和支持、问答或其他事项，请开启Discussion。该项目受到积极监控，通常会很快得到响应。

贡献

请阅读CONTRIBUTING.md文件。

免责声明

我不是安全专家！请不要将VoidAuth用于任何安全关键或高风险的目的。VoidAuth尚未经过审计，其大部分功能依赖第三方包。

致谢

本项目的实现离不开以下项目的杰出工作：

node-oidc-provider - 处理OIDC Provider功能

SimpleWebAuthn - 用于webauthn/passkey支持

Angular - 前端Web框架

Knex - 数据库连接和查询构建器

zxcvbn-ts - 密码强度计算器