Skip to content

Commit 79c128e

Browse files
committed
chore: update .env.example to clarify required Discord bot credentials and server configuration
1 parent 1bf9785 commit 79c128e

1 file changed

Lines changed: 21 additions & 19 deletions

File tree

.env.example

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
# Local Environment Variables (Secrets)
2-
# Copy this file to .env and fill in your actual values
3-
# .env is gitignored and should NEVER be committed
1+
# Discord Bot Credentials (REQUIRED - Secret values, do not commit!)
2+
DISCORD_TOKEN=your_discord_bot_token_here
3+
CLIENT_ID=your_discord_client_id_here
44

5-
# Discord Bot Token & Application ID (REQUIRED)
6-
# Get this from: https://discord.com/developers/applications
7-
DISCORD_TOKEN=your-bot-token-here
8-
CLIENT_ID=your-bot-application-id
5+
# Server Configuration (REQUIRED)
6+
SERVER_ID=your_server_id_here
97

10-
# Override any public config values for local testing
8+
# Channel IDs (REQUIRED)
9+
GUIDES_CHANNEL_ID=your_guides_channel_id_here
10+
ADVENT_OF_CODE_CHANNEL_ID=your_advent_of_code_forum_channel_id_here
11+
REPEL_LOG_CHANNEL_ID=your_repel_log_channel_id_here
1112

12-
# Discord Server ID (your dev server)
13-
SERVER_ID=your-server-id
13+
# Role IDs (REQUIRED)
14+
MODERATORS_ROLE_IDS=role_id_1,role_id_2,role_id_3
15+
REPEL_ROLE_ID=your_repel_role_id_here
1416

15-
# Channel IDs (from your dev server)
16-
GUIDES_CHANNEL_ID=your-guide-channel-id
17-
REPEL_LOG_CHANNEL_ID=your-repel-log-channel-id
17+
# Optional Role IDs
18+
# ROLE_A_ID=optional_role_a_id
19+
# ROLE_B_ID=optional_role_b_id
20+
# ROLE_C_ID=optional_role_c_id
1821

19-
# Role IDs (from your dev server)
20-
REPEL_ROLE_ID=your-repel-role-id
21-
MODERATORS_ROLE_IDS=your-moderator-role-id
22-
23-
# Other
24-
GUIDES_TRACKER_PATH=guides-tracker.json
22+
# Data Persistence (OPTIONAL)
23+
# Local development defaults to current directory
24+
# Docker deployments should use /app/data for persistence
25+
GUIDES_TRACKER_PATH=guides-tracker.json
26+
ADVENT_OF_CODE_TRACKER_PATH=advent-of-code-tracker.json

0 commit comments

Comments
 (0)