forked from dani-garcia/vaultwarden
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
153 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,103 @@ | ||
| ### Alternative implementation of the Bitwarden server API written in Rust and 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. | ||
|  | ||
|
|
||
| 📢 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](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation. | ||
| An alternative server implementation of the Bitwarden Client API written in Rust and compatible with [official Bitwarden clients](https://bitwarden.com/download/) [[1](#disclaimer)], perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. | ||
|
|
||
| --- | ||
| [](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) | ||
| [](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden) | ||
| [](https://hub.docker.com/r/vaultwarden/server) | ||
| [](https://quay.io/repository/vaultwarden/server) | ||
| [](https://deps.rs/repo/github/dani-garcia/vaultwarden) | ||
| [](https://github.com/dani-garcia/vaultwarden/releases/latest) | ||
| [](https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt) | ||
| [](https://matrix.to/#/#vaultwarden:matrix.org) | ||
|
|
||
| Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/vaultwarden). | ||
|
|
||
| **This project is not associated with the [Bitwarden](https://bitwarden.com/) 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. | ||
|
|
||
| --- | ||
| [](https://github.com/dani-garcia/vaultwarden/releases/latest) | ||
| [](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden) | ||
| [](https://hub.docker.com/r/vaultwarden/server) | ||
| [](https://quay.io/repository/vaultwarden/server) <br> | ||
| [](https://github.com/dani-garcia/vaultwarden/graphs/contributors) | ||
| [](https://github.com/dani-garcia/vaultwarden/network/members) | ||
| [](https://github.com/dani-garcia/vaultwarden/stargazers) | ||
| [](https://github.com/dani-garcia/vaultwarden/issues) | ||
| [](https://github.com/dani-garcia/vaultwarden/issues?q=is%3Aissue+is%3Aclosed) | ||
| [](https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt) <br> | ||
| [%3D'svg'%5D%2F*%5Blocal-name()%3D'g'%5D%5B2%5D%2F*%5Blocal-name()%3D'text'%5D%5B4%5D&style=flat-square&logo=rust&label=dependencies&color=005AA4)](https://deps.rs/repo/github/dani-garcia/vaultwarden) | ||
| [](https://github.com/dani-garcia/vaultwarden/actions/workflows/release.yml) | ||
| [](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) <br> | ||
| [](https://matrix.to/#/#vaultwarden:matrix.org) | ||
| [](https://github.com/dani-garcia/vaultwarden/discussions) | ||
| [](https://vaultwarden.discourse.group/) | ||
|
|
||
| > [!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 | ||
| Basically full implementation of the Bitwarden Client API is provided including: | ||
|
|
||
| * Vault | ||
| * Send | ||
| * Attachments | ||
| * Website icons | ||
| * Organizations | ||
| * Collections | ||
| * Groups | ||
| * Event logging | ||
| * Directory Connector | ||
| * Multi/Two Factor Authentication | ||
| - Authenticator | ||
| - WebAuthn | ||
| - YubiKey (Fido2) | ||
| - Duo | ||
| * Emergency Access | ||
| * Vaultwarden Admin Backend with diagnostics | ||
| * Modified Web Vault client (Bundled within our containers) | ||
|
|
||
| ## Installation | ||
|
|
||
| Pull the docker image and mount a volume from the host for persistent storage: | ||
|
|
||
| ```sh | ||
| ```shell | ||
| 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](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)). | ||
|
|
||
| If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above). | ||
| > [!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](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)). | ||
| > | ||
| >If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above). | ||
| ## Usage | ||
| See the [vaultwarden wiki](https://github.com/dani-garcia/vaultwarden/wiki) for more information on how to configure and run the vaultwarden server. | ||
|
|
||
| See the [Vaultwarden wiki](https://github.com/dani-garcia/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](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/). | ||
|
|
||
| If you spot any bugs or crashes with vaultwarden itself, please [create an issue](https://github.com/dani-garcia/vaultwarden/issues/). Make sure you are on the latest version and there aren't any similar issues open, though! | ||
| If you spot any bugs or crashes with Vaultwarden itself, please [create an issue](https://github.com/dani-garcia/vaultwarden/issues/). 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](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us! | ||
|
|
||
| ### Sponsors | ||
| <br> | ||
|
|
||
| ### Contributors | ||
|
|
||
| Thanks for your contribution to the project! | ||
|
|
||
| <!-- | ||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/username"> | ||
| <img src="https://avatars.githubusercontent.com/u/725423?s=75&v=4" width="75px;" alt="username"/> | ||
| <br /> | ||
| <sub><b>username</b></sub> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <br/> | ||
| --> | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/themightychris" style="width: 75px"> | ||
| <sub><b>Chris Alfano</b></sub> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/numberly" style="width: 75px"> | ||
| <sub><b>Numberly</b></sub> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/IQ333777" style="width: 75px"> | ||
| <sub><b>IQ333777</b></sub> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| [](https://github.com/dani-garcia/vaultwarden/graphs/contributors)<br> | ||
| [](https://github.com/dani-garcia/vaultwarden/graphs/contributors) | ||
|
|
||
| <br> | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| **This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor Bitwarden, Inc.** | ||
|
|
||
| However, one of the active maintainers for Vaultwarden is employed by Bitwarden and he is allowed to contribute to the project. Contributions from this maintainer are on his own time and independent of Bitwarden and are reviewed by other maintainers. | ||
|
|
||
| The maintainers work together on setting the direction for the project. The underlying principle is to serve the community of self-hosters like individuals, families, and small organizations, while having a sustainable project. | ||
|
|
||
| <br> | ||
|
|
||
| ## Bitwarden_RS | ||
|
|
||
| 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.<br> | ||
| Please see [#1642 - v1.21.0 release and project rename to Vaultwarden](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation. |
Oops, something went wrong.