/docker

Official Docker image of the SinusBot for TeamSpeak 3 and Discord.

Primary LanguageShellMIT LicenseMIT

SinusBot Docker image

Docker Automated build Docker Build Status Docker Pulls Image Info

Installation

By using this image you accept the Privacy statement of the TeamSpeak Systems GmbH and the license agreement of the SinusBot.

docker-compose

Download the docker-compose file in it's own directory and start it with docker-compose up.

docker

docker run -d -p 8087:8087 \
           -v scripts:/opt/sinusbot/scripts \
           -v data:/opt/sinusbot/data \
           --name sinusbot sinusbot/docker

Get Sinusbot Password

After starting the SinusBot docker image with docker run an ID will be returned in the next line. Use the command docker logs <ID> (replace <ID> with the long container ID) to print out the logs of the container. The beginning of the log should contain your credentials:

[...]
-------------------------------------------------------------------------------
Generating new bot instance with account 'admin' and password 'YOUR_PASSWORD_HERE'
PLEASE MAKE SURE TO CHANGE THE PASSWORD DIRECTLY AFTER YOUR FIRST LOGIN!!!
-------------------------------------------------------------------------------
[...]

Password overriding

By setting the OVERRIDE_PASSWORD environment variable you can override the password of the SinusBot. Usage:

docker run -d -p 8087:8087 \
           -v scripts:/opt/sinusbot/scripts \
           -v data:/opt/sinusbot/data \
           -e OVERRIDE_PASSWORD=foobar \
           --name sinusbot sinusbot/docker

Discord only image

There exists an image for discord only usage, this won't contain the teamspeak client with the additonal dependencies. For that use the discord tag instead of the latest (default) tag:

docker run -d -p 8087:8087 \
           -v scripts:/opt/sinusbot/scripts \
           -v data:/opt/sinusbot/data \
           --name sinusbot sinusbot/docker:discord

Updating the image

Run the following command to update the image to the latest version:

docker pull sinusbot/docker

After that you just need to restart your container, by executing the following command:

docker restart CONTAINER_NAME

Other Docker registries

QUAY

Docker Repository on Quay

Can be pulled by using:

docker pull quay.io/sinusbot/docker

Also the discord image is available on the discord tag:

docker pull quay.io/sinusbot/docker:discord

For using docker-compose with quay.io just replace sinusbot/docker with quay.io/sinusbot/docker. Example:

sinusbot:
  image: quay.io/sinusbot/docker
  restart: always
  ports:
    - 8087:8087
  volumes:
    - ./scripts:/opt/sinusbot/scripts
    - ./data:/opt/sinusbot/data