From e3907961edd8c165584c9af9e534325ea06f7c2d Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Fri, 17 Jan 2020 21:57:18 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 564 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 564 insertions(+) diff --git a/README.md b/README.md index ec1eab7..b0286c1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,566 @@ # xoxys.bitwarden_rs + +[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.bitwarden_rs/status.svg)](https://drone.rknet.org/ansible/xoxys.bitwarden_rs) + +Role to setup Bitwarden passsword save + +## Table of content + +* [Default Variables](#default-variables) + * [bitwardenrs_admin_token](#bitwardenrs_admin_token) + * [bitwardenrs_authenticator_disable_time_drift](#bitwardenrs_authenticator_disable_time_drift) + * [bitwardenrs_base_url](#bitwardenrs_base_url) + * [bitwardenrs_cap_add](#bitwardenrs_cap_add) + * [bitwardenrs_cap_drop](#bitwardenrs_cap_drop) + * [bitwardenrs_container_name](#bitwardenrs_container_name) + * [bitwardenrs_cpu_shares](#bitwardenrs_cpu_shares) + * [bitwardenrs_db_name](#bitwardenrs_db_name) + * [bitwardenrs_db_password](#bitwardenrs_db_password) + * [bitwardenrs_db_port](#bitwardenrs_db_port) + * [bitwardenrs_db_server](#bitwardenrs_db_server) + * [bitwardenrs_db_ssl_mode](#bitwardenrs_db_ssl_mode) + * [bitwardenrs_db_ssl_rootcert](#bitwardenrs_db_ssl_rootcert) + * [bitwardenrs_db_user](#bitwardenrs_db_user) + * [bitwardenrs_disable_2fa_remember](#bitwardenrs_disable_2fa_remember) + * [bitwardenrs_disable_icon_download](#bitwardenrs_disable_icon_download) + * [bitwardenrs_docker_compose_bin](#bitwardenrs_docker_compose_bin) + * [bitwardenrs_exposed_ip](#bitwardenrs_exposed_ip) + * [bitwardenrs_exposed_port](#bitwardenrs_exposed_port) + * [bitwardenrs_extended_logging](#bitwardenrs_extended_logging) + * [bitwardenrs_extra_hosts](#bitwardenrs_extra_hosts) + * [bitwardenrs_healthcheck](#bitwardenrs_healthcheck) + * [bitwardenrs_icon_blacklist_non_global_ips](#bitwardenrs_icon_blacklist_non_global_ips) + * [bitwardenrs_icon_blacklist_regexl](#bitwardenrs_icon_blacklist_regexl) + * [bitwardenrs_icon_cache_negttl](#bitwardenrs_icon_cache_negttl) + * [bitwardenrs_icon_cache_ttl](#bitwardenrs_icon_cache_ttl) + * [bitwardenrs_icon_download_timeout](#bitwardenrs_icon_download_timeout) + * [bitwardenrs_image](#bitwardenrs_image) + * [bitwardenrs_invitations_allowed](#bitwardenrs_invitations_allowed) + * [bitwardenrs_ip_header](#bitwardenrs_ip_header) + * [bitwardenrs_log_level](#bitwardenrs_log_level) + * [bitwardenrs_memory_limit](#bitwardenrs_memory_limit) + * [bitwardenrs_memory_reservation](#bitwardenrs_memory_reservation) + * [bitwardenrs_password_iterations](#bitwardenrs_password_iterations) + * [bitwardenrs_pids_limit](#bitwardenrs_pids_limit) + * [bitwardenrs_reload_templates](#bitwardenrs_reload_templates) + * [bitwardenrs_restart_policy](#bitwardenrs_restart_policy) + * [bitwardenrs_security_opt](#bitwardenrs_security_opt) + * [bitwardenrs_service_directory](#bitwardenrs_service_directory) + * [bitwardenrs_show_password_hint](#bitwardenrs_show_password_hint) + * [bitwardenrs_signups_allowed](#bitwardenrs_signups_allowed) + * [bitwardenrs_signups_domains_whitelist](#bitwardenrs_signups_domains_whitelist) + * [bitwardenrs_signups_verify](#bitwardenrs_signups_verify) + * [bitwardenrs_signups_verify_resend_limit](#bitwardenrs_signups_verify_resend_limit) + * [bitwardenrs_signups_verify_resend_time](#bitwardenrs_signups_verify_resend_time) + * [bitwardenrs_smtp_auth_mechanism](#bitwardenrs_smtp_auth_mechanism) + * [bitwardenrs_smtp_from](#bitwardenrs_smtp_from) + * [bitwardenrs_smtp_from_name](#bitwardenrs_smtp_from_name) + * [bitwardenrs_smtp_host](#bitwardenrs_smtp_host) + * [bitwardenrs_smtp_password](#bitwardenrs_smtp_password) + * [bitwardenrs_smtp_port](#bitwardenrs_smtp_port) + * [bitwardenrs_smtp_ssl](#bitwardenrs_smtp_ssl) + * [bitwardenrs_smtp_timeout](#bitwardenrs_smtp_timeout) + * [bitwardenrs_smtp_username](#bitwardenrs_smtp_username) + * [bitwardenrs_templates_folder](#bitwardenrs_templates_folder) + * [bitwardenrs_version](#bitwardenrs_version) + * [bitwardenrs_web_vault_enabled](#bitwardenrs_web_vault_enabled) +* [Dependencies](#dependencies) +* [License](#license) +* [Author](#author) + +--- + +## Default Variables + +### bitwardenrs_admin_token + +#### Default value + +```YAML +bitwardenrs_admin_token: _unset_ +``` + +### bitwardenrs_authenticator_disable_time_drift + +#### Default value + +```YAML +bitwardenrs_authenticator_disable_time_drift: false +``` + +### bitwardenrs_base_url + +#### Default value + +```YAML +bitwardenrs_base_url: http://localhost/ +``` + +### bitwardenrs_cap_add + +#### Default value + +```YAML +bitwardenrs_cap_add: [] +``` + +### bitwardenrs_cap_drop + +#### Default value + +```YAML +bitwardenrs_cap_drop: [] +``` + +### bitwardenrs_container_name + +#### Default value + +```YAML +bitwardenrs_container_name: bitwardenrs +``` + +### bitwardenrs_cpu_shares + +#### Default value + +```YAML +bitwardenrs_cpu_shares: _unset_ +``` + +#### Example usage + +```YAML +bitwardenrs_cpu_shares: '1024' +``` + +### bitwardenrs_db_name + +#### Default value + +```YAML +bitwardenrs_db_name: bitwardenrs +``` + +### bitwardenrs_db_password + +#### Default value + +```YAML +bitwardenrs_db_password: secure +``` + +### bitwardenrs_db_port + +#### Default value + +```YAML +bitwardenrs_db_port: 5432 +``` + +### bitwardenrs_db_server + +This ansible roles does only support postgresql as database" + +#### Default value + +```YAML +bitwardenrs_db_server: localhost +``` + +### bitwardenrs_db_ssl_mode + +#### Default value + +```YAML +bitwardenrs_db_ssl_mode: disable +``` + +### bitwardenrs_db_ssl_rootcert + +#### Default value + +```YAML +bitwardenrs_db_ssl_rootcert: /etc/ssl/certs/ca-certificates.crt +``` + +### bitwardenrs_db_user + +#### Default value + +```YAML +bitwardenrs_db_user: pgbitwardenrs +``` + +### bitwardenrs_disable_2fa_remember + +#### Default value + +```YAML +bitwardenrs_disable_2fa_remember: false +``` + +### bitwardenrs_disable_icon_download + +#### Default value + +```YAML +bitwardenrs_disable_icon_download: false +``` + +### bitwardenrs_docker_compose_bin + +#### Default value + +```YAML +bitwardenrs_docker_compose_bin: /usr/local/bin/docker-compose +``` + +### bitwardenrs_exposed_ip + +#### Default value + +```YAML +bitwardenrs_exposed_ip: 127.0.0.1 +``` + +### bitwardenrs_exposed_port + +#### Default value + +```YAML +bitwardenrs_exposed_port: 80 +``` + +### bitwardenrs_extended_logging + +#### Default value + +```YAML +bitwardenrs_extended_logging: true +``` + +### bitwardenrs_extra_hosts + +#### Default value + +```YAML +bitwardenrs_extra_hosts: [] +``` + +### bitwardenrs_healthcheck + +#### Default value + +```YAML +bitwardenrs_healthcheck: + test: '["CMD", "/usr/local/bin/healthcheck.sh"]' + interval: 30s + timeout: 5s + retries: 5 +``` + +### bitwardenrs_icon_blacklist_non_global_ips + +#### Default value + +```YAML +bitwardenrs_icon_blacklist_non_global_ips: true +``` + +### bitwardenrs_icon_blacklist_regexl + +#### Default value + +```YAML +bitwardenrs_icon_blacklist_regexl: _unset_ +``` + +### bitwardenrs_icon_cache_negttl + +#### Default value + +```YAML +bitwardenrs_icon_cache_negttl: '{{ bitwardenrs_icon_cache_ttl }}' +``` + +### bitwardenrs_icon_cache_ttl + +#### Default value + +```YAML +bitwardenrs_icon_cache_ttl: 2592000 +``` + +### bitwardenrs_icon_download_timeout + +#### Default value + +```YAML +bitwardenrs_icon_download_timeout: 10 +``` + +### bitwardenrs_image + +#### Default value + +```YAML +bitwardenrs_image: xoxys/bitwardenrs:{{ bitwardenrs_version }} +``` + +### bitwardenrs_invitations_allowed + +#### Default value + +```YAML +bitwardenrs_invitations_allowed: true +``` + +### bitwardenrs_ip_header + +#### Default value + +```YAML +bitwardenrs_ip_header: x-client-ip +``` + +### bitwardenrs_log_level + +#### Default value + +```YAML +bitwardenrs_log_level: Info +``` + +### bitwardenrs_memory_limit + +#### Default value + +```YAML +bitwardenrs_memory_limit: _unset_ +``` + +#### Example usage + +```YAML +bitwardenrs_memory_limit: 512m +``` + +### bitwardenrs_memory_reservation + +#### Default value + +```YAML +bitwardenrs_memory_reservation: _unset_ +``` + +#### Example usage + +```YAML +bitwardenrs_memory_reservation: 256m +``` + +### bitwardenrs_password_iterations + +#### Default value + +```YAML +bitwardenrs_password_iterations: 100000 +``` + +### bitwardenrs_pids_limit + +#### Default value + +```YAML +bitwardenrs_pids_limit: _unset_ +``` + +### bitwardenrs_reload_templates + +#### Default value + +```YAML +bitwardenrs_reload_templates: false +``` + +### bitwardenrs_restart_policy + +#### Default value + +```YAML +bitwardenrs_restart_policy: on-failure +``` + +### bitwardenrs_security_opt + +#### Default value + +```YAML +bitwardenrs_security_opt: [] +``` + +### bitwardenrs_service_directory + +#### Default value + +```YAML +bitwardenrs_service_directory: /var/lib/docker/services/bitwardenrs +``` + +### bitwardenrs_show_password_hint + +#### Default value + +```YAML +bitwardenrs_show_password_hint: true +``` + +### bitwardenrs_signups_allowed + +#### Default value + +```YAML +bitwardenrs_signups_allowed: false +``` + +### bitwardenrs_signups_domains_whitelist + +#### Default value + +```YAML +bitwardenrs_signups_domains_whitelist: _unset_ +``` + +### bitwardenrs_signups_verify + +#### Default value + +```YAML +bitwardenrs_signups_verify: false +``` + +### bitwardenrs_signups_verify_resend_limit + +#### Default value + +```YAML +bitwardenrs_signups_verify_resend_limit: 6 +``` + +### bitwardenrs_signups_verify_resend_time + +#### Default value + +```YAML +bitwardenrs_signups_verify_resend_time: 3600 +``` + +### bitwardenrs_smtp_auth_mechanism + +#### Default value + +```YAML +bitwardenrs_smtp_auth_mechanism: plain +``` + +### bitwardenrs_smtp_from + +#### Default value + +```YAML +bitwardenrs_smtp_from: bitwardenrs@localhost +``` + +### bitwardenrs_smtp_from_name + +#### Default value + +```YAML +bitwardenrs_smtp_from_name: bitwarden_rs +``` + +### bitwardenrs_smtp_host + +#### Default value + +```YAML +bitwardenrs_smtp_host: _unset_ +``` + +### bitwardenrs_smtp_password + +#### Default value + +```YAML +bitwardenrs_smtp_password: _unset_ +``` + +### bitwardenrs_smtp_port + +#### Default value + +```YAML +bitwardenrs_smtp_port: 587 +``` + +### bitwardenrs_smtp_ssl + +#### Default value + +```YAML +bitwardenrs_smtp_ssl: true +``` + +### bitwardenrs_smtp_timeout + +#### Default value + +```YAML +bitwardenrs_smtp_timeout: 15 +``` + +### bitwardenrs_smtp_username + +#### Default value + +```YAML +bitwardenrs_smtp_username: _unset_ +``` + +### bitwardenrs_templates_folder + +#### Default value + +```YAML +bitwardenrs_templates_folder: _unset_ +``` + +### bitwardenrs_version + +#### Default value + +```YAML +bitwardenrs_version: latest +``` + +### bitwardenrs_web_vault_enabled + +#### Default value + +```YAML +bitwardenrs_web_vault_enabled: true +``` + +## Dependencies + +None. + +## License + +MIT + +## Author + +[xoxys](https://gitea.rknet.org/xoxys)