From 634e6560c69c213baa38fa5c9e7bbc6425dc1a20 Mon Sep 17 00:00:00 2001 From: Paillat Date: Fri, 14 Jul 2023 16:55:59 +0200 Subject: [PATCH] docs(DOCKER.md): update instructions for running the bot in a Docker container - Add clarification about creating a `.env` file in the root of the project - Mention the need to change parameters in the `.env` file - Provide a link to an example `.env` file - Refer to the [Settings page](.github/Docs/SETTINGS.md) for changing environment file settings - Add a note about trying the commands without a dash between docker and compose if they fail --- .github/Docs/DOCKER.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/Docs/DOCKER.md b/.github/Docs/DOCKER.md index 2192ef5..e101cd5 100644 --- a/.github/Docs/DOCKER.md +++ b/.github/Docs/DOCKER.md @@ -8,7 +8,9 @@ To run this project in a Docker container you must have Docker and Docker Compos Once you have Docker and Docker Compose installed in your machine, clone or download this repository and follow the instructions below. ## **Running the Bot** -To run the bot in a Docker container, you must first create a `.env` file in the root of the project if there isn't one already. You will need to change the parameters in the `.env` file to your own parameters. You can find an example of a `.env` file [here](.env.example). You will also be able to change the settings in that environment file as explained in the [Settings page](.github/Docs/SETTINGS.md). +To run the bot in a Docker container, you must first create a `.env` file in the root of the project if there isn't one already. You will need to change the parameters in the `.env` file to your own parameters. You can find an example of a `.env` file [here](.env.example). You will also be able to change the settings in that environment file as explained in the [Settings page](.github/Docs/SETTINGS.md). + +**If any of the following commands fail, try without a dash between docker and compose.** To run the bot, simply execute the following command in the root of the project: ```bash