vaultwarden

mirror of https://github.com/dani-garcia/vaultwarden.git synced 2024-12-23 03:19:03 +00:00

Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs

bitwarden bitwarden-rs docker hacktoberfest rocket rust vaultwarden

Go to file

Ben Armstead 9bef2c120c Update dependencies		2021-09-16 14:21:06 +01:00
.github	Optimize release workflow.	2021-09-13 14:42:15 +02:00
docker	Optimize release workflow.	2021-09-13 14:42:15 +02:00
hooks	Optimize release workflow.	2021-09-13 14:42:15 +02:00
migrations	Added web-vault v2.21.x support + some misc fixes	2021-07-04 23:02:56 +02:00
resources	Storing the original Vaultwarden svg images	2021-07-04 18:37:01 +02:00
src	Merge branch 'issue-1963' of https://github.com/BlackDex/vaultwarden into BlackDex-issue-1963	2021-09-09 20:30:29 +02:00
tools	global_domains.py: allow syncing to a specific Git ref	2021-02-03 12:20:44 -08:00
.dockerignore	Misc changes.	2021-03-30 21:45:10 +02:00
.editorconfig	Misc changes.	2021-03-30 21:45:10 +02:00
.env.template	Merge branch 'attachment-storage' of https://github.com/BlackDex/vaultwarden into BlackDex-attachment-storage	2021-07-15 19:20:52 +02:00
.gitattributes	Just ignore scripts	2021-04-01 20:44:58 +01: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
.pre-commit-config.yaml	Adding pre-commit config	2021-06-27 19:11:22 +02:00
build.rs	Fix branch name	2021-04-28 21:46:20 +02:00
Cargo.lock	Update dependencies	2021-09-16 14:21:06 +01:00
Cargo.toml	Dependency updates	2021-08-22 13:46:48 +02: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
Dockerfile	Change Dockerfiles to make the AMD image multidb	2020-08-24 20:58:00 +02:00
LICENSE.txt	Upload and download attachments, and added License file	2018-02-15 00:40:34 +01:00
README.md	Fix sponsors	2021-05-08 19:01:51 +02:00
Rocket.toml	Document configuration a bit and increase JSON size limit to 10MB	2018-06-29 23:11:15 +02:00
rust-toolchain	Dependency updates	2021-08-22 13:46:48 +02:00
rustfmt.toml	Modify rustfmt file	2021-04-06 21:54:42 +01:00
SECURITY.md	Adding a SECURITY.md	2021-06-26 11:49:00 +02:00

README.md

Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.

📢 Note: This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues. Please see #1642 for more explanation.

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:

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 vaultwarden/server:latest
docker run -d --name vaultwarden -v /vw-data/:/data/ -p 80:80 vaultwarden/server:latest

This will preserve any persistent data under /vw-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 vaultwarden 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 vaultwarden wiki for more information on how to configure and run the vaultwarden 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 vaultwarden 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 #vaultwarden:matrix.org room on Matrix. Feel free to join us!