37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
|
ts3audiobot
|
||
|
|
=========
|
||
|
|
|
||
|
|
This will setup a [TS3AudioBot](https://github.com/Splamy/TS3AudioBot) server using a docker container.
|
||
|
|
|
||
|
|
Requirements
|
||
|
|
------------
|
||
|
|
|
||
|
|
You will need to have docker, docker-compose and, if using the web API, traefik installed or declared as dependencies with their respective roles.
|
||
|
|
|
||
|
|
**This role assumes that, if using the web API, you have setup traefik with an endpoint called `websecure`.**
|
||
|
|
|
||
|
|
Role Variables
|
||
|
|
--------------
|
||
|
|
|
||
|
|
**Please look at the [defaults/main.yml](defaults/main.yml) for all available variables and their description.**
|
||
|
|
|
||
|
|
**Note: Lines that are commented out via `#` are usually still valid/used variables, but they are not defined by default, so they might enable a feature, when uncommenting/defining them!**
|
||
|
|
|
||
|
|
### Global variables, that are used:
|
||
|
|
**Only needed with an enabled redirect and traefik:**
|
||
|
|
|
||
|
|
- `proxy_network`: Defined by the local traefik installation, this is the shared proxy network used by traefik to reach the containers. (optional)
|
||
|
|
- `proxy_hiddenservice`: Defined by the local traefik installation, this is used to generate the alt-svc header for the alternative Tor domain. (optional)
|
||
|
|
|
||
|
|
Dependencies
|
||
|
|
------------
|
||
|
|
|
||
|
|
- docker
|
||
|
|
- docker-compose
|
||
|
|
- traefik (optional, needed when using the redirect)
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
|
||
|
|
GPL-3.0-only
|