Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs
Go to file
Daniel García 1eb1502a07
Merge pull request #416 from mprasil/armv6
Armv6
2019-02-25 18:26:53 +01:00
migrations Fix attachments during key rotation, add individual attachment key 2018-11-27 17:24:12 +01:00
src Minor typo fix conect => connect 2019-02-24 16:08:38 -08:00
.dockerignore Include git repo in build so we get version 2019-02-16 08:50:16 +00:00
.env.template Allow the Admin token to be disabled in the advanced menu 2019-02-20 14:56:08 -06:00
.gitignore Rename included .env file to .env.template and ignored .env 2019-01-06 22:50:30 +01:00
.travis.yml Remove verbose, otherwise the logs get filled with useless info 2019-02-22 16:16:07 +01:00
Cargo.lock Updated dependencies, removed some unnecessary clones and fixed some lints 2019-02-20 17:54:18 +01:00
Cargo.toml Updated dependencies, removed some unnecessary clones and fixed some lints 2019-02-20 17:54:18 +01:00
Dockerfile Update web-vault to fix U2F NotTrustedAnchor error 2019-01-24 18:43:22 +01:00
Dockerfile.aarch64 Update web-vault to fix U2F NotTrustedAnchor error 2019-01-24 18:43:22 +01:00
Dockerfile.alpine Update web-vault to fix U2F NotTrustedAnchor error 2019-01-24 18:43:22 +01:00
Dockerfile.armv6 Symlink missing ld-linux file 2019-02-25 16:17:34 +00:00
Dockerfile.armv7 Update web-vault to fix U2F NotTrustedAnchor error 2019-01-24 18:43:22 +01:00
LICENSE.txt Upload and download attachments, and added License file 2018-02-15 00:40:34 +01:00
README.md Include warning to not report bugs upstream 2019-01-11 13:54:43 +01:00
Rocket.toml Document configuration a bit and increase JSON size limit to 10MB 2018-06-29 23:11:15 +02:00
azure-pipelines.yml Remove verbose, otherwise the logs get filled with useless info 2019-02-22 16:16:07 +01:00
build.rs Show version in admin panel 2019-02-10 16:02:46 +01:00
diesel.toml Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage. 2018-06-12 17:30:36 +02:00
rust-toolchain Updated dependencies 2019-02-06 17:34:29 +01:00
rustfmt.toml Start using rustfmt and some style changes to make some lines shorter 2018-12-30 23:34:31 +01:00

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.


Travis Build Status Docker Pulls Dependency Status GitHub Release GPL-3.0 Licensed Matrix Chat

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!