Repository files navigation

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

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

• Personal Vault
• Send
• Attachments
• Website icons
• Personal API Key
• Organizations
  • Collections,Password Sharing,Member Roles,Groups,Event Logs,Admin Password Reset,Directory Connector,Policies
• Multi/Two Factor Authentication
  • Authenticator,Email,FIDO2 WebAuthn,YubiKey,Duo
• Emergency Access
• Vaultwarden Admin Backend
• Modified Web Vault client (Bundled within our containers)

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

There are alsocommunity 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 ourWiki.

Alternatively, you can alsobuild Vaultwarden yourself.

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

Pull the container image and mount a volume from the host for persistent storage.
You can replacedocker withpodman if you prefer to use podman.

docker pull vaultwarden/server:latestdocker 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.

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

services:vaultwarden:image:vaultwarden/server:latestcontainer_name:vaultwardenrestart:unless-stoppedenvironment:DOMAIN:"https://vw.domain.tld"volumes:      -./vw-data/:/data/ports:      -127.0.0.1:8000:80

Have a question, suggestion or need help? Join our community onMatrix,GitHub Discussions orDiscourse Forums.

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

Thanks for your contribution to the project!

This project is not associated withBitwarden 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.

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.