2018-08-24 17:07:11 +02:00
### This is a Bitwarden server API implementation written in Rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
---
[](https://travis-ci.org/dani-garcia/bitwarden_rs)
2019-01-08 20:27:55 +01:00
[](https://hub.docker.com/r/mprasil/bitwarden)
2018-08-24 17:07:11 +02:00
[](https://deps.rs/repo/github/dani-garcia/bitwarden_rs)
[](https://github.com/dani-garcia/bitwarden_rs/releases/latest)
[](https://github.com/dani-garcia/bitwarden_rs/blob/master/LICENSE.txt)
2019-01-08 20:27:55 +01:00
[](https://matrix.to/#/#bitwarden_rs:matrix.org)
2018-02-17 01:13:02 +01:00
2018-05-25 17:15:31 +02:00
Image is based on [Rust implementation of Bitwarden API ](https://github.com/dani-garcia/bitwarden_rs ).
2018-02-10 01:00:55 +01:00
2018-05-25 17:15:31 +02:00
_*Note, that this project is not associated with the [Bitwarden ](https://bitwarden.com/ ) project nor 8bit Solutions LLC._
2018-02-10 01:00:55 +01:00
2018-08-24 17:07:11 +02:00
---
2018-05-25 17:15:31 +02:00
## Features
Basically full implementation of Bitwarden API is provided including:
* Basic single user functionality
* Organizations support
* Attachments
2018-12-15 23:25:17 +01:00
* Vault API support
2018-05-25 17:15:31 +02:00
* Serving the static files for Vault interface
* Website icons API
2018-07-13 15:58:50 +02:00
* Authenticator and U2F support
2018-11-16 02:59:16 +01:00
* YubiKey OTP
2018-12-15 23:25:17 +01:00
2019-01-01 03:03:06 +01:00
## Installation
Pull the docker image and mount a volume from the host for persistent storage:
2018-02-10 01:00:55 +01:00
2018-05-07 21:33:54 +02:00
```sh
2018-05-25 17:15:31 +02:00
docker pull mprasil/bitwarden:latest
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 mprasil/bitwarden:latest
2018-06-29 14:47:23 +02:00
```
2019-01-01 03:03:06 +01:00
This will preserve any persistent data under /bw-data/, you can adapt the path to whatever suits you.
2018-09-03 11:53:52 +02:00
2019-01-01 03:03:06 +01:00
## Usage
See the [bitwarden_rs wiki ](https://github.com/dani-garcia/bitwarden_rs/wiki ) for more information on how to configure and run the bitwarden_rs server.
2018-09-03 11:53:52 +02:00
2018-07-13 11:48:49 +02:00
## Get in touch
To ask an question, [raising an issue ](https://github.com/dani-garcia/bitwarden_rs/issues/new ) is fine, also please report any bugs spotted here.
2018-07-26 23:42:02 +02:00
If you prefer to chat, we're usually hanging around at [#bitwarden_rs:matrix.org ](https://matrix.to/#/#bitwarden_rs:matrix.org ) room on Matrix. Feel free to join us!
