vividboarder
/
bitwarden_rs
mirror of https://github.com/ViViDboarder/bitwarden_rs.git
1
0
Fork 0
Code Issues Releases Wiki Activity
1,229 Commits 8 Branches 32 Tags 5 MiB
JavaScript 50.3%
Rust 31.4%
HTML 14.3%
Dockerfile 1.5%
RenderScript 1%
Other 1.4%
Go to file
Jeremy Lin 9621278fca Add a script to auto-generate the global equivalent domains JSON file 
The script works by reading the relevant files from the upstream Bitwarden
source repo and generating a matching JSON file. It could potentially be
integrated into the build/release process, but for now it can be run manually
as needed.
 		2020-08-06 12:12:32 -07:00
.github Delete ISSUE_TEMPLATE.md 2020-03-02 19:58:53 +01:00
docker Multi-arch image support 2020-07-15 20:03:34 -07:00
hooks Push an extra `latest-arm32v6` tag 2020-07-26 15:28:14 -07:00
migrations Add support for hiding passwords in a collection 2020-07-02 21:51:20 -07:00
src Fix unlock on desktop clients 2020-08-04 15:12:04 +02:00
tools Add a script to auto-generate the global equivalent domains JSON file 2020-08-06 12:12:32 -07:00
.dockerignore Include git repo in build so we get version 2019-02-16 08:50:16 +00:00
.env.template Log timestamps with milliseconds by default 2020-07-23 14:19:51 -07:00
.gitignore Rename included .env file to .env.template and ignored .env 2019-01-06 22:50:30 +01:00
.hadolint.yaml add hadolint config file 2019-07-05 11:06:44 +02:00
.travis.yml Change CI to run tests 2019-11-30 23:32:31 +01:00
Cargo.lock Updated dependencies and changed rocket request imports 2020-07-23 21:07:04 +02:00
Cargo.toml Updated dependencies and changed rocket request imports 2020-07-23 21:07:04 +02:00
Dockerfile Symlink amd64 Dockerfile to repo root 2019-06-24 09:59:43 +01:00
LICENSE.txt Upload and download attachments, and added License file 2018-02-15 00:40:34 +01:00
README.md Update README.md 2020-03-02 19:37:49 +01:00
Rocket.toml Document configuration a bit and increase JSON size limit to 10MB 2018-06-29 23:11:15 +02:00
azure-pipelines.yml Change CI to run tests 2019-11-30 23:32:31 +01:00
build.rs Set the cargo version and allow changing it during build time with BWRS_VERSION. 2020-03-22 16:13:34 +01:00
diesel.toml Updated dependencies and created 'rust-toolchain', to mark a working nightly to rustup users, and hopefully avoid some nightly breakage. 2018-06-12 17:30:36 +02:00
rust-toolchain Replace IP support in preparation for compiling on stable, included some tests to check that the code matches the unstable implementation 2020-07-15 00:00:03 +02:00
rustfmt.toml Formatting 2019-12-27 18:37:14 +01:00

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 bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), 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:

  • Single user functionality
  • Organizations support
  • Attachments
  • Vault API support
  • Serving the static files for Vault interface
  • Website icons API
  • Authenticator and U2F support
  • YubiKey and Duo support

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, offer suggestions or new features or to get help configuring or installing the software, please use the forum.

If you spot any bugs or crashes with bitwarden_rs itself, please create an issue. Make sure there aren't any similar issues open, though!

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!