From 13d674a61dd418158b801be4bc7e46fbded61d7b Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@geeklabor.de>
Date: Wed, 16 Oct 2019 22:44:34 +0200
Subject: [PATCH] add basic docs

---
 defaults/main.yml | 52 ++++++++++++++++++++++++++++-------------------
 1 file changed, 31 insertions(+), 21 deletions(-)

diff --git a/defaults/main.yml b/defaults/main.yml
index f192bfe..1e3ba4c 100644
--- a/defaults/main.yml
+++ b/defaults/main.yml
@@ -8,17 +8,18 @@ freshrss_restart_policy: on-failure
 freshrss_exposed_port: 61000
 freshrss_exposed_ip: 127.0.0.1
 freshrss_extra_hosts: []
-# freshrss_memory_limit: 512m # defaults to not set
-# freshrss_memory_reservation: 256m # defaults to not set
-# freshrss_cpu_shares: 1024 # defaults to not set
-# freshrss_http_proxy: # defaults to not set
-# freshrss_https_proxy: # defaults to not set
-# freshrss_no_proxy: # defaults to not set
+
+# @var freshrss_memory_limit: $ "_unset_"
+# @var freshrss_memory_limit:example: $ "512m"
+# @var freshrss_memory_reservation: $ "_unset_"
+# @var freshrss_memory_reservation:example: $ "256m"
+# @var freshrss_cpu_shares: $ "_unset_"
+# @var freshrss_cpu_shares:example: $ "1024"
 
 freshrss_cap_add: []
 freshrss_cap_drop: []
 freshrss_security_opt: []
-# freshrss_pids_limit: # defaults to not set
+# @var freshrss_pids_limit: $ "_unset_"
 
 freshrss_healthcheck:
   test: '["CMD", "/usr/local/bin/healthcheck.sh"]'
@@ -28,15 +29,21 @@ freshrss_healthcheck:
 
 freshrss_default_user: "admin"
 freshrss_default_password: "freshrss"
-# Salt is used to make crypto more unique.
-# Can be generated with e.g. cat /proc/sys/kernel/random/uuid | sha1sum | awk '{print $1}'
-# freshrss_salt: # defaults to not set
-# Specify address of the freshrss instance,
-# used when building absolute urls, e.g. for websub.
+
+# @var freshrss_salt:description: >
+# Salt is used to make crypto more unique. You can generate your own salt with 
+# e.g. `cat /proc/sys/kernel/random/uuid | sha1sum | awk '{print $1}'`.
+# @end
+# @var freshrss_salt: $ "_unset_"
+
+# @var freshrss_base_url:description: >
+# Specify address of the freshrss instance, used when building 
+# absolute urls, e.g. for websub.
+# @end
 freshrss_base_url: "http://localhost/"
 freshrss_language: "en"
 freshrss_title: "FreshRSS"
-# freshrss_meta_description: # defaults to not set
+# @var freshrss_meta_description: $ "_unset_"
 freshrss_allow_anonymous: "false"
 freshrss_allow_anonymous_refresh: "false"
 freshrss_auth_type: "form"
@@ -53,14 +60,17 @@ freshrss_limits_max_inactivity: "10800"
 freshrss_limits_max_feeds: "16384"
 freshrss_limits_max_categories: "16384"
 freshrss_limits_max_registrations: "1"
-# freshrss_curlopt_ssl_verifyhost: # defaults to not set
-# freshrss_curlopt_ssl_verifypeer: # defaults to not set
-# freshrss_curlopt_proxytype: # defaults to not set
-# freshrss_curlopt_proxy: # defaults to not set
-# freshrss_curlopt_proxyport: # defaults to not set
-# freshrss_curlopt_proxyauth: # defaults to not set
-# freshrss_curlopt_proxyuserpwd: # defaults to not set
-## comma-seperated string, extensions must be installed!
+# @var freshrss_curlopt_ssl_verifyhost: $ "_unset_"
+# @var freshrss_curlopt_ssl_verifypeer: $ "_unset_"
+# @var freshrss_curlopt_proxytype: $ "_unset_"
+# @var freshrss_curlopt_proxy: $ "_unset_"
+# @var freshrss_curlopt_proxyport: $ "_unset_"
+# @var freshrss_curlopt_proxyauth: $ "_unset_"
+# @var freshrss_curlopt_proxyuserpwd: $ "_unset_"
+
+# @var freshrss_extensions_enabled:description: >
+# List of FreshRSS extensions to enable. Extensions must be already installed!
+# @end
 freshrss_extensions_enabled:
   - "Tumblr-GDPR"