Skip to content

Syncing users from LDAP

Jump to bottom Edit New page
Ian edited this page Apr 15, 2019 · 7 revisions

Syncing users from LDAP

LDAP integration is performed using a small service that queries LDAP and invites users to your Bitwarden instance. This service is uncreatively named bitwarden_rs_ldap.

It is not yet distributed as a binary, but there is an available Docker image vividboarder/bitwarden_rs_ldap.

Before deploying, you must enable your bitwarden_rs admin page. This is enables the API that the LDAP sync service will use to invite users. The ADMIN_TOKEN that you set will be used when configuring the LDAP sync service. You must also be sure to not disable the invitation capability. To verify this, double check that the environment variable INVITATIONS_ALLOWED is not set to false.

It is also recommended to enable email sending from your Bitwarden instance so that your users will be notified they can make an account. If you do not, they will still be able to register if they use their LDAP email address, but you will have to inform them on your own.

With these steps done, you can configure and deploy the LDAP sync service. The most up-to-date instructions are to be found on the service Readme itself, but it will involve creating the config.toml file with the connection info for your bitwarden_rs instance, your LDAP instance, as well as the LDAP query you'd like to use to find users.

Add a custom footer

FAQs

  1. FAQs
  2. Audits

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
Clone this wiki locally