Skip to content

Commit 9022ceb

Browse files
committed
📝 (readme): Updated the README file
1 parent df8fb3f commit 9022ceb

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,29 @@ You only need one of the following requirements:
1010
- 18.x
1111
- 20.x
1212

13-
You need a `.env` file, you can copy `.example.env` and fill the missing values.
13+
### Environment variables
14+
15+
This is a description of the needed environment variable for the application at runtime, at least, for the "initialization" step.
16+
17+
| Name | Description | Mandatory |
18+
| -- | -- | -- |
19+
| TOKEN | Discord Bot token | Yes |
20+
| MONGO_URI | MongoDB URI connection (see the Docker Compose file for example) | Yes |
21+
| MONGO_INITDB_ROOT_USERNAME | MongoDB root username | Yes |
22+
| MONGO_INITDB_ROOT_PASSWORD | MongoDB root password | Yes |
23+
| MONGO_DATABASE | MongoDB database name | No |
24+
| LOG_DIR | Application logs directory | No |
1425

1526
### Standalone container
1627

1728
You can use the `Dockerfile` at the project root, but you will need a MongoDB isntance anyway.
29+
The container will need the above environment variables.
1830

1931
### With Docker Compose
2032

21-
The containers need the following environment variables:
33+
The production Docker Compose file uses a `.env` file, you can create one with the above environment variables.
34+
35+
The Docker Compose file need the following environment variables:
2236
- `MONGO_INITDB_ROOT_USERNAME`
2337
- `MONGO_INITDB_ROOT_PASSWORD`
2438

0 commit comments

Comments
 (0)