From b6e5bd34debfbe2b0fbecc47859c3f890124828f Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Mon, 26 Oct 2020 00:11:20 +0000 Subject: [PATCH] feat(*): Add docker information to readme file --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 9008861..9fcbce5 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,32 @@ Commands: * sq - Show the queue * cq - Clear the queue (admin-only, not to be shared with normal users) * ru - Remove a tagged user from the queue (admin-only, not to be shared with normal users) + +## Dockerize the bot + +To build a docker image, open a command window in the project directory and run: + +`docker build -t denBot .` + +For a sanity check, you can run `docker images` and it should be displayed in that list. + +## Running the Docker container + +Running our bot with -d runs the container in detatched mode (as in it runs in the background). If you want to see what is happening, remove that option. + +`docker run -d my-bot` + +### More information +If you want more of a sanity check here are some following commands you can run the following commands: + +``` +# Get the container! +docker ps + +# Print the logs +docker logs +``` + +To access the command line inside the docker container you can run: + +`docker exec -it /bin/bash`