diff --git a/wiki/discord.md b/wiki/discord.md index b92a325..74c34d5 100644 --- a/wiki/discord.md +++ b/wiki/discord.md @@ -12,3 +12,12 @@ This section addresses various features of Discord. By default Discord performs an automatic check to see if it is up to date. On [Linux](/wiki/linux.md)-based systems it can be disabled by adding `"SKIP_HOST_UPDATE": true` to the `~/.config/discord/settings.json` file. + +### Setting Up a Music Bot + +For Discord there are various bots capable of playing music. +The following is a list of bots featured in this wiki that can do this. + +- [Sinusbot](/wiki/sinusbot.md) is a self-hosted bot for Discord that can play music and sounds. + It's closed-source and free of charge. + It also features [Teamspeak](/wiki/teamspeak.md) support. diff --git a/wiki/docker/sinusbot_-_docker.md b/wiki/docker/sinusbot_-_docker.md new file mode 100644 index 0000000..b41c635 --- /dev/null +++ b/wiki/docker/sinusbot_-_docker.md @@ -0,0 +1,116 @@ +# sinusbot - docker + +This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md). +The Server consists of a single Docker container. + +## Set-up + +Create the files `rebuild.sh` and `docker-compose.yml` at the same place. + +The `docker-compose.yml` file includes a network section. +This is only needed if the [Teamspeak](/wiki/teamspeak.md) server is set up on the same machine. +If it is not the network `teamspeak` may be removed. +If it Teamspeak and Sinusbot are set up on the same machine make sure to include the `teamspeak` +network in the [Teamspeak Docker container](/wiki/docker/teamspeak.md) and set an alias. +Include the follwing lines in your teamspeak `docker-compose.yml` file under the `teamspeak3` +service. + +```yml +networks: + teamspeak: + aliases: + - ts3.docker.local +``` + +Add the following lines at the end of the `docker-compose.yml` or add it to the definition of +already existing networks. + +```yml +networks: + teamspeak: + external: true +``` + +Finally make sure to create the external network `teamspeak` before starting the containers. +This can be done by running the following command. + +```sh +docker network create teamspeak +``` + +The Teamspeak server can then be found by Sinusbot under host `ts3.docker.local` and port `9987`. + +Change the other settings according to your needs and run `./rebuild.sh` afterwards. + +## Environment-variables + +Set the following environment-variables in the `environment:` section of the +docker-compose file. + +| Name | Usage | Default | +| ----------- | ------------------------------ | ------- | +| `UID` | User userid to run gitea | | +| `GID` | User groupid to run gitea | | + +## Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Outside mount/volume name | Container mount | Description | +| ------------------------- | ----------------------- | ------------------------------------- | +| `sinusbot_scripts` | `/opt/sinusbot/scripts` | storage for the sinusbot scripts | +| `sinusbot_data` | `/opt/sinusbot/data` | storage for the most of sinusbot data | + +## Ports + +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ---------------------- | +| `8087` | `8087` | TCP | WebUI | + +## Networks + +Set the following networks in the `networks:` section of the docker-compose file. + +| Name | Usage | +| ----------- | ---------------------------- | +| `teamspeak` | connect with local teamspeak | + + +## rebuild.sh + +```sh +#!/bin/sh +docker-compose down +docker pull sinusbot/docker:latest +docker-compose up -d +``` + +## docker-compose.yml + +```yml +version: "3.3" +services: + sinusbot: + image: "sinusbot/docker:latest" + restart: unless-stopped + environment: + - UID=1000 + - GID=1000 + networks: + - teamspeak + volumes: + - sinusbot_scripts:/opt/sinusbot/scripts + - sinusbot_data:/opt/sinusbot/data + +networks: + teamspeak: + external: true + +volumes: + sinusbot_scripts: + driver: local + sinusbot_data: + driver: local +``` diff --git a/wiki/sinusbot.md b/wiki/sinusbot.md new file mode 100644 index 0000000..efc80a4 --- /dev/null +++ b/wiki/sinusbot.md @@ -0,0 +1,10 @@ +# Sinusbot + +[Sinusbot](https://www.sinusbot.com/) is a bot that can play music on both +[Teamspeak](/wiki/teamspeak.md) and [Discord](/wiki/discord.md) servers. +It is self-hostable, closed-source and free of charge. + +## Setup + +The software can be setup via [Docker](/wiki/docker.md) with the +[sinusbot image](/wiki/docker/sinusbot_-_docker.md). diff --git a/wiki/teamspeak.md b/wiki/teamspeak.md index fa3dff0..8e7aed4 100644 --- a/wiki/teamspeak.md +++ b/wiki/teamspeak.md @@ -59,3 +59,12 @@ For Teamspeak3 on [Linux](/wiki/linux.md) systems this folder can be found at `/opt/teamspeak3/sound`. For Teamspeak5 on Linux the folder is available at `/opt/teamspeak/html/client_ui/sound`. Following this the sound pack is available after the next (re-)start of teamspeak. + +### Setting Up a Music Bot + +For Teamspeak there are various bots capable of playing music. +The following is a list of bots featured in this wiki that can do this. + +- [Sinusbot](/wiki/sinusbot.md) is a self-hosted bot for Teamspeak that can play music and sounds. + It's closed-source and free of charge. + It also features [Discord](/wiki/discord.md) support.