Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs
Go to file
seiuneko 94b077cb2d
Fix env templateto ensure compatibility with systemd's EnvironmentFile parsing (#4315)
* fix: update env template for systemd compatibility

Adjust env template to ensure compatibility with systemd's EnvironmentFile parsing, which only recognizes line-starting comment symbols.

* Refactor SMTP and Rocket settings in .env.template

- Simplify the SMTP_SECURITY and SMTP_PORT options by providing a list of choices and default values
- Clarify the ROCKET_PORT default value depending on the environment (Docker or not)
2024-02-19 16:29:53 +01:00
.github Update GHA Workflows (#4309) 2024-02-03 16:41:25 +01:00
docker Update Rust, crates and web-vault (#4328) 2024-02-08 22:16:29 +01:00
migrations Improve file limit handling (#4242) 2024-01-27 02:43:26 +01:00
resources use a custom 404 page 2022-12-05 00:08:46 +01:00
src Update Rust, crates and web-vault (#4328) 2024-02-08 22:16:29 +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 Fix env templateto ensure compatibility with systemd's EnvironmentFile parsing (#4315) 2024-02-19 16:29:53 +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 Container building changes (#3958) 2023-10-23 00:18:38 +02:00
.pre-commit-config.yaml Container building changes (#3958) 2023-10-23 00:18:38 +02:00
Cargo.lock Update Rust, crates and web-vault (#4328) 2024-02-08 22:16:29 +01:00
Cargo.toml Change the codegen-units for low resources (#4336) 2024-02-10 13:04:08 +01:00
Dockerfile Container building changes (#3958) 2023-10-23 00:18:38 +02:00
LICENSE.txt Re-License Vaultwarden to AGPLv3 2023-01-24 20:49:11 +01:00
README.md Update README.md 2024-01-01 19:44:52 +01:00
SECURITY.md Adding a SECURITY.md 2021-06-26 11:49:00 +02:00
build.rs Update Rust, crates and web-vault (#4328) 2024-02-08 22:16:29 +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.toml Update Rust, crates and web-vault (#4328) 2024-02-08 22:16:29 +01:00
rustfmt.toml Upd Crates, Rust, MSRV, GHA and remove Backtrace 2023-03-07 09:17:42 +01: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.


Build ghcr.io Docker Pulls Quay.io Dependency Status GitHub Release AGPL-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 and Send
  • Vault API support
  • Serving the static files for Vault interface
  • Website icons API
  • Authenticator and U2F support
  • YubiKey and Duo support
  • Emergency Access

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/ --restart unless-stopped -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: Most modern web browsers 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 via HTTPS or localhost.

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 GitHub Discussions or the forum.

If you spot any bugs or crashes with vaultwarden itself, please create an issue. Make sure you are on the latest version and 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
IQ333777