lasers
/
bitwarden_rs
mirror of https://github.com/dani-garcia/bitwarden_rs
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
bitwarden_rs/README.md

47 lines
2.2 KiB
Markdown
Raw Normal View History

Updated dependencies, added Travis CI integration and some badges
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.
---
[![Travis Build Status](https://travis-ci.org/dani-garcia/bitwarden_rs.svg?branch=master)](https://travis-ci.org/dani-garcia/bitwarden_rs)
[![Dependency Status](https://deps.rs/repo/github/dani-garcia/bitwarden_rs/status.svg)](https://deps.rs/repo/github/dani-garcia/bitwarden_rs)
[![GitHub Release](https://img.shields.io/github/release/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/releases/latest)
[![GPL-3.0 Licensed](https://img.shields.io/github/license/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/blob/master/LICENSE.txt)
[![Matrix Chat](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#bitwarden_rs:matrix.org)
Fixed docker build and implemented automatic creation of JWT signing keys on platforms with OpenSSL (it needs to be on the PATH)
2018-02-17 01:13:02 +01:00
Update readme for docker hub
2018-05-25 17:15:31 +02:00
Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/bitwarden_rs).
First working version
2018-02-10 01:00:55 +01:00
Update readme for docker hub
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._
First working version
2018-02-10 01:00:55 +01:00
Updated dependencies, added Travis CI integration and some badges
2018-08-24 17:07:11 +02:00
---
Update readme for docker hub
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
Add systemd setup instructions to README.md
2018-12-15 23:25:17 +01:00
* Vault API support
Update readme for docker hub
2018-05-25 17:15:31 +02:00
* Serving the static files for Vault interface
* Website icons API
Documented U2F, removed debug prints, and documented missing features
2018-07-13 15:58:50 +02:00
* Authenticator and U2F support
Adds Yubikey OTP Support to Readme
2018-11-16 02:59:16 +01:00
* YubiKey OTP
Add systemd setup instructions to README.md
2018-12-15 23:25:17 +01:00
Remove redundant information from README after moving it to the wiki
2019-01-01 03:03:06 +01:00
## Installation
Pull the docker image and mount a volume from the host for persistent storage:
First working version
2018-02-10 01:00:55 +01:00
Update dependencies and bundle SQLite with the program, so we have one less dependency to install separately
2018-05-07 21:33:54 +02:00
```sh
Update readme for docker hub
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
Added unofficial note and better organized the README file
2018-06-29 14:47:23 +02:00
```
Remove redundant information from README after moving it to the wiki
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.
Add info on running over HTTP (documentation for #153)
2018-09-03 11:53:52 +02:00
Remove redundant information from README after moving it to the wiki
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.
Add info on running over HTTP (documentation for #153)
2018-09-03 11:53:52 +02:00
Readme updates (chat, arch, TOC)
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.
Update matrix.to link in the README Using the room ID instead of an alias isn't supposed to be working for joining rooms, and doesn't work when joining over federation. It only works when your server is already participating in the room.
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!