doc: mcaptcha vars

ansible/vars/mcaptcha/vars.yml

@@ -1,61 +1,63 @@
-database_type: "postgres" # options: "mariadb", "postgres"
+database_type: "postgres" # REQUIRED. options: "mariadb", "postgres"
-cache_type: "redis" # options: "embedded", "redis"
+cache_type: "redis" # REQUIRED. options: "embedded", "redis"
 
+# database user
 database_owner: "mcaptcha"
 database_name: "mcaptcha"
+# AUTO-GENERATED. database password
 database_password: "{{ lookup('ansible.builtin.password', 'credentials/database_password', chars=['ascii_leters', 'digits'], length=32) }}"
 
+# Database connection pool
+mcaptcha_database_pool: 4
+
+# debug logging
 mcaptcha_debug: false
-# mcaptcha_source_code: 'https://github.com/mCaptcha/mCaptcha'
+# doens't do anything at the moment
 mcaptcha_commercial: false
+# create demo user and allow demo login
 mcaptcha_allow_demo: false
-mcaptcha_allow_registration: false
+# allow registration of new accounts. Required for the first user account.
+# Please edit to set to "false" and re-rerun playbook if registration is
+# undesirable.
+mcaptcha_allow_registration: true
 
-# Please set a unique value, your mCaptcha instance's security depends on this being
+# AUTO-GENERATED. Randomly generated unique value for signing cookies.
-# unique
 mcaptcha_server_cookie_secret: "{{ lookup('ansible.builtin.password', 'credentials/mcaptcha_server_cookie_secret', chars=['ascii_leters', 'digits'], length=32) }}"
+# REQUIRED. mcaptcha server port. Won't be exposed to internet, change if something else
+# is listening on binding IP and port combination. 
 mcaptcha_server_port: 7000
+# REQUIRED. bind to IP. If using reverse proxy (playbook installs and configures nginx), set to 127.0.0.1.
 mcaptcha_server_bind: "127.0.0.1"
+# REQUIRED. hostname of the mcaptcha installation. Incorrect hostname will cause login failures.
 mcaptcha_server_hostname: "mcaptcha.local"
-# Set true if you have setup TLS with a reverse proxy like Nginx.
-# Does HTTPS redirect and sends additional headers that can only be used if
-# HTTPS available to improve security
-#mcaptcha_proxy_has_tls: false
 
-# Please set a unique value, your mCaptcha instance's security depends on this being
+# AUTO-GENERATED. IGNORE if unfamiliar.
-# unique
 mcaptcha_captcha_salt: "{{ lookup('ansible.builtin.password', 'credentials/mcaptcha_captha_salt', chars=['ascii_leters', 'digits'], length=32) }}"
-# garbage collection period to manage mCaptcha system
+# IGNORE if unfamiliar. # garbage collection period to manage mCaptcha system
-# leave untouched if you don't know what you are doing
 # mcaptcha_captcha_gc: 30
+# IGNORE if unfamiliar. Number of threads used to validate Proof-of-Work (PoW)
 # mcaptcha_captcha_runners: 4
+# IGNORE if unfamiliar. Maximum pending jobs in queue for PoW validation
 # mcaptcha_captcha_queue_length: 2000
+# Store PoW compute time statistics
 mcaptcha_captcha_enable_stats: true
 
+# IGNORE if unfamiliar. Difficulty factor for average traffic. Used in "easy mode" CAPTCHA configuration generation.
 #mcaptcha_captcha_default_difficulty_strategy_avg_traffic_difficulty: 50000 # almost instant solution
+# IGNORE if unfamiliar. Difficulty factor for peak traffic levels. Used in "easy mode" CAPTCHA configuration generation.
 #mcaptcha_captcha_default_difficulty_strategy_peak_sustainable_traffic_difficulty: 3000000 # roughly 1.5s
+# IGNORE if unfamiliar. Difficulty factor for maximum traffic levels. Used in "easy mode" CAPTCHA configuration generation.
 #mcaptcha_captcha_default_difficulty_strategy_broke_my_site_traffic_difficulty: 5000000  # greater than 3.5s
-# cooldown period in seconds
+# IGNORE if unfamiliar. Default cooldown period in seconds for "easy mode".
 mcaptcha_captcha_default_difficulty_strategy_avg_duration: 30
 
-  #{% if database_type == 'postgres' %}
-  #  {% set mcaptcha_database_url = "postgres://{{ database_owner }}:{{ database_password }}@localhost:5432/{{ database_name }}" %}
-  #{% else %}
-  #  {% set mcaptcha_database_url = "mysql://{{ database_owner }}:{{ database_password }}@localhost/{{ database_name }}" %}
-  #{% endif %}
-#mcaptcha_database_url: "mysql://{{ database_owner }}:{{ database_password }}@localhost/{{ database_name }}"
-  #mcaptcha_database_url: "postgres://{{ database_owner }}:{{ database_password }}@localhost:5432/{{ database_name }}"
-#  mysql://mcaptcha:password@localhost/mcaptcha"
-mcaptcha_database_pool: 4
-  #mcaptcha_database_url: "{{ mcaptcha_database_url }}"
 
+# Redis instance URL
 mcaptcha_redis_url: "redis://127.0.0.1"
+# Redis connection pool
 mcaptcha_redis_pool: 4
 
-mcaptcha_redis_url: "redis://127.0.0.1"
+# smtp configuration
-mcaptcha_redis_pool: 4
-
-
 mcaptcha_smtp_from: "admin@localhost"
 mcaptcha_smtp_reply: "admin@localhost"
 mcaptcha_smtp_url: "127.0.0.1"