Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs
Find a file
Jeremy Lin a2162f4d69
Allow listening on privileged ports (below 1024) as non-root
This is done by running `setcap cap_net_bind_service=+ep` on the executable
in the build stage (doing it in the runtime stage creates an extra copy of
the executable that bloats the image). This only works when using the
BuildKit-based builder, since the `COPY` instruction doesn't copy
capabilities on the legacy builder.
2023-02-01 00:35:33 -08:00
.github Rename .buildx Dockerfiles to .buildkit 2023-01-24 13:11:12 -08:00
docker Allow listening on privileged ports (below 1024) as non-root 2023-02-01 00:35:33 -08:00
hooks Rename .buildx Dockerfiles to .buildkit 2023-01-24 13:11:12 -08:00
migrations Add avatar color support 2023-01-12 19:18:57 +01:00
resources use a custom 404 page 2022-12-05 00:08:46 +01:00
src Validate note sizes on key-rotation. 2023-01-24 20:05:09 +01:00
tools global_domains.py: allow syncing to a specific Git ref 2021-02-03 12:20:44 -08:00
.dockerignore Update async to prepare for main merge 2022-02-22 20:00:33 +01:00
.editorconfig Misc changes. 2021-03-30 21:45:10 +02:00
.env.template Update KDF Configuration and processing 2023-01-24 19:49:12 +01: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 Disable Hadolint check for consecutive RUN instructions (DL3059) 2023-01-24 13:11:13 -08:00
.pre-commit-config.yaml Disable groups by default and Some optimizations 2022-12-16 14:52:42 +01:00
build.rs Add dev-only query logging support 2022-12-03 18:36:46 +01:00
Cargo.lock Updated web vault to 2023.1.1 and rust dependencies 2023-01-24 20:39:09 +01:00
Cargo.toml Updated web vault to 2023.1.1 and rust dependencies 2023-01-24 20:39:09 +01:00
clippy.toml Resolve uninlined_format_args clippy warnings 2023-01-09 20:13:48 +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
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 Update sponsors 2022-10-23 00:49:06 +02:00
rust-toolchain Update Rust to v1.66.1 to patch CVE 2023-01-12 19:18:57 +01:00
rustfmt.toml Improve sync speed and updated dep. versions 2022-05-06 17:01:02 +02:00
SECURITY.md Adding a SECURITY.md 2021-06-26 11:49:00 +02:00

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.


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 Bitwarden, Inc.

⚠️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!

Sponsors

Thanks for your contribution to the project!

Chris Alfano
Numberly