Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Mathijs van Veluw 8c10de3edd
Merge pull request #1978 from benarmstead/main
1 day ago
.github Optimize release workflow. 5 days ago
docker Optimize release workflow. 5 days ago
hooks Optimize release workflow. 5 days ago
migrations Added web-vault v2.21.x support + some misc fixes 3 months ago
resources Storing the original Vaultwarden svg images 3 months ago
src Merge branch 'issue-1963' of https://github.com/BlackDex/vaultwarden into BlackDex-issue-1963 1 week ago
tools global_domains.py: allow syncing to a specific Git ref 8 months ago
.dockerignore Misc changes. 6 months ago
.editorconfig Misc changes. 6 months ago
.env.template Merge branch 'attachment-storage' of https://github.com/BlackDex/vaultwarden into BlackDex-attachment-storage 2 months ago
.gitattributes Just ignore scripts 6 months ago
.gitignore Rename included .env file to .env.template and ignored .env 3 years ago
.hadolint.yaml add hadolint config file 2 years ago
.pre-commit-config.yaml Adding pre-commit config 3 months ago
Cargo.lock Update dependencies in Cargo.lock 2 days ago
Cargo.toml Update dependencies in cargo.toml 2 days ago
Dockerfile Change Dockerfiles to make the AMD image multidb 1 year ago
LICENSE.txt Upload and download attachments, and added License file 4 years ago
README.md Fix sponsors 4 months ago
Rocket.toml Document configuration a bit and increase JSON size limit to 10MB 3 years ago
SECURITY.md Adding a SECURITY.md 3 months ago
build.rs Fix branch name 5 months ago
diesel.toml Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage. 3 years ago
rust-toolchain Dependency updates 4 weeks ago
rustfmt.toml Modify rustfmt file 5 months ago

README.md

Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.

📢 Note: 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 for more explanation.


Docker Pulls Dependency Status GitHub Release GPL-3.0 Licensed Matrix Chat

Image is based on Rust implementation of Bitwarden API.

This project is not associated with the Bitwarden project nor 8bit Solutions LLC.

⚠️IMPORTANT⚠️: When using this server, please report any bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official support channels.


Features

Basically full implementation of Bitwarden API is provided including:

  • Organizations support
  • Attachments
  • Vault API support
  • Serving the static files for Vault interface
  • Website icons API
  • Authenticator and U2F support
  • YubiKey and Duo support

Installation

Pull the docker image and mount a volume from the host for persistent storage:

docker pull vaultwarden/server:latest
docker run -d --name vaultwarden -v /vw-data/:/data/ -p 80:80 vaultwarden/server:latest

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

IMPORTANT: Some web browsers, like Chrome, disallow the use of Web Crypto APIs in insecure contexts. In this case, you might get an error like Cannot read property 'importKey'. To solve this problem, you need to access the web vault from HTTPS.

This can be configured in vaultwarden directly or using a third-party reverse proxy (some examples).

If you have an available domain name, you can get HTTPS certificates with Let's Encrypt, or you can generate self-signed certificates with utilities like mkcert. Some proxies automatically do this step, like Caddy (see examples linked above).

Usage

See the vaultwarden wiki for more information on how to configure and run the vaultwarden server.

Get in touch

To ask a question, offer suggestions or new features or to get help configuring or installing the software, please use the forum.

If you spot any bugs or crashes with vaultwarden itself, please create an issue. Make sure there aren't any similar issues open, though!

If you prefer to chat, we're usually hanging around at #vaultwarden:matrix.org room on Matrix. Feel free to join us!

Sponsors

Thanks for your contribution to the project!

netdadaltd
netDada Ltd.

Chono N
Chris Alfano