README-DOCKER.md

Docker help for {{bot}}

You have multiple options to run an instance of {{bot}} using docker.

• Docker help for {{bot}}
  • Using docker-compose and building the image
  • Using pure docker
    • [Optional] Building the image
    • Creating the container

Using docker-compose and building the image

This is the easiest method to run the bot with modifications.

1. cd into the repository.

2. Create the docker-compose.yml file:

   version: '3'
   services:
     {{bot}}:
       build: .
       image: "{{image}}:local-latest"
       restart: on-failure
       volumes:
         - "./data:/app/data:rw"
       environment:
         - PYTHONUNBUFFERED=1

3. Create a subdirectory named data.

4. Copy the templates for options.py and keys.py to data/, and edit them.

5. Run docker-compose:

   $ docker-compose build --pull
   $ docker-compose -d
   

   Run without "-d" to test the bot. (run in foreground)

Using pure docker

This methods is not very nice to use.
I just wanna run the darn thing, not do gymnastics!

[Optional] Building the image

1. cd into the repository.

2. Run docker build:

   $ docker build -t {{image}}:local-latest .
   

Creating the container

1. Be in a directory with a data/ subdirectory, which should contain valid options.py and keys.py files (copy and edit the templates).

2. Run the container:

   $ docker run -d --rm --mount type=bind,src=$(pwd)/data,dst=/app/data --name {{bot}} [image]
   

   Where [image] is either of:

   • {{image}}:local-latest if you are building your own.