reaper0x1/bitwarden-portal

Bitwarden Portal

!Shell

目录

• 概述
• 核心功能
• 工作原理
• 环境变量
• 使用指南
  • 先决条件
  • 使用.env文件的Docker Compose配置
  • 直接设置环境变量的Docker Compose配置
  • 本地构建
• 路线图
• [开发中] 自签名证书

概述

本项目旨在为Bitwarden密码库创建备份流程至自托管的Vaultwarden实例，确保在官方Bitwarden服务不可用时仍有可用备份。

此Docker镜像自动化Bitwarden密码库的备份和恢复过程，提供导出、加密及备份版本管理功能。此外，脚本会安全删除过期文件，同时保留指定数量的最近备份。

✅ 此脚本同时支持Bitwarden和Vaultwarden

核心功能

• 🕛 自动化备份：通过CRON计划任务以JSON格式导出密码库数据。
• 🔒 文件加密：使用密码通过AES-256-CBC算法加密备份文件。
• 🧹 旧备份清理：基于可自定义的保留策略删除过期文件。
• 🤖 自动化恢复：解密并将备份导入到另一个Bitwarden密码库。
• 📂 完整密码库管理：恢复前删除目标密码库中的文件夹、项目和附件。
• 😊 兼容性：使用Bitwarden API密钥实现安全的密码库访问。
• ✒️ 自签名证书：支持本地域名的自签名证书。

工作原理

1. 源密码库备份

   • 以JSON格式导出密码库数据。
   • 加密导出的文件。
   • 删除过期文件，保留最近备份。

2. 目标密码库清理

   • 导出目标密码库当前内容。
   • 删除文件夹、项目和附件。

3. 目标密码库恢复

   • 解密最新的源密码库备份。
   • 将解密后的备份导入目标密码库。

环境变量

脚本使用以下环境变量进行备份和恢复配置：

• 脚本配置

  • CRON_SCHEDULE：备份CRON计划（默认：0 0 * * * = 每天00:00执行）
    可在crontab.guru生成自定义计划。

• 认证信息

  • SOURCE_ACCOUNT：源密码库的***。

  • SOURCE_PASSWORD：源密码库的密码。

  • SOURCE_CLIENT_ID：源密码库的客户端ID。

  • SOURCE_CLIENT_SECRET：源密码库的客户端密钥。

  • DEST_ACCOUNT：目标密码库的***。

  • DEST_PASSWORD：目标密码库的密码。

  • DEST_CLIENT_ID：目标密码库的客户端ID。

  • DEST_CLIENT_SECRET：目标密码库的客户端密钥。

    有关获取客户端ID和客户端密钥的方法，请参见先决条件。

• 服务器配置

  • SOURCE_SERVER：源密码库的Bitwarden/Vaultwarden服务器URL。
  • DEST_SERVER：目标密码库的Bitwarden/Vaultwarden服务器URL。

注意：源和目标可同时使用Bitwarden和Vaultwarden。如果自托管Vaultwarden使用自签名证书，请参见下方自签名证书部分。

• 安全参数

  • ENCRYPTION_PASSWORD：用于加密和解密备份文件的密码。

• 文件管理

  • PUID：设置文件权限的用户ID。
  • PGID：设置文件权限的组ID。
  • ENABLE_PRUNING：设为false时禁用备份清理（默认：true）。
  • RETENTION_DAYS：过期文件删除天数阈值，超过此天数的备份将被删除。
  • MIN_FILES：保留的最小备份文件数，若所有备份均超过RETENTION_DAYS，将保留此数量的最新备份。

创建的目录

• 备份文件夹
  • backups/source：源密码库备份存放目录。
  • backups/dest：目标密码库备份存放目录。

使用指南

先决条件

1. 🐋 已安装并配置Docker。
2. 已配置源和目标密码库的访问权限（使用API密钥凭证）。
   • 获取源和目标的客户端ID及密钥：进入账户设置 -> 安全 -> 密钥。

使用.env文件的Docker Compose配置

yaml
services:
    bitwarden-portal:
        image: reaper0x1/bitwarden-portal:latest
        container_name: bitwarden-portal
        env_file: .env
        volumes:
            - your-backups-folder:/app/backups
        restart: unless-stopped

• 将your-backups-folder替换为实际备份目录。
• 创建.env文件并设置变量（可参考.env.example）。

直接设置环境变量的Docker Compose配置

yaml
services:
    bitwarden-portal:
        image: reaper0x1/bitwarden-portal:latest
        container_name: bitwarden-portal
        environment:
            # CRON计划任务
            - CRON_SCHEDULE="0 0 * * *"
            # 时区
            - TZ="Europe/Berlin"
            # 备份文件加密密码
            - ENCRYPTION_PASSWORD="strong-password"
            # 源Bitwarden/Vaultwarden登录信息
            - SOURCE_ACCOUNT="source@mail.com"
            - SOURCE_PASSWORD="source-password"
            # 客户端ID和密钥（在账户设置->安全->密钥中获取）
            - SOURCE_CLIENT_ID="user.xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            - SOURCE_CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            # 源服务器域名/IP
            - SOURCE_SERVER="https://vault.bitwarden.com"
            # 目标Bitwarden/Vaultwarden登录信息
            - DEST_ACCOUNT="dest@mail.com"
            - DEST_PASSWORD="dest-password"
            # 客户端ID和密钥（在账户设置->安全->密钥中获取）
            - DEST_CLIENT_ID="user.xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            - DEST_CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            # 目标服务器域名/IP（使用自签名证书时可为https://vaultwarden.myserver.local）
            - DEST_SERVER="http://192.168.1.10:8888"
            # 文件权限用户及组ID
            - PUID="1000"
            - PGID="1000"
            # 启用/禁用备份清理（false/true）
            - ENABLE_PRUNING="true"
            # 备份保留天数（超过此天数的备份将被删除）
            - RETENTION_DAYS=30
            # 最小保留备份文件数（当所有备份均超过保留天数时）
            - MIN_FILES=10
        volumes:
            - your-backups-folder:/app/backups
        restart: unless-stopped

• 根据实际环境修改环境变量。
• 将your-backups-folder替换为实际备份目录。

本地构建

1. 克隆仓库并进入目录：

   bash
   git clone https://github.com/Reaper0x1/bitwarden-portal.git && cd bitwarden-portal
   

2. 创建.env文件并设置变量（可参考.env.example）。
3. 启动容器：

   bash
   docker compose up -d
   

路线图

• 支持通过docker-compose配置自签名证书（不仅限于本地构建）。
• 输出日志功能。
• 附件备份与传输。

自签名证书

[开发中]
如果使用带自签名证书的本地域名进行SSL加密，需将证书放入Certs文件夹。

• 本地构建镜像：将.crt文件放入certs文件夹即可。
• 使用Docker Hub镜像：待实现。