checkpoint: documentation in example config

examples/host_vars/pleroma-01.yml

@@ -1,26 +1,147 @@
 ---
+# TODO: In init role fail playbook if secrets are empty
 pleroma:
   config:
-    email: &email admin@localhost.private
+    # field name - pleroma.config.email
-    host: example.com
+    # description -
-    listeningPort: 4000
+    #   The email address of the instance administrator (you).
-    instanceName: "My Instance Name"
+    #   This should be your personal or organisational email.
-    instanceDescription: "My Instance Description"
+    # default value - admin@localhost
-    registrationsOpen: "false"
+    email: &email admin@localhost
-    logLevel: warn
+
-    #secretKeyBase:
+    # field name - pleroma.config.host
-    #signingSalt:
+    # description - The sub(domain) of your Pleroma instance.
+    # default value - pleroma.localhost
+    host: pleroma.example.com
+
+    # field name - pleroma.config.notifyEmail
+    # description - The email used for notifications.
+    # default value - no_reply@pleroma.localhost
+    #notifyEmail: no_reply@pleroma.example.com
+
+    # field name - pleroma.config.listeningPort
+    # description - The port number that Pleroma will bind to.
+    # default value - 4000
+    #listeningPort: 4000
+
+    # field name - pleroma.config.instanceName
+    # description - The name of your Pleroma instance.
+    # default value - "Ansible Pleroma"
+    instanceName: "My Instance's Name"
+
+    # field name - pleroma.config.instanceDescription
+    # description - The description of your Pleroma instance.
+    # default value - "A new single instance of Pleroma"
+    instanceDescription: "My Instance's Description"
+
+    # field name - pleroma.config.characterLimit
+    # description - The character limit for each post.
+    # default value - 5000
+    #characterLimit: 5000
+
+    # field name - pleroma.config.registrationsOpen
+    # description - If set to "true" this allows anyone to register on your instance.
+    # default value - "false"
+    #registrationsOpen: "false"
+
+    # TODO: This needs to be updated
+    # field name - pleroma.config.
+    # description -
+    # default value -
+    #dynamicConfiguration: "false"
+
+    # field name - pleroma.config.healthCheck
+    # description - Show system data at /api/pleroma/healthcheck if set to "true".
+    # default value - "false"
+    #healthCheck: "false"
+
+    # field name - pleroma.config.remotePostRetentionDays
+    # description - The default amount of days to retain remote posts when pruning the database.
+    # default value - 90
+    #remotePostRetentionDays: 90
+
+    # field name - pleroma.config.logLevel
+    # description - Sets the log level of the Pleroma application.
+    # default value - info
+    #logLevel: info
+
+    # field name - pleroma.config.federating
+    # description - Enable federation with other instances if set to "true".
+    # default value - "true"
+    #federating: "true"
+
+    # field name - pleroma.config.chatEnabled
+    # description - Enable the chat window if set to "true".
+    # default value - "true"
+    #chatEnabled: "true"
+
+    # field name - pleroma.config.secretKeyBase
+    # description -
+    #   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'
+    secretKeyBase:
+
+    # field name - pleroma.config.signingSalt
+    # description -
+    #   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'
+    signingSalt:
+
+    #mrf:
+    #  simplePolicy:
+    #    reject: []
+    #    federatedTimelineRemoval: []
+    #    mediaRemoval: []
+    #    mediaNsfw: []
+    #    reportRemoval: []
+    #frontend:
+    #  background: ""
+    #  themes:
+    #    custom: []
+    #    default: pleroma-dark
     webPushEncryption:
+      # field name - 
+      # description - 
       email: *email
-      #privateKey:
+
-      #publicKey:
+      # field name - 
+      # description - 
+      privateKey:
+
+      # field name - 
+      # description - 
+      publicKey:
     db:
-      name: pleroma
+      # field name - 
-      user: pleroma
+      # description - 
-      #password:
+      password:
+
+      # field name - 
+      # description - 
+      # default value -
+      #name: pleroma
+
+      # field name - 
+      # description - 
+      # default value -
+      #user: pleroma
   ssl:
+    #csr:
+    #  countryName: ""
+    #  emailAddress: "{{ pleroma.config.email }}"
+    #  localityName: ""
+    #  organizationName: ""
+    #  organizationUnitName: ""
+    #  stateOrProvinceName: ""
     letsEncrypt:
-      enable: true
+      enable: false
       acmeAccountEmail: *email
       acmeDirectory: "https://acme-v02.api.letsencrypt.org/directory"
       termsAgreed: yes
+      validateCerts: true
+  keybase:
+    enable: false
+    proof:
+      filepath: "{{ lookup('env','HOME') }}/keybase.txt"

roles/init/defaults/main.yml

@@ -2,7 +2,7 @@
 pleroma_defaults:
   config:
     email: admin@localhost
-    notifyEmail: no_reply@{{ pleroma.config.host }}
+    notifyEmail: no_reply@pleroma.localhost
     host: pleroma.localhost
     listeningPort: 4000
     instanceName: "Ansible Pleroma"
@@ -10,7 +10,7 @@ pleroma_defaults:
     characterLimit: 5000
     registrationsOpen: "false"
     dynamicConfiguration: "false"
-    healthCheck: "true"
+    healthCheck: "false"
     remotePostRetentionDays: 90
     logLevel: info
     federating: "true"