Skip to content
Robert S.W. Carroll edited this page May 8, 2023 · 3 revisions

TVWB, now with Docker!

To use docker, you must first install docker and docker-compose.

Docker Installation Guide

Docker Compose (might already be installed w/Docker)

Commands

There's two things to keep in mind. Starting the app and entering the app for configuration.

Starting/Running the app

To simply start the app, do the following command:

docker-compose run app start

Dissecting this command, we have docker-compose which is the base command. The run argument is saying to run a particular "service." In our case, it is the app service, defined in docker-compose.yml. The start is the start argument from the tvwb.py file.

To start the app detached (in the background) you can run:

docker-compose run -d app start

Entering/configuring the app

To configure or enter the app (as if you were doing it the "original" way) you can run the following command:

docker-compose run app shell

This command puts you into the tvwb.py shell. This allows you to create actions and events.

Keep in mind

Please keep in mind that the docker-compose.yml specifies a docker volume that more or less "links" whatever you do in the container to the ./src/components directory and the ./src/settings.py file. This ensures that your settings are saved.

This also means you can edit files and the changes will be reflected within the app.

For support getting the bot up and running, please use Discussions and hopefully someone can help :)

There's also a new discord! https://discord.gg/wrjuSaZCFh

I'm also available for quick questions on Twitter and available for consulting for more serious inquiries.

Clone this wiki locally