xoxys.vaultwarden_ldap_docker/index.md

327 lines
6.6 KiB
Markdown
Raw Normal View History

---
title: bitwardenrs_ldap_docker
type: docs
---
[![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.bitwardenrs_ldap_docker) [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.bitwardenrs_ldap_docker?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.bitwardenrs_ldap_docker) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/ansible/xoxys.bitwardenrs_ldap_docker/src/branch/master/LICENSE)
Role to setup a [BitwardenRS LDAP](https://gitea.rknet.org/docker/bitwarden_rs_ldap) Sync Service for [BitwardenRS](https://github.com/dani-garcia/bitwarden_rs) password safe.
* [Default Variables](#default-variables)
* [bitwardenrs_ldap_bind_dn](#bitwardenrs_ldap_bind_dn)
* [bitwardenrs_ldap_bind_password](#bitwardenrs_ldap_bind_password)
* [bitwardenrs_ldap_bitwarden_admin_token](#bitwardenrs_ldap_bitwarden_admin_token)
* [bitwardenrs_ldap_bitwarden_url](#bitwardenrs_ldap_bitwarden_url)
* [bitwardenrs_ldap_cap_add](#bitwardenrs_ldap_cap_add)
* [bitwardenrs_ldap_cap_drop](#bitwardenrs_ldap_cap_drop)
* [bitwardenrs_ldap_container_name](#bitwardenrs_ldap_container_name)
* [bitwardenrs_ldap_cpu_shares](#bitwardenrs_ldap_cpu_shares)
* [bitwardenrs_ldap_host](#bitwardenrs_ldap_host)
* [bitwardenrs_ldap_image](#bitwardenrs_ldap_image)
* [bitwardenrs_ldap_mail_field](#bitwardenrs_ldap_mail_field)
* [bitwardenrs_ldap_memory_limit](#bitwardenrs_ldap_memory_limit)
* [bitwardenrs_ldap_memory_reservation](#bitwardenrs_ldap_memory_reservation)
* [bitwardenrs_ldap_networks](#bitwardenrs_ldap_networks)
* [bitwardenrs_ldap_networks_applied](#bitwardenrs_ldap_networks_applied)
* [bitwardenrs_ldap_pids_limit](#bitwardenrs_ldap_pids_limit)
* [bitwardenrs_ldap_port](#bitwardenrs_ldap_port)
* [bitwardenrs_ldap_restart_policy](#bitwardenrs_ldap_restart_policy)
* [bitwardenrs_ldap_scheme](#bitwardenrs_ldap_scheme)
* [bitwardenrs_ldap_search_base_dn](#bitwardenrs_ldap_search_base_dn)
* [bitwardenrs_ldap_search_filter](#bitwardenrs_ldap_search_filter)
* [bitwardenrs_ldap_security_opt](#bitwardenrs_ldap_security_opt)
* [bitwardenrs_ldap_service_directory](#bitwardenrs_ldap_service_directory)
* [bitwardenrs_ldap_service_stopped](#bitwardenrs_ldap_service_stopped)
* [bitwardenrs_ldap_ssl](#bitwardenrs_ldap_ssl)
* [bitwardenrs_ldap_sync_interval_seconds](#bitwardenrs_ldap_sync_interval_seconds)
* [bitwardenrs_ldap_sync_loop](#bitwardenrs_ldap_sync_loop)
* [bitwardenrs_ldap_version](#bitwardenrs_ldap_version)
* [bitwardenrs_ldap_volumes](#bitwardenrs_ldap_volumes)
* [Dependencies](#dependencies)
---
## Default Variables
### bitwardenrs_ldap_bind_dn
#### Default value
```YAML
bitwardenrs_ldap_bind_dn: _unset_
```
### bitwardenrs_ldap_bind_password
#### Default value
```YAML
bitwardenrs_ldap_bind_password: _unset_
```
### bitwardenrs_ldap_bitwarden_admin_token
#### Default value
```YAML
bitwardenrs_ldap_bitwarden_admin_token: abc123
```
### bitwardenrs_ldap_bitwarden_url
#### Default value
```YAML
bitwardenrs_ldap_bitwarden_url: bitwarden.example.com
```
### bitwardenrs_ldap_cap_add
#### Default value
```YAML
bitwardenrs_ldap_cap_add: []
```
### bitwardenrs_ldap_cap_drop
#### Default value
```YAML
bitwardenrs_ldap_cap_drop: []
```
### bitwardenrs_ldap_container_name
#### Default value
```YAML
bitwardenrs_ldap_container_name: bitwardenrs_ldap
```
### bitwardenrs_ldap_cpu_shares
#### Default value
```YAML
bitwardenrs_ldap_cpu_shares: _unset_
```
#### Example usage
```YAML
bitwardenrs_ldap_cpu_shares: '1024'
```
### bitwardenrs_ldap_host
#### Default value
```YAML
bitwardenrs_ldap_host: _unset_
```
### bitwardenrs_ldap_image
#### Default value
```YAML
bitwardenrs_ldap_image: thegeeklab/bitwardenrs_ldap:{{ bitwardenrs_ldap_version }}
```
### bitwardenrs_ldap_mail_field
#### Default value
```YAML
bitwardenrs_ldap_mail_field: mail
```
### bitwardenrs_ldap_memory_limit
#### Default value
```YAML
bitwardenrs_ldap_memory_limit: _unset_
```
#### Example usage
```YAML
bitwardenrs_ldap_memory_limit: 512m
```
### bitwardenrs_ldap_memory_reservation
#### Default value
```YAML
bitwardenrs_ldap_memory_reservation: _unset_
```
#### Example usage
```YAML
bitwardenrs_ldap_memory_reservation: 256m
```
### bitwardenrs_ldap_networks
#### Default value
```YAML
bitwardenrs_ldap_networks:
- name: bitwardenrs_default
external: true
```
#### Example usage
```YAML
bitwardenrs_ldap_networks:
- name: default
# optional network driver, defaults to 'bride'
driver: host
```
### bitwardenrs_ldap_networks_applied
#### Default value
```YAML
bitwardenrs_ldap_networks_applied:
- bitwardenrs_default
```
### bitwardenrs_ldap_pids_limit
#### Default value
```YAML
bitwardenrs_ldap_pids_limit: _unset_
```
### bitwardenrs_ldap_port
#### Default value
```YAML
bitwardenrs_ldap_port: _unset_
```
### bitwardenrs_ldap_restart_policy
#### Default value
```YAML
bitwardenrs_ldap_restart_policy: always
```
### bitwardenrs_ldap_scheme
#### Default value
```YAML
bitwardenrs_ldap_scheme: _unset_
```
### bitwardenrs_ldap_search_base_dn
#### Default value
```YAML
bitwardenrs_ldap_search_base_dn: _unset_
```
### bitwardenrs_ldap_search_filter
#### Default value
```YAML
bitwardenrs_ldap_search_filter: (&(objectclass=*)(uid=*))
```
### bitwardenrs_ldap_security_opt
#### Default value
```YAML
bitwardenrs_ldap_security_opt: []
```
### bitwardenrs_ldap_service_directory
#### Default value
```YAML
bitwardenrs_ldap_service_directory: /var/lib/docker/services/bitwardenrs_ldap
```
### bitwardenrs_ldap_service_stopped
#### Default value
```YAML
bitwardenrs_ldap_service_stopped: false
```
### bitwardenrs_ldap_ssl
#### Default value
```YAML
bitwardenrs_ldap_ssl: true
```
### bitwardenrs_ldap_sync_interval_seconds
#### Default value
```YAML
bitwardenrs_ldap_sync_interval_seconds: 60
```
### bitwardenrs_ldap_sync_loop
#### Default value
```YAML
bitwardenrs_ldap_sync_loop: true
```
### bitwardenrs_ldap_version
#### Default value
```YAML
bitwardenrs_ldap_version: latest
```
### bitwardenrs_ldap_volumes
> Define required docker volumes.
#### Default value
```YAML
bitwardenrs_ldap_volumes: []
```
#### Example usage
```YAML
bitwardenrs_ldap_volumes:
# Instead of the name you could specify a path on the container host system,
# but you also have to enable bind mount for this volume
- name: data
# target location inside the container
dest: /app/data
# enable bind mount, if false volume will be configured as named volume
# keep in mind you MUST set bind in any case
bind: True
```
## Dependencies
None.