dani-garcia/vaultwarden

来源：https://github.com/dani-garcia/vaultwarden

Vaultwarden Logo 这是一个使用Rust编写的Bitwarden客户端API替代服务端实现，与官方Bitwarden客户端(https://bitwarden.com/download/)兼容[免责声明]，非常适合自行部署的场景，尤其是在不适合运行官方资源密集型服务的情况下。

GitHub Release (https://github.com/dani-garcia/vaultwarden/releases/latest) ghcr.io Pulls (https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden) Docker Pulls (https://hub.docker.com/r/vaultwarden/server) Quay.io (https://quay.io/repository/vaultwarden/server) 贡献者 (https://github.com/dani-garcia/vaultwarden/graphs/contributors) 复刻 (https://github.com/dani-garcia/vaultwarden/network/members) 星标 (https://github.com/dani-garcia/vaultwarden/stargazers) 开启的议题 (https://github.com/dani-garcia/vaultwarden/issues) 已关闭的议题 (https://github.com/dani-garcia/vaultwarden/issues?q=is%3Aissue+is%3Aclosed) AGPL-3.0 许可证 (https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt) 依赖状态 GHA Release (https://github.com/dani-garcia/vaultwarden/actions/workflows/release.yml) GHA Build (https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) Matrix 聊天室 (https://matrix.to/#/#vaultwarden:matrix.org) GitHub 讨论 (https://github.com/dani-garcia/vaultwarden/discussions) Discourse 讨论 (https://vaultwarden.discourse.group/)

使用此服务器时，请将任何错误或建议直接报告给我们（参见联系我们），无论您使用的是什么客户端（移动版、桌面版、浏览器版…）。请勿使用官方 Bitwarden 支持渠道。

功能

提供了一个几乎完整的 Bitwarden 客户端 API 实现，包括：

• 个人保管库 (https://bitwarden.com/help/managing-items/)
• 发送 (https://bitwarden.com/help/about-send/)
• 附件 (https://bitwarden.com/help/attachments/)
• 网站图标 (https://bitwarden.com/help/website-icons/)
• 个人 API 密钥 (https://bitwarden.com/help/personal-api-key/)
• 组织 (https://bitwarden.com/help/getting-started-organizations/)
  • 集合 (https://bitwarden.com/help/about-collections/)
  • 密码共享 (https://bitwarden.com/help/sharing/)
  • 成员角色 (https://bitwarden.com/help/user-types-access-control/)
  • 分组 (https://bitwarden.com/help/about-groups/)
  • 事件日志 (https://bitwarden.com/help/event-logs/)
  • 管理员密码重置 (https://bitwarden.com/help/admin-reset/)
  • 目录连接器 (https://bitwarden.com/help/directory-sync/)
  • 策略 (https://bitwarden.com/help/policies/)
• 多重/两步验证 (https://bitwarden.com/help/bitwarden-field-guide-two-step-login/)
  • 验证器应用 (https://bitwarden.com/help/setup-two-step-login-authenticator/)
  • 邮箱 (https://bitwarden.com/help/setup-two-step-login-email/)
  • FIDO2 WebAuthn (https://bitwarden.com/help/setup-two-step-login-fido/)
  • YubiKey (https://bitwarden.com/help/setup-two-step-login-yubikey/)
  • Duo (https://bitwarden.com/help/setup-two-step-login-duo/)
• 紧急访问 (https://bitwarden.com/help/emergency-access/)
• Vaultwarden 管理后台 (https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page)
• 修改过的网页保管库客户端 (https://github.com/dani-garcia/bw_web_builds)（包含在我们的容器中）

使用方法

网页保管库需要使用 HTTPS 和 Web Crypto API 的安全上下文 (https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API)。 这意味着只有在启用 HTTPS (https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) 时才能工作。 我们还建议使用反向代理 (https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)。

推荐安装和使用 Vaultwarden 的方式是通过我们的容器镜像，这些镜像发布在 ghcr.io (https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden)、docker.io (https://hub.docker.com/r/vaultwarden/server) 和 quay.io (https://quay.io/repository/vaultwarden/server)。有关提供的标签的说明，请参阅选择哪个容器镜像。

还有一些社区驱动的软件包 (https://github.com/dani-garcia/vaultwarden/wiki/Third-party-packages) 可供使用，但它们可能落后于最新版本，或者配置方式可能与我们的 Wiki (https://github.com/dani-garcia/vaultwarden/wiki) 中描述的 Vaultwarden 有所不同。

或者，您也可以自行构建 Vaultwarden (https://github.com/dani-garcia/vaultwarden/wiki/Building-binary)。

虽然 Vaultwarden 基于内置 TLS 支持的 Rocket Web 框架 (https://rocket.rs)，但我们的建议是您设置一个反向代理（参见代理示例 (https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)）。

有关如何安装、使用和配置 Vaultwarden 的更多详细示例，请查看我们的 Wiki (https://github.com/dani-garcia/vaultwarden/wiki)。

Docker/Podman CLI

拉取容器镜像，并从主机挂载一个卷用于持久化存储。如果您更喜欢使用 podman，可以将 docker 替换为 podman。

docker pull vaultwarden/server:latest
docker run --detach --name vaultwarden \
  --env DOMAIN="https://vw.domain.tld" \
  --volume /vw-data/:/data/ \
  --restart unless-stopped \
  --publish 127.0.0.1:8000:80 \
  vaultwarden/server:latest

这将在 /vw-data/ 下保留任何持久化数据，您可以根据需要调整路径。

Docker Compose

要使用 Docker Compose，您需要创建一个 compose.yaml 文件，其中包含运行 Vaultwarden 容器的配置。

services:
  vaultwarden:
    image: vaultwarden/server:latest
    container_name: vaultwarden
    restart: unless-stopped
    environment:
      DOMAIN: "https://vw.domain.tld"
    volumes:
      - ./vw-data/:/data/
    ports:
      - 127.0.0.1:8000:80

联系我们

有问题、建议或需要帮助？请加入我们的社区：Matrix (https://matrix.to/#/#vaultwarden:matrix.org)、GitHub 讨论 (https://github.com/dani-garcia/vaultwarden/discussions) 或 Discourse 论坛 (https://vaultwarden.discourse.group/)。

遇到错误或崩溃？请先搜索我们的议题追踪器和讨论区，看看是否已有报告。如果没有，请发起一个新的讨论 (https://github.com/dani-garcia/vaultwarden/discussions) 或创建一个新的议题 (https://github.com/dani-garcia/vaultwarden/issues/)。请确保您使用的是最新版本的 Vaultwarden，并且没有类似的已开启或已关闭的议题！

贡献者

感谢您为项目做出的贡献！ 贡献者数量 (https://github.com/dani-garcia/vaultwarden/graphs/contributors) 贡献者头像 (https://github.com/dani-garcia/vaultwarden/graphs/contributors)

免责声明

此项目与 Bitwarden (https://bitwarden.com/) 或 Bitwarden, Inc. 无关联。 然而，Vaultwarden 的一名活跃维护者受雇于 Bitwarden，并被允许在业余时间为该项目做出贡献。这些贡献是独立于 Bitwarden 的，并由其他维护者审查。维护者共同合作制定项目方向，专注于服务自托管社区，包括个人、家庭和小型组织，同时确保项目的可持续性。

请注意： 对于使用 Vaultwarden 可能发生的任何数据丢失，我们概不负责。这包括密码、附件和应用程序处理的其他信息。我们强烈建议定期备份您的文件和数据库。但是，如果您遇到数据丢失，我们鼓励您立即联系我们。

Bitwarden_RS

该项目以前称为 Bitwarden_RS，现已更名以区别于官方 Bitwarden 服务器，希望能避免混淆和商标/品牌问题。有关更多说明，请参阅 #1642 - v1.21.0 发布与项目更名 Vaultwarden (https://github.com/dani-garcia/vaultwarden/discussions/1642)。