OpenSource/vaultwarden: Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs

mirror of https://github.com/dani-garcia/vaultwarden.git synced 2024-11-27 01:28:19 +01:00

Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs

bitwarden bitwarden-rs docker hacktoberfest rocket rust vaultwarden

Find a file

theycallmesteve 08afc312c3 Add missing items to profileOrganization response model		2020-05-08 13:39:17 -04:00
.github
docker	Make web vault show a more informative error when browsers block WebCrypto in insecure contexts and update dependencies	2020-04-09 22:54:31 +02:00
migrations	Initial support for soft deletes	2020-04-17 22:35:27 +02:00
src	Add missing items to profileOrganization response model	2020-05-08 13:39:17 -04:00
.dockerignore
.env.template	Config option for client IP header	2019-12-27 18:42:39 +01:00
.gitignore
.hadolint.yaml
.travis.yml
azure-pipelines.yml
build.rs
Cargo.lock	Change the mails content types to more closely match what we sent before	2020-05-07 00:51:46 +02:00
Cargo.toml	Change the mails content types to more closely match what we sent before	2020-05-07 00:51:46 +02:00
diesel.toml
Dockerfile
LICENSE.txt
README.md
Rocket.toml
rust-toolchain	Make web vault show a more informative error when browsers block WebCrypto in insecure contexts and update dependencies	2020-04-09 22:54:31 +02:00
rustfmt.toml

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:

Single user functionality
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!