SinusBot Docker image

Features

• Easy Updateable
• Minimal dependencies to the Host system
• Integrated Text-to-Speech engine
• Compatible with macOS

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

It is recommended that you run the SinusBot as a non-root user, even though the docker container is mostly isolated from the host. This can be done as described in the following:

• add a new user: adduser --disabled-login sinusbot
• create the required folders if they don't exist: mkdir -p /opt/sinusbot/data /opt/sinusbot/scripts
• give the user permissions to the folders: chown -R sinusbot:sinusbot /opt/sinusbot
• add -u sinusbot to the docker run command shown above when you start it

Additional information on setting the user or remapping the user can be found in the docker documentation.

Get 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

License

To use your license, which you've got from the forums just drop the private.dat into the data folder. After that you can restart the SinusBot and the license should be applied.

Discord only image

There is an image for discord only usage, this won't contain the TeamSpeak client with the additonal dependencies. To use it you just have to use the discord tag instead of 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

Text-to-Speech

Per default, there is the Chromium Text-to-Speech engine pre installed. It can be simply enabled by setting the TTS.Enabled property in the config.ini of the data volume to true. It's per default disabled due performance issues / memory costs.

Once it's enabled it can be used by setting in the Instance settings en-US or de-DE as locale.

Other Docker registries

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:

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

docker-compose with TeamSpeak 3 Server

In the SinusBot you have to use the network alias teamspeak.docker.local as hostname.

# docker-compose.yml
version: '2'
services:
  teamspeak:
    image: teamspeak
    restart: always
    ports:
      - 9987:9987/udp
      - 10011:10011
      - 30033:30033
    environment:
      TS3SERVER_LICENSE: accept
    networks:
      mynetwork:
        aliases:
          - teamspeak.docker.local

  sinusbot:
    image: sinusbot/docker
    restart: always
    ports:
      - 8087:8087
    volumes:
      - ./scripts:/opt/sinusbot/scripts
      - ./data:/opt/sinusbot/data
    networks:
     - mynetwork
networks:
    mynetwork:
        driver: bridge