vaultwarden

Lightweight self-hosted version of Bitwarden

Go to file

Jeremy Lin 90e0b7fec6 Offset scheduled jobs by 5 minutes This is intended to avoid contention with database backups that many users probably schedule to start at exactly the top of an hour.		4 years ago
.github	Misc changes.	4 years ago
docker	Misc changes.	4 years ago
hooks	Add `org.opencontainers` labels to Docker images	4 years ago
migrations	rename send key -> akey	4 years ago
src	Offset scheduled jobs by 5 minutes	4 years ago
tools	global_domains.py: allow syncing to a specific Git ref	4 years ago
.dockerignore	Misc changes.	4 years ago
.editorconfig	Misc changes.	4 years ago
.env.template	Offset scheduled jobs by 5 minutes	4 years ago
.gitattributes	Just ignore scripts	4 years ago
.gitignore	Rename included .env file to .env.template and ignored .env	6 years ago
.hadolint.yaml	add hadolint config file	6 years ago
Cargo.lock	Add a generic job scheduler	4 years ago
Cargo.toml	Add a generic job scheduler	4 years ago
Dockerfile	Change Dockerfiles to make the AMD image multidb	4 years ago
LICENSE.txt	Upload and download attachments, and added License file	7 years ago
README.md	Updated sponsors	4 years ago
Rocket.toml	Document configuration a bit and increase JSON size limit to 10MB	7 years ago
azure-pipelines.yml	Updated the azure-pipelines.yml for multidb	4 years ago
build.rs	Add support for multiple simultaneous database features by using macros.	4 years ago
diesel.toml	Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage.	7 years ago
rust-toolchain	Update dependencies and web vault	4 years ago
rustfmt.toml	Formatting	5 years ago

README.md

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

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 bitwardenrs/server:latest
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 bitwardenrs/server:latest

This will preserve any persistent data under /bw-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 bitwarden_rs 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 bitwarden_rs wiki for more information on how to configure and run the bitwarden_rs 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 bitwarden_rs 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 #bitwarden_rs:matrix.org room on Matrix. Feel free to join us!