Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs
Go to file
Daniel García d3bd2774dc
Update dependencies to use newer SQLite
2019-10-11 22:49:47 +02:00
docker Add sqlite binary into the docker images 2019-09-30 13:54:06 +01:00
migrations Added a migration that fixes #1 which caused attachments to be broken 2019-09-16 19:52:00 -04:00
src Fixed a bug with the sqlite backup feature. 2019-10-11 12:08:40 +02:00
.dockerignore Include git repo in build so we get version 2019-02-16 08:50:16 +00:00
.env.template Updated dependencies and fixed disable_admin_token description 2019-10-08 19:33:27 +02:00
.gitignore Rename included .env file to .env.template and ignored .env 2019-01-06 22:50:30 +01:00
.hadolint.yaml add hadolint config file 2019-07-05 11:06:44 +02:00
.travis.yml add hadolint to travisfile 2019-07-04 15:59:50 +02:00
Cargo.lock Update dependencies to use newer SQLite 2019-10-11 22:49:47 +02:00
Cargo.toml Update dependencies to use newer SQLite 2019-10-11 22:49:47 +02:00
Dockerfile Symlink amd64 Dockerfile to repo root 2019-06-24 09:59:43 +01:00
LICENSE.txt Upload and download attachments, and added License file 2018-02-15 00:40:34 +01:00
README.md Very simple grammar updates 2019-10-09 22:22:52 +10:30
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 syslog from ci, make features flag more clear 2019-05-30 22:19:58 +02:00
build.rs Adds support for PostgreSQL which resolves #87 and is mentioned in #246. 2019-09-12 16:12:22 -04: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 and web vault version 2019-08-27 21:14:15 +02: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 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, raising an issue is fine. Please also 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!