-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Home
Vaultwarden is an unofficial Bitwarden server implementation written in Rust. It is compatible with the official Bitwarden clients, 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 implements the Bitwarden APIs required for most functionality, including:
- Web interface (equivalent to https://vault.bitwarden.com/)
- Personal vault support
- Organization vault support
- Password sharing and access control
- Collections
- File attachments
- Folders
- Favorites
- Website icons
- Bitwarden Authenticator (TOTP)
- Bitwarden Send
- Emergency Access
- Live sync (WebSocket only) for desktop/browser clients/extensions
- Trash (soft delete)
- Master password re-prompt
- Personal API key
- Two-step login via email, Duo, YubiKey, and FIDO2 WebAuthn (including Nitrokeys and Solokeys)
- Username generator integration with SimpleLogin, AnonAddy, or Firefox Relay
-
Directory Connector support (basic implementation, no group support)
Only version v2.9.2 and lower is supported, v2.9.3 and up use a different login method not supported yet. - Certain enterprise policies:
Issue #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.
Features that may be added as time permits (contributions are always welcome):
- Bitwarden Public API / Organization API key
- Event Logs
- Live sync (push notifications) for mobile clients (Android/iOS)
- Admin Password Reset
- Certain enterprise policies:
Features that probably won't be added unless contributed:
- Single Sign-On (SSO)
- Groups
- Custom roles
- Certain enterprise policies (UI not open source, would probably need to be configured via admin page):
To ask a question, offer suggestions, request new features, or 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!
- Which container image to use
- Starting a container
- Using Docker Compose
- Using Podman
- Updating the vaultwarden image
- Overview
- Enabling admin page
- SMTP configuration
- Disable registration of new users
- Disable invitations
- Enabling WebSocket notifications
- Enabling Mobile Client push notification
- Other configuration
- Using the MariaDB (MySQL) Backend
- Using the PostgreSQL Backend
- Running without WAL enabled
- Migrating from MariaDB (MySQL) to SQLite
- Hardening Guide
- Password hint display
- Enabling U2F and FIDO2 WebAuthn authentication
- Enabling YubiKey OTP authentication
- Fail2Ban Setup
- Fail2Ban + ModSecurity + Traefik + Docker
- Translating the email templates
- Translating admin page
- Customize Vaultwarden CSS
- Using custom website icons
- Disabling or overriding the Vault interface hosting
- Building binary
- Building your own docker image
- Git hooks
- Differences from the upstream API implementation