timshel/oidcwarden

Vaultwarden (支持OpenID Connect的分支) 镜像文档

概述

本镜像为Vaultwarden的衍生分支，在原项目（https://github.com/dani-garcia/vaultwarden%EF%BC%89%E5%9F%BA%E7%A1%80%E4%B8%8A%E5%A2%9E%E5%8A%A0%E4%BA%86OpenID Connect（OIDC）认证支持。Vaultwarden是一款轻量级的自托管密码管理服务，本分支进一步扩展其身份认证能力，允许通过OpenID Connect协议与第三方身份提供商集成。更多项目细节可参考上游仓库：https://github.com/Timshel/OIDCWarden%E3%80%82

核心功能与特性

• 继承Vaultwarden基础功能：提供密码、***、笔记等敏感信息的安全存储、同步与管理，兼容Bitwarden客户端。
• 新增OpenID Connect支持：集成OIDC协议，支持通过第三方身份提供商（如Keycloak、Auth0、Okta等）进行身份验证，增强认证灵活性。
• 轻量级部署：保持原Vaultwarden的轻量特性，资源占用低，适合个人或小型组织自托管部署。

使用场景与适用范围

• 自托管密码管理服务：需要构建私有密码管理系统，并希望通过OpenID Connect实现统一身份认证的场景。
• 企业/团队环境：需与现有OIDC身份提供商集成，实现集中式用户身份管理与访问控制的团队密码管理需求。
• 多系统认证整合：已有基于OIDC的单点登录（SSO）体系，需将密码管理服务纳入统一认证流程的场景。

使用方法与配置说明

基础部署（Docker Run）

通过以下命令启动容器，基础配置示例：

bash
docker run -d \
  --name vaultwarden-oidc \
  -p 80:80 \
  -v /path/to/data:/data \
  -e OIDC_PROVIDER=https://your-oidc-provider.com \
  -e OIDC_CLIENT_ID=your-client-id \
  -e OIDC_CLIENT_SECRET=your-client-secret \
  timshel/oidcwarden:latest

注：上述环境变量仅为示例，具体OpenID Connect配置参数（如提供商URL、客户端ID/密钥、回调URL等）需参考https://github.com/Timshel/OIDCWarden%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E%E3%80%82

Docker Compose配置示例

yaml
version: '3'

services:
  vaultwarden-oidc:
    image: timshel/oidcwarden:latest
    container_name: vaultwarden-oidc
    ports:
      - "80:80"
    volumes:
      - ./data:/data
    environment:
      - OIDC_PROVIDER=https://your-oidc-provider.com
      - OIDC_CLIENT_ID=your-client-id
      - OIDC_CLIENT_SECRET=your-client-secret
      # 其他Vaultwarden基础配置（如ADMIN_TOKEN等）
    restart: unless-stopped

配置参数说明

除Vaultwarden原生配置参数外，需额外配置OpenID Connect相关环境变量，具体参数及取值范围请查阅https://github.com/Timshel/OIDCWarden%E3%80%82%E5%B8%B8%E8%A7%81%E9%85%8D%E7%BD%AE%E9%A1%B9%E5%8C%85%E6%8B%AC%EF%BC%9A

• OIDC提供商元数据URL或配置端点
• 客户端ID与密钥
• 认证范围（Scopes）
• 回调URL（Redirect URI）
• 角色映射规则（如需）

参考与更多信息

• 上游项目：https://github.com/dani-garcia/vaultwarden
• OIDC支持详情：https://github.com/Timshel/OIDCWarden