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 d3773a433a
Removed list of mounted routes at startup by default, with option to add it back. This would get annoying when starting the server frequently, because it printed ~130 lines of mostly useless info
1 month ago
migrations Fix attachments during key rotation, add individual attachment key 3 months ago
src Removed list of mounted routes at startup by default, with option to add it back. This would get annoying when starting the server frequently, because it printed ~130 lines of mostly useless info 1 month ago
.dockerignore Fixed docker build and implemented automatic creation of JWT signing keys on platforms with OpenSSL (it needs to be on the PATH) 1 year ago
.env.template Added config option for icon download timeout 1 month ago
.gitignore Rename included .env file to .env.template and ignored .env 2 months ago
.travis.yml Implemented proper logging, with support for file logging, timestamp and syslog (this last one is untested) 3 months ago
Cargo.lock Update deps and fix email check 1 month ago
Cargo.toml Update deps and fix email check 1 month ago
Dockerfile Update web-vault to fix U2F NotTrustedAnchor error 1 month ago
Dockerfile.aarch64 Update web-vault to fix U2F NotTrustedAnchor error 1 month ago
Dockerfile.alpine Update web-vault to fix U2F NotTrustedAnchor error 1 month ago
Dockerfile.armv7 Update web-vault to fix U2F NotTrustedAnchor error 1 month ago
LICENSE.txt Upload and download attachments, and added License file 1 year ago
README.md Include warning to not report bugs upstream 2 months ago
Rocket.toml Document configuration a bit and increase JSON size limit to 10MB 8 months ago
build.rs Show version in admin panel 1 month ago
diesel.toml Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage. 9 months ago
rust-toolchain Updated dependencies 1 month ago
rustfmt.toml Start using rustfmt and some style changes to make some lines shorter 2 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.

⚠️IMPORTANT⚠️: When using this server, please report any Bitwarden related bug-reports or suggestions here, 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:

  • 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!