hacktoberfest docker vaultwarden rust rocket bitwarden-rs bitwarden

Yonas Yanfa 3eda1ddf4a Improvements to README.md Various improvements to the README.md		7 months ago
.github	Update web-vault, crates and gha (#4909)	8 months ago
docker	Update Rust version & crates (#4928)	7 months ago
migrations	Add support for MFA with Duo's Universal Prompt (#4637)	9 months ago
resources	use a custom 404 page	2 years ago
src	Add orgUserHasExistingUser parameters to org invite (#4827)	8 months ago
tools	Change API and structs to camelCase (#4386)	10 months ago
.dockerignore	Switch to Whitelisting in .dockerignore (#4856)	8 months ago
.editorconfig	Misc changes.	4 years ago
.env.template	Allow enforcing Single Org with pw reset policy (#4903)	8 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)	2 years ago
.pre-commit-config.yaml	Update Rust, Crates and GHA (#4783)	9 months ago
Cargo.lock	Update Rust version & crates (#4928)	7 months ago
Cargo.toml	Update Rust version & crates (#4928)	7 months ago
Dockerfile	Container building changes (#3958)	2 years ago
LICENSE.txt	Re-License Vaultwarden to AGPLv3	2 years ago
README.md	Improvements to README.md	7 months ago
SECURITY.md	Updated security readme (#4892)	8 months ago
build.rs	Fix some nightly build errors (#4657)	10 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 version & crates (#4928)	7 months ago
rustfmt.toml	Upd Crates, Rust, MSRV, GHA and remove Backtrace	2 years ago

README.md

Vaultwarden

Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients.

Vaultwarden is the perfect self-hosted solution when running the official service is too resource-heavy.

[!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.

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

[!TIP] Please report any bugs or suggestions to us directly, regardless of whatever clients you are using (mobile, desktop, browser...).

Do not use the official support channels.

Features

A full implementation of the Bitwarden API:

Organizations
Attachments and send
Vault API
Serving static files
Website icons
Authenticator and U2F
YubiKey and Duo
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.

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.

Usage

See the vaultwarden wiki.

Get in touch ☕

Discussions

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.

Issues

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!

Chat

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