vaultwarden

Lightweight self-hosted version of Bitwarden

Go to file

Daniel García d420992f8c Update some function calls to use ?		6 years ago
migrations	Fix attachments during key rotation, add individual attachment key	6 years ago
src	Update some function calls to use ?	6 years ago
.dockerignore	Fixed docker build and implemented automatic creation of JWT signing keys on platforms with OpenSSL (it needs to be on the PATH)	7 years ago
.env.template	Fix folder notifications, enable template strict mode and add missing option to env template	6 years ago
.gitignore	Rename included .env file to .env.template and ignored .env	6 years ago
.travis.yml	Implemented proper logging, with support for file logging, timestamp and syslog (this last one is untested)	6 years ago
Cargo.lock	Update dependencies	6 years ago
Cargo.toml	Initial stab at templates	6 years ago
Dockerfile	Update dependencies and web vault	6 years ago
Dockerfile.aarch64	Revert yubikey feature, not needed anymore	6 years ago
Dockerfile.alpine	Update dependencies and web vault	6 years ago
Dockerfile.armv7	Update dependencies and web vault	6 years ago
LICENSE.txt	Upload and download attachments, and added License file	7 years ago
README.md	Include warning to not report bugs upstream	6 years ago
Rocket.toml	Document configuration a bit and increase JSON size limit to 10MB	7 years ago
build.rs	Add build script to get some Git info to later show in admin panel, and add some metadata to Cargo.toml	6 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	Of course I forgot the year...	6 years ago
rustfmt.toml	Start using rustfmt and some style changes to make some lines shorter	6 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.

Features

Basically full implementation of Bitwarden API is provided including:

Basic single user functionality
Organizations support
Attachments
Vault API support
Serving the static files for Vault interface
Website icons API
Authenticator and U2F support
YubiKey OTP

Installation

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

docker pull mprasil/bitwarden:latest
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 mprasil/bitwarden: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 an question, raising an issue is fine, also please report any bugs spotted here.

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