From 6d1657ea0acb91e048a0445abb4df70c15f3bd93 Mon Sep 17 00:00:00 2001
From: Dan Anglin <daangling@gmail.com>
Date: Mon, 30 Mar 2020 08:34:51 +0100
Subject: [PATCH] more config documentation

---
 examples/host_vars/pleroma-01.yml | 105 +++++++++++++++++++++---------
 1 file changed, 76 insertions(+), 29 deletions(-)

diff --git a/examples/host_vars/pleroma-01.yml b/examples/host_vars/pleroma-01.yml
index 742c277..441aa02 100644
--- a/examples/host_vars/pleroma-01.yml
+++ b/examples/host_vars/pleroma-01.yml
@@ -80,6 +80,7 @@ pleroma:
     #   This is used to configure the secret_key_base in Pleroma.
     #   It is used to sign and verify cookies.
     #   To generate this run 'make secret_key_base'
+    #   The playbook will fail if this field is empty.
     secretKeyBase:
 
     # field name - pleroma.config.signingSalt
@@ -87,46 +88,83 @@ pleroma:
     #   This is used to configure the signing_salt in Pleroma.
     #   It is used with the secret_key_base to generate a key for signing and verifying cookies.
     #   To generate this run 'make signing_salt'
+    #   The playbook will fail if this field is empty.
     signingSalt:
 
-    #mrf:
-    #  simplePolicy:
-    #    reject: []
-    #    federatedTimelineRemoval: []
-    #    mediaRemoval: []
-    #    mediaNsfw: []
-    #    reportRemoval: []
-    #frontend:
-    #  background: ""
-    #  themes:
-    #    custom: []
-    #    default: pleroma-dark
+    # This section configures the... TODO
+    mrf:
+      simplePolicy:
+        #reject: []
+        #federatedTimelineRemoval: []
+        #mediaRemoval: []
+        #mediaNsfw: []
+        #reportRemoval: []
+
+    # This section configures the Pleroma frontend.
+    frontend:
+      # field name - pleroma.config.frontend.background
+      # default value - This field is empty by default
+      # description -
+      #   The path on the Ansible controller to the image
+      #   that will be uploaded to your Pleroma instance and
+      #   used as the default background image.
+      #background: /path/to/your/background/image
+
+      themes:
+        # field name - pleroma.config.frontend.themes.custom
+        # default value - An empty list
+        # description - A list of names and corresponding paths of your custom themes
+        #custom:
+        #- name: custom-theme-1
+        #  path: /file/path/to/custom/theme1
+        #- name: custom-theme-2
+        #  path: /file/path/to/custom/theme2
+
+        # field name - pleroma.config.frontend.themes.default
+        # default value - pleroma-dark
+        # description -
+        #  The default theme for your instance.
+        #  You can specify one of the default themes or even
+        #  one of your custom theme.
+        #default: custom-theme-1
+
     webPushEncryption:
-      # field name - 
+      # field name - pleroma.config.webPushEncryption.email
       # description - 
       email: *email
 
-      # field name - 
+      # field name - pleroma.config.webPushEncryption.privateKey
       # description - 
+      #   This is the private key to enable browser notifications using VAPID.
+      #   To generate this run 'make vapid_private_key'
+      #   The playbook will fail if this field is empty.
       privateKey:
 
-      # field name - 
+      # field name - pleroma.config.webPushEncryption.publicKey
       # description - 
+      #   The playbook will fail if this field is empty.
       publicKey:
     db:
-      # field name - 
-      # description - 
+      # field name - pleroma.config.db.password
+      # description -
+      #   The password to the Pleroma database.
+      #   The playbook will fail if this field is empty.
       password:
 
-      # field name - 
-      # description - 
-      # default value -
-      #name: pleroma
+      # field name - pleroma.config.db.name
+      # description - The name of the Pleroma database.
+      # default value - pleroma_db
+      #name: pleroma_db
 
-      # field name - 
-      # description - 
-      # default value -
+      # field name - pleroma.config.db.user
+      # description - The name of the database user.
+      # default value - pleroma
       #user: pleroma
+
+      # field name - pleroma.config.db.connLimit
+      # description - The number of allowed concurrent connections to the database.
+      # default value - 15
+      #connLimit: 15
   ssl:
     #csr:
     #  countryName: ""
@@ -137,11 +175,20 @@ pleroma:
     #  stateOrProvinceName: ""
     letsEncrypt:
       enable: false
-      acmeAccountEmail: *email
-      acmeDirectory: "https://acme-v02.api.letsencrypt.org/directory"
-      termsAgreed: yes
-      validateCerts: true
+      #acmeAccountEmail: *email
+      #acmeDirectory: "https://acme-v02.api.letsencrypt.org/directory"
+      #termsAgreed: yes
+      #validateCerts: true
   keybase:
+    # field name - pleroma.keybase.enable
+    # default value - false
+    # description -
+    #   If set to true the playbook will upload your keybase text file and
+    #   configure Nginx in order to prove your Keybase identity against your
+    #   Pleroma instance.
     enable: false
     proof:
-      filepath: "{{ lookup('env','HOME') }}/keybase.txt"
+      # field name - pleroma.keybase.proof.filepath
+      # default value - ${HOME}/keybase.txt
+      # description - The file path to your keybase text file on your Ansible controller.
+      #filepath: "{{ lookup('env','HOME') }}/keybase.txt"