Mirrors/vaultwarden
1
0
Fork 0
mirror of https://github.com/dani-garcia/vaultwarden.git synced 2025-04-29 22:24:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

update supported features

Jeremy Lin 2021-07-25 23:33:48 -07:00
parent 8a6730b0eb
commit c2f39a4cdb
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Home.md

@ -1,12 +1,12 @@
# vaultwarden
# Vaultwarden
vaultwarden is an unofficial Bitwarden server implementation written in Rust. It is compatible with the [official Bitwarden clients](https://bitwarden.com/download/), and is ideal for self-hosted deployments where running the official resource-heavy service is undesirable.
Vaultwarden is an unofficial Bitwarden server implementation written in Rust. It is compatible with the [official Bitwarden clients](https://bitwarden.com/download/), and is ideal for self-hosted deployments where running the official resource-heavy service is undesirable.
vaultwarden is targeted towards individuals, families, and smaller organizations. Development of features that are mainly useful to larger organizations (e.g., single sign-on, directory syncing, etc.) is not a priority, though high-quality PRs that implement such features would be welcome.
Vaultwarden is targeted towards individuals, families, and smaller organizations. Development of features that are mainly useful to larger organizations (e.g., single sign-on, directory syncing, etc.) is not a priority, though high-quality PRs that implement such features would be welcome.
## Supported features
vaultwarden implements the Bitwarden APIs required for most functionality, including:
Vaultwarden implements the Bitwarden APIs required for most functionality, including:
* Web interface (equivalent to https://vault.bitwarden.com/)
* Personal vault support
@ -21,9 +21,10 @@ vaultwarden implements the Bitwarden APIs required for most functionality, inclu
* [Bitwarden Send](https://bitwarden.com/help/article/about-send/)
* [Live sync](https://bitwarden.com/blog/post/live-sync/) (WebSocket only) for desktop/browser clients/extensions
* [Trash](https://bitwarden.com/help/article/managing-items/#items-in-the-trash) (soft delete)
* Two-step login via [email](https://bitwarden.com/help/article/setup-two-step-login-email/), [Duo](https://bitwarden.com/help/article/setup-two-step-login-duo/), [YubiKey](https://bitwarden.com/help/article/setup-two-step-login-yubikey/), and [FIDO U2F](https://bitwarden.com/help/article/setup-two-step-login-u2f/)
* [Directory Connector](https://bitwarden.com/help/article/directory-sync/) support (Basic implementation, no group support)
* [Master password re-prompt](https://bitwarden.com/help/article/managing-items/#protect-individual-items)* Two-step login via [email](https://bitwarden.com/help/article/setup-two-step-login-email/), [Duo](https://bitwarden.com/help/article/setup-two-step-login-duo/), [YubiKey](https://bitwarden.com/help/article/setup-two-step-login-yubikey/), and [FIDO2 WebAuthn](https://bitwarden.com/help/article/setup-two-step-login-fido/)
* [Directory Connector](https://bitwarden.com/help/article/directory-sync/) support (basic implementation, no group support)
* Certain enterprise policies:
* [Two-Step Login](https://bitwarden.com/help/article/policies/#two-step-login)
* [Master Password](https://bitwarden.com/help/article/policies/#master-password)
* [Password Generator](https://bitwarden.com/help/article/policies/#password-generator)
* [Personal Ownership](https://bitwarden.com/help/article/policies/#personal-ownership)
@ -32,9 +33,9 @@ vaultwarden implements the Bitwarden APIs required for most functionality, inclu
## Missing features
Issue [#246](https://github.com/dani-garcia/vaultwarden/issues/246) contains the comprehensive list of feature requests, both features of the official server that are missing in vaultwarden, as well as enhancements specific to vaultwarden.
Issue [#246](https://github.com/dani-garcia/vaultwarden/issues/246) contains the comprehensive list of feature requests, both features of the official server that are missing in Vaultwarden, as well as enhancements specific to Vaultwarden.
To simplify comparison with the official server, this section summarizes the features implemented in the official server that are not currently available in vaultwarden.
To simplify comparison with the official server, this section summarizes the features implemented in the official server that are not currently available in Vaultwarden.
Features that may be added as time permits (contributions are always welcome):
@ -42,9 +43,10 @@ Features that may be added as time permits (contributions are always welcome):
* [Bitwarden Public API](https://bitwarden.com/help/article/public-api/)
* [Event Logs](https://bitwarden.com/help/article/event-logs/)
* [Live sync](https://bitwarden.com/blog/post/live-sync/) (push notifications) for mobile clients (Android/iOS)
* [Admin Password Reset](https://bitwarden.com/help/article/admin-reset/)
* Certain enterprise policies:
* [Two-Step Login](https://bitwarden.com/help/article/policies/#two-step-login) ([#981](https://github.com/dani-garcia/vaultwarden/issues/981))
* [Single Organization](https://bitwarden.com/help/article/policies/#single-organization)
* [Master Password Reset](https://bitwarden.com/help/article/policies/#master-password-reset)
Features that probably won't be added unless contributed:
@ -56,6 +58,6 @@ Features that probably won't be added unless contributed:
To ask a question, offer suggestions, request new features, or get help configuring or installing the software, please [use 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 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 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!
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!