vaultwarden/README.md

2.2 KiB

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 Dependency Status GitHub Release GPL-3.0 Licensed Matrix Chat

Image is based on Rust implementation of Bitwarden API.

*Note, that 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.

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!