53 Home

Niklas edited this page 4 weeks ago

Vaultwarden

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.

Supported features

Vaultwarden implements the Bitwarden APIs required for most functionality, including:

• Web interface (equivalent to https://vault.bitwarden.com/)

• Personal vault support

• Organization vault support

• Groups, setting an environment variable is required in order to enable it)

• Event Logs

• 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

• Admin Password Reset

• Live sync (push notifications) for mobile clients (Android/iOS)

• Certain enterprise policies:

  • Require two-step login
  • Master password requirements
  • Master password reset
  • Password generator
  • Single organization
  • Remove individual vault
  • Remove Send
  • Send options

Missing features

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 This feature is partially added, but only to support the Bitwarden Directory Connector.

Features that probably won't be added unless contributed:

• Single Sign-On (SSO)
• Custom roles
• Certain enterprise policies (UI not open source, would probably need to be configured via admin page):
  • Require single sign-on authentication
  • Vault timeout
  • Remove individual vault export

Get in touch

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!

Table of Contents

• Vaultwarden
• Supported features
• Missing features
• Get in touch
• FAQs
• Container Image Usage
• Deployment
• HTTPS
• Configuration
• Database
• Security
• Backup
• Other Information

FAQs

1. FAQs

Container Image Usage

1. Which container image to use
2. Starting a container
3. Updating the vaultwarden image
4. Using Docker Compose
5. Using Podman

Deployment

1. Building your own docker image
2. Building binary
3. Pre-built binaries
4. Third-party packages
5. Deployment examples
6. Proxy examples
7. Logrotate example

HTTPS

1. Enabling HTTPS
2. Running a private vaultwarden instance with Let's Encrypt certs

Configuration

1. Overview
2. Disable registration of new users
3. Disable invitations
4. Enabling admin page
5. Disable the admin token
6. Enabling WebSocket notifications
7. Enabling Mobile Client push notification
8. Enabling U2F and FIDO2 WebAuthn authentication
9. Enabling YubiKey OTP authentication
10. Changing persistent data location
11. Changing the API request size limit
12. Changing the number of workers
13. SMTP configuration
14. Translating the email templates
15. Password hint display
16. Disabling or overriding the Vault interface hosting
17. Logging
18. Creating a systemd service
19. Syncing users from LDAP
20. Using an alternate base dir (subdir/subpath)
21. Other configuration

Database

1. Using the MariaDB (MySQL) Backend
2. Using the PostgreSQL Backend
3. Running without WAL enabled
4. Migrating from MariaDB (MySQL) to SQLite

Security

1. Hardening Guide
2. Fail2Ban Setup
3. Fail2Ban + ModSecurity + Traefik + Docker

Backup

1. General (not docker)

Other Information

1. Importing data from Keepass or KeepassX
2. Backing up your vault
3. Differences from the upstream API implementation
4. Supporting upstream development
5. Caddy 2.x with Cloudflare DNS