demize/quesoqueue repository overview

⁠Queso Queue Docker

This is a containerized version of Shoujo's Queso Queue Plus bot. Please see this container's⁠ or upstream's⁠ repositories for more information.

⁠Tags

Use the dev tag unless you have some reason to use a specific version. There is no latest tag, as upstream is not versioned and thus no version should be considered "stable".

⁠Using the container

This section is taken from the container's Github⁠, and refers to some files that exist in the repository. Please refer to the repository for full information.

⁠Quick Start with Docker Compose

1. Install the Docker Engine⁠. Docker Desktop may be the easiest choice, depending on platform, but is not needed so long as you have the engine.
2. Create a new Twitch account for your bot, or decide to use your own.
3. Log into the Twitch account you'll be using for your bot and generate an oauth token for it with this site⁠. Write this token down, you'll need it soon.
4. Create a folder on your machine to store the Compose configuration in, with:
   1. The docker-compose.yml from this repository
   2. queso.env.sample from this repository, renamed to queso.env
   3. An empty folder named "config"
5. Edit queso.env as necessary. The key values to change are USERNAME, PASSWORD, and CHANNEL. Set the username to the username you decided on in step 2, the password to the oauth token you wrote down in step 3, and the channel to your own twitch username (where you want to be using the bot).
   • There may be other settings you want to adjust as well. Of particular note is the LEVEL_SELECTION setting, which has a unique format; make sure that the entire setting is enclosed in single quotes('), and each option uses double quotes (").
6. Once queso.env is properly configured, start the container. In a terminal (or command prompt) window, you can do this with either docker compose up or docker-compose up (depending on your system configuration, either may work). Make sure there are no error messages printed out on screen, and then pop into your Twitch chat to test out the bot (try !adding a level code, try !list).
7. If everything looks good, you can leave the bot running in that window, or you can stop it with Ctrl+C and then run it in the background ("detached") by using docker compose up -d and stop it with docker compose stop (with or without the dash, as above).
8. If you need to change any of the configuration values, then after stopping the container, run docker compose rm -v to remove the container and its anonymous volume, forcing the configuration to be regenerated the next time it starts.

⁠Updating

Updating automatically is strongly discouraged, as the upstream bot is neither versioned nor stable, so any change could be breaking. While this container is manually tested every version, and tries to act as a forward compatibility layer, no guarantees can be made that an update will not break your setup.

To update, it is always recommended to remove the container first with either docker compose down -v or docker compose rm -v, then pull the latest version with docker compose pull and start it non-detached to ensure it works without issues.

Should you run into any issues, please double check the documentation (the env file in particular) to see if anything changed; you can also check the commit history of this repository to see what changes specifically were made. If you cannot solve the issue, please open an issue⁠ and we'll try to help.