vaultwarden README

The project's README from github.com/dani-garcia/vaultwarden. As one markdown file: README.md.

Vaultwarden Logo

An alternative server implementation of the Bitwarden Client API, written in Rust and compatible with official Bitwarden clients [disclaimer], perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.

GitHub Release ghcr.io Pulls Docker Pulls Quay.io
Contributors Forks Stars Issues Open Issues Closed AGPL-3.0 Licensed
Dependency Status GHA Release GHA Build
Matrix Chat GitHub Discussions Discourse Discussions

[!IMPORTANT] When using this server, please report any bugs or suggestions directly to us (see Get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official Bitwarden support channels.


Features

A nearly complete implementation of the Bitwarden Client API is provided, including:


Usage

[!IMPORTANT] The web-vault requires the use of HTTPS and a secure context for the Web Crypto API.
That means it will only work if you enable HTTPS.
We also suggest to use a reverse proxy.

The recommended way to install and use Vaultwarden is via our container images which are published to ghcr.io, docker.io and quay.io. See which container image to use for an explanation of the provided tags.

There are also community driven packages which can be used, but those might be lagging behind the latest version or might deviate in the way Vaultwarden is configured, as described in our Wiki.

Alternatively, you can also build Vaultwarden yourself.

While Vaultwarden is based upon the Rocket web framework which has built-in support for TLS our recommendation would be that you setup a reverse proxy (see proxy examples).

[!TIP] For more detailed examples on how to install, use and configure Vaultwarden you can check our Wiki.

Docker/Podman CLI

Pull the container image and mount a volume from the host for persistent storage.
You can replace docker with podman if you prefer to use 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

This will preserve any persistent data under /vw-data/, you can adapt the path to whatever suits you.

Docker Compose

To use Docker compose you need to create a compose.yaml which will hold the configuration to run the Vaultwarden container.

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

Get in touch

Have a question, suggestion or need help? Join our community on Matrix, GitHub Discussions or Discourse Forums.

Encountered a bug or crash? Please search our issue tracker and discussions to see if it's already been reported. If not, please start a new discussion or create a new issue. Ensure you're using the latest version of Vaultwarden and there aren't any similar issues open or closed!


Contributors

Thanks for your contribution to the project!

Contributors Count
Contributors Avatars


Disclaimer

This project is not associated with Bitwarden or Bitwarden, Inc.

However, one of the active maintainers for Vaultwarden is employed by Bitwarden and is allowed to contribute to the project on their own time. These contributions are independent of Bitwarden and are reviewed by other maintainers.

The maintainers work together to set the direction for the project, focusing on serving the self-hosting community, including individuals, families, and small organizations, while ensuring the project's sustainability.

Please note: We cannot be held liable for any data loss that may occur while using Vaultwarden. This includes passwords, attachments, and other information handled by the application. We highly recommend performing regular backups of your files and database. However, should you experience data loss, we encourage you to contact us immediately.


Bitwarden_RS

This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues.
Please see #1642 - v1.21.0 release and project rename to Vaultwarden for more explanation.

vaultwarden (dani-garcia/vaultwarden)

Searching Database…

69.2K ·GitHub
Vaultwarden
这是什么？Vaultwarden 是一个用 Rust 编写的非官方服务端，实现了 Bitwarden 客户端 API，因此你可以自己运行密码管理器的后端，而无需使用 Bitwarden 官方的托管服务。
它是官方 Bitwarden 服务端的直接替代品，还是别的东西？它是一个轻量级的替代服务端，与官方 Bitwarden 客户端（移动端、桌面端、浏览器扩展和命令行工具）使用相同的 API，因此这些应用无需修改即可连接到它，但它并非由 Bitwarden Inc. 制作或背书。
我该如何让它运行起来？推荐的方式是拉取发布在 ghcr.io、docker.io 或 quay.io 上的容器镜像，并挂载一个卷用于持久化存储；也支持通过 compose.yaml 文件使用 Docker Compose。如果你不想使用容器，也可以从源代码自行构建。
除了 Docker，要让它正常运行还需要别的东西吗？内置的网页版密码库依赖 Web Crypto API，因此必须使用 HTTPS 或安全上下文才能正常工作。即使底层的 Rocket 框架内置了 TLS 支持，仍强烈建议在前面加一个带 TLS 的反向代理。
在用它保存密码之前，我需要了解什么？维护者明确表示，对于数据丢失概不负责，并建议定期备份文件和数据库；另外，由于 Vaultwarden 是非官方的重新实现，相关问题应向 Vaultwarden 自己的渠道反馈，切勿向 Bitwarden 官方支持提交。
这是面向哪些人的？它面向自托管社区，包括个人、家庭和小型组织，这些用户希望拥有自己的密码库，又不想承担官方资源占用较大的服务所带来的负担。
我的密码库数据是否保存在本地，并由我自己掌控？是的，Vaultwarden 是自托管的，因此你加密后的密码库数据会保存在你自己的服务器或容器中，而不是 Bitwarden 的云端。
Vaultwarden 支持双因素认证吗？支持。它支持多种两步验证（2FA/MFA）方式，包括 TOTP 验证器、电子邮件、FIDO2 WebAuthn、YubiKey 和 Duo。
它能满足团队或家庭共享密码库的需求吗？可以。它实现了组织（Organizations）与集合（Collections）、密码共享、成员角色、群组、事件日志、管理员密码重置、目录连接器以及策略等功能。
为什么它从 bitwarden_rs 更名为 Vaultwarden？项目更名是为了与官方 Bitwarden 服务端保持距离，避免混淆以及商标或品牌方面的问题，具体说明见其 v1.21.0 版本的发布说明。
Bitwarden 网页版密码库是否包含在内？包含。修改过的 Web Vault 客户端直接打包在官方 Vaultwarden 容器镜像中。
What are similar projects?nodewarden, server, ente, ENZO, DnsServer, clients, setup-ipsec-vpn, Self-Hosting-Guide
Which topics is it in?password-manager, selfhosted, self-hosted-ai, vps, homelab, privacy-tools, containers, authentication, encryption, agpl, rust, privacy
Creator
dani-garcia
Size
13 MB
Stars
69.2K
Updated
CommitOct 16Release1.37.4Oct 05
Age
8y
Commits · 90 Days