Skip to content
This repository was archived by the owner on Oct 10, 2024. It is now read-only.

Commit 33cb728

Browse files
authored
docs: envars docs (#802)
1 parent 632c900 commit 33cb728

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,25 @@ Copy `.env.example` to `.env` and add your private information
1515
*Note: never commit this file, it is ignored by Git*
1616

1717
```
18-
DISCORD_TOKEN="<your-token>"
19-
EDDIEBOT_MONGO_CONNECTION_STRING="<your-mongo-connection-string>"
18+
# .env file
19+
20+
# required: discord API token
21+
DISCORD_TOKEN=
22+
23+
# required: mongo URL connection string
24+
EDDIEBOT_MONGO_CONNECTION_STRING=
25+
26+
# optional
27+
DEBUG_HOOK=
28+
29+
# required: discord server id
30+
HOME_GUILD="699608417039286293"
31+
32+
# optional
33+
NODE_ENV="development"
34+
35+
# required: channel id for logs
36+
ADMIN_CHANNEL=
2037
```
2138

2239
## Installation

0 commit comments

Comments
 (0)