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.3K ·GitHub
Vaultwarden
Что это такое?Vaultwarden — неофициальный сервер на Rust, который реализует Bitwarden Client API. Поэтому можно запустить собственный бэкенд менеджера паролей вместо официального облачного сервиса Bitwarden.
Это полная замена официальному серверу Bitwarden или что-то другое?Это облегчённый альтернативный сервер, который работает с тем же API, что и официальные клиенты Bitwarden (мобильные, десктопные, расширения для браузеров, CLI). Поэтому эти приложения подключаются к нему без изменений, но он не создан и не одобрен компанией Bitwarden Inc.
Как это запустить?Рекомендуемый способ — загрузить образ контейнера, опубликованный на ghcr.io, docker.io или quay.io, и подключить том для постоянного хранения данных. Также поддерживается Docker Compose через файл compose.yaml. Можно собрать сервер и из исходного кода, если не хотите использовать контейнеры.
Нужно ли мне что-то помимо Docker, чтобы всё работало нормально?Для работы встроенного веб-хранилища нужен HTTPS или защищённый контекст, так как оно использует Web Crypto API. Поэтому настоятельно рекомендуется обратный прокси с TLS, хотя фреймворк Rocket, на котором всё построено, и сам умеет работать с TLS.
Что нужно знать, прежде чем доверять ему свои пароли?Разработчики прямо заявляют, что не несут ответственности за потерю данных, и рекомендуют регулярно создавать резервные копии файлов и базы данных. Кроме того, об ошибках нужно сообщать в собственные каналы Vaultwarden, но никогда в официальную поддержку Bitwarden, так как это неофициальная реализация.
Для кого это предназначено?Это ориентировано на сообщество самохостинга — частных лиц, семьи и небольшие организации, которые хотят иметь собственное хранилище паролей без нагрузки, которую создаёт тяжёлый официальный сервис.
Хранятся ли данные моего хранилища локально и под моим контролем?Да, Vaultwarden разворачивается самостоятельно. Поэтому ваши зашифрованные данные остаются на вашем сервере или в вашем контейнере, а не в облаке Bitwarden.
Поддерживает ли Vaultwarden двухфакторную аутентификацию?Да, поддерживается несколько методов 2FA/MFA, включая TOTP Authenticator, электронную почту, FIDO2 WebAuthn, YubiKey и Duo.
Можно ли использовать его в команде или семье с общими хранилищами?Да, реализованы организации с коллекциями, общий доступ к паролям, роли участников, группы, журналы событий, сброс пароля администратором, directory connector и политики.
Почему его переименовали из 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.3K
Updated
CommitOct 16Release1.37.4Oct 05
Age
8y
Commits · 90 Days