/bitwarden_rs

Home

Jump to bottom
Nick Fox edited this page Dec 31, 2018 · 1 revision

bitwarden_rs

This is a Bitwarden server API implementation written in Rust compatible with upstream Bitwarden clients*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.

Features

Basically full implementation of Bitwarden API is provided including:

  • Basic single user functionality
  • Organizations support
  • Attachments
  • Vault API support
  • Serving the static files for Vault interface
  • Website icons API
  • Authenticator and U2F support
  • YubiKey OTP

Missing Features

  • Email confirmation
  • Other two-factor systems:
    • Duo
    • Email codes

Get in touch

To ask an question, raising an issue is fine, also please report any bugs spotted here.

If you prefer to chat, we're usually hanging around at #bitwarden_rs:matrix.org room on Matrix. Feel free to join us!

Docker Image Usage

  1. Starting a container
  2. Updating the bitwarden image
  3. Using Docker Compose

Deployment

  1. Building your own image
  2. Building binary
  3. Available packages
  4. Kubernetes deployment
  5. Proxy examples

Configuration

  1. Disable registration of new users
  2. Disable invitations
  3. Enabling admin page
  4. Disable the admin token
  5. Enabling HTTPS
  6. Enabling WebSocket notifications
  7. Enabling U2F authentication
  8. Enabling YubiKey OTP authentication
  9. Changing persistent data location
  10. Changing the API request size limit
  11. Changing the number of workers
  12. SMTP configuration
  13. Password hint display
  14. Disabling or overriding the Vault interface hosting
  15. Logging
  16. Fail2Ban Setup
  17. Creating a systemd service
  18. Running with systemd-docker
  19. Running without WAL enabled
  20. Other configuration

Other Information

  1. Backing up your vault
  2. Running the server with non-root-user
  3. Differences from the upstream API implementation
  4. Supporting upstream development
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.