Skip to content

Commit 9cd2865

Browse files
committed
docs: add comprehensive comments to config template
- Document all configuration options with descriptions - Note environment variable support for key settings - Include value ranges and defaults - Clarify Docker-specific paths
1 parent 1c8ae71 commit 9cd2865

1 file changed

Lines changed: 51 additions & 1 deletion

File tree

config_template.json

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,73 @@
11
{
2+
"_comment": "Reddit Mod
3+
4+
Log Wiki Publisher Configuration",
5+
"_comment_envars": "All settings can be overridden with environment variables. See README for details.",
6+
27
"reddit": {
8+
"_comment": "Reddit API credentials - Get from https://www.reddit.com/prefs/apps",
39
"client_id": "YOUR_CLIENT_ID_HERE",
410
"client_secret": "YOUR_CLIENT_SECRET_HERE",
511
"username": "YOUR_BOT_USERNAME",
612
"password": "YOUR_BOT_PASSWORD"
713
},
14+
815
"source_subreddit": "YourSubreddit",
16+
"_comment_source_subreddit": "Subreddit to fetch modlog from and publish wiki to (env: SOURCE_SUBREDDIT)",
17+
918
"wiki_page": "modlog",
19+
"_comment_wiki_page": "Wiki page name to publish to (env: WIKI_PAGE)",
20+
1021
"retention_days": 90,
22+
"_comment_retention_days": "Days to keep entries in database (1-365, env: RETENTION_DAYS)",
23+
1124
"batch_size": 50,
25+
"_comment_batch_size": "Number of modlog entries to fetch per run (10-500, env: BATCH_SIZE)",
26+
1227
"update_interval": 600,
28+
"_comment_update_interval": "Seconds between updates in continuous mode (60-3600, env: UPDATE_INTERVAL)",
29+
1330
"max_wiki_entries_per_page": 1000,
31+
"_comment_max_wiki_entries": "Maximum entries to show in wiki (100-2000)",
32+
33+
"wiki_display_days": 90,
34+
"_comment_wiki_display_days": "Days of history to display in wiki (must be <= retention_days)",
35+
1436
"max_continuous_errors": 5,
37+
"_comment_max_errors": "Max consecutive errors before stopping (1-50)",
38+
1539
"rate_limit_buffer": 60,
40+
"_comment_rate_limit": "Extra seconds to wait after rate limit (30-300)",
41+
1642
"max_batch_retries": 3,
43+
"_comment_retries": "Max retries for failed batch fetches (1-10)",
44+
1745
"archive_threshold_days": 7,
46+
"_comment_archive": "Days before archiving old entries (1-30, affects database cleanup)",
47+
48+
"anonymize_moderators": true,
49+
"_comment_anonymize": "Replace mod names with AutoModerator/HumanModerator (env: ANONYMIZE_MODERATORS)",
50+
1851
"ignored_moderators": ["AutoModerator"],
52+
"_comment_ignored": "Moderator names to exclude from modlog",
53+
54+
"wiki_actions": [
55+
"removelink",
56+
"removecomment",
57+
"spamlink",
58+
"spamcomment",
59+
"addremovalreason",
60+
"approvelink",
61+
"approvecomment"
62+
],
63+
"_comment_wiki_actions": "Modlog action types to include in wiki. Remove this field to use defaults.",
64+
65+
"database_path": "/config/data/modlog.db",
66+
"_comment_database": "Path to SQLite database (env: DATABASE_PATH)",
67+
1968
"display_format": {
2069
"show_full_ids": false,
2170
"id_format": "prefixed"
22-
}
71+
},
72+
"_comment_display": "Wiki display formatting options"
2373
}

0 commit comments

Comments
 (0)