Skip to content

Commit 665d73e

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 665d73e

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

config_template.json

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

0 commit comments

Comments
 (0)