Move comments for email_notifications config to docs
authorRoman Chvanikov <chvanikoff@gmail.com>
Sun, 21 Apr 2019 12:36:31 +0000 (19:36 +0700)
committerRoman Chvanikov <chvanikoff@gmail.com>
Sun, 21 Apr 2019 12:36:31 +0000 (19:36 +0700)
config/config.exs
docs/config.md

index 2663b1ebd244b3eab1c2633b52871a4cf1e896de..b1d506b59381e80c783e7dc0a98f4e6da75c95da 100644 (file)
@@ -468,14 +468,9 @@ config :pleroma, Pleroma.ScheduledActivity,
 
 config :pleroma, :email_notifications,
   digest: %{
-    # Globally enable or disable digest emails
     active: true,
-    # When to send digest email, in crontab format (https://en.wikipedia.org/wiki/Cron)
-    # 0 0 * * 0 - once a week at midnight on Sunday morning
     schedule: "0 0 * * 0",
-    # Minimum interval between digest emails to one user
     interval: 7,
-    # Minimum user inactivity threshold
     inactivity_threshold: 7
   }
 
index 5a97033b203cbca7726836774f9c3a849979f420..69d3893827c6ad9ccab536c78a9a170886eee946 100644 (file)
@@ -435,6 +435,18 @@ Authentication / authorization settings.
 * `oauth_consumer_template`: OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.
 * `oauth_consumer_strategies`: the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable.
 
+## :email_notifications
+
+Email notifications settings.
+
+  - digest - emails of "what you've missed" for users who have been
+    inactive for a while.
+    - active: globally enable or disable digest emails
+    - schedule: When to send digest email, in [crontab format](https://en.wikipedia.org/wiki/Cron).
+      "0 0 * * 0" is the default, meaning "once a week at midnight on Sunday morning"
+    - interval: Minimum interval between digest emails to one user
+    - inactivity_threshold: Minimum user inactivity threshold
+
 # OAuth consumer mode
 
 OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).