You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Daniel García 84ed185579
Update u2f to 0.2, which requires OpenSSL but also might solve the problems we've had with certificates.
2 months ago
.github Delete old workflow file and disable building binaries on pull requests, as we already have CI for that 3 months ago
docker Update u2f to 0.2, which requires OpenSSL but also might solve the problems we've had with certificates. 2 months ago
migrations Implement change-email, email-verification, account-recovery, and welcome notifications 4 months ago
src Update u2f to 0.2, which requires OpenSSL but also might solve the problems we've had with certificates. 2 months ago
.dockerignore Include git repo in build so we get version 1 year ago
.env.template Config option for client IP header 3 months ago
.gitignore Rename included .env file to .env.template and ignored .env 1 year ago
.hadolint.yaml add hadolint config file 9 months ago
.travis.yml Change CI to run tests 4 months ago
Cargo.lock Update u2f to 0.2, which requires OpenSSL but also might solve the problems we've had with certificates. 2 months ago
Cargo.toml Update u2f to 0.2, which requires OpenSSL but also might solve the problems we've had with certificates. 2 months ago
Dockerfile Symlink amd64 Dockerfile to repo root 9 months ago
LICENSE.txt Upload and download attachments, and added License file 2 years ago
README.md Add contributor 2 months ago
Rocket.toml Document configuration a bit and increase JSON size limit to 10MB 1 year ago
azure-pipelines.yml Change CI to run tests 4 months ago
build.rs Adds support for PostgreSQL which resolves #87 and is mentioned in #246. 6 months ago
diesel.toml Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage. 1 year ago
rust-toolchain Update docker images to alpine 3.11 and rust 1.40 3 months ago
rustfmt.toml Formatting 3 months 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.


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!

Sponsors

Thanks for your contribution to the project!