vaultwarden

Lightweight self-hosted version of Bitwarden

Go to file

Stefan Melmuk fda77afc2a add group support for Cipher::get_collections() (#4592 ) * add group support for Cipher::get_collections() join group infos assigned to a collection to check whether user has been given access to all collections via any group or they have access to a specific collection via any group membership * fix Collection::is_writable_by_user() prevent side effects if groups are disabled * differentiate the /collection endpoints * return cipherDetails on post_collections_update() * add collections_v2 endpoint		5 months ago
.github	Remove duplicate registry step (#4703 )	5 months ago
docker	Remove mimalloc workaround (#4606 )	5 months ago
migrations	Change timestamp data type. (#4355 )	8 months ago
resources	use a custom 404 page	2 years ago
src	add group support for Cipher::get_collections() (#4592 )	5 months ago
tools	Change API and structs to camelCase (#4386 )	5 months ago
.dockerignore	Update async to prepare for main merge	3 years ago
.editorconfig	Misc changes.	4 years ago
.env.template	Improve commentary aesthetics (#4549 )	6 months ago
.gitattributes	Just ignore scripts	4 years ago
.gitignore	Rename included .env file to .env.template and ignored .env	6 years ago
.hadolint.yaml	Container building changes (#3958 )	1 year ago
.pre-commit-config.yaml	Container building changes (#3958 )	1 year ago
Cargo.lock	Update crates, web-vault and GHA (#4648 )	5 months ago
Cargo.toml	Fix some more nightly errors and remove lint that will become an error by default (#4661 )	5 months ago
Dockerfile	Container building changes (#3958 )	1 year ago
LICENSE.txt	Re-License Vaultwarden to AGPLv3	2 years ago
README.md	Update README.md	11 months ago
SECURITY.md	Adding a SECURITY.md	3 years ago
build.rs	Fix some nightly build errors (#4657 )	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.	7 years ago
rust-toolchain.toml	Update rust and remove unused header values (#4645 )	5 months ago
rustfmt.toml	Upd Crates, Rust, MSRV, GHA and remove Backtrace	2 years 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.

Image is based on Rust implementation of Bitwarden API.

This project is not associated with the Bitwarden project nor Bitwarden, Inc.

⚠️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 and Send
Vault API support
Serving the static files for Vault interface
Website icons API
Authenticator and U2F support
YubiKey and Duo support
Emergency Access

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/ --restart unless-stopped -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: Most modern web browsers 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 via HTTPS or localhost.

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 GitHub Discussions or the forum.

If you spot any bugs or crashes with vaultwarden itself, please create an issue. Make sure you are on the latest version and 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!