ts3mb/ts3musicbot repository overview

You ever wanted to play music on your teamspeak or discord server? Now you can!
TS3MusicBot is a unique feature for your teamspeak or discord server fully working on linux and windows.

Upload music files, manage folders, play all kind of music files, stream live internet radio stations, 
direct playback of youtube, soundcloud and more links.
The TS3MusicBot can be controlled with chat commands or with the build in webinterface.

Listen to music in groups while playing your favorite game. Let your friends listen to a youtube video you found.
A new experience to listen music live with others in the same channel.

docker create \
--name=TS3MB \
-p 8080:8080 \
-p 9000:9000 \
-e [email protected] \
-e PASSWORD_ADMIN=admin \
-e PASSWORD_USER=user \
-v [/path/to/bot_core]:/app/ts3mb_core \
-v [/path/to/bot_media]:/app/ts3mb_media \
-v [/path/to/shared/bot_temp]:/app/ts3mb_tmp \
-v /dev/shm:/dev/shm \
ts3mb/ts3musicbot

version: '3.3'
services:
    ts3musicbot:
        ports:
            - '8080:8080'
            - '9000:9000'
        environment:
            - [email protected]
            - PASSWORD_ADMIN=admin
            - PASSWORD_USER=user
        volumes:
            - '[/path/to/bot_core]:/app/ts3mb_core'
            - '[/path/to/bot_media]:/app/ts3mb_media'
            - '[/path/to/shared/bot_temp]:/app/ts3mb_tmp'
            - '/dev/shm:/dev/shm'
        restart: always
        image: ts3mb/ts3musicbot

-e [email protected] - This is your licensed account 
-v [/path/to/bot_core]:/app/ts3mb_core - Here the bot will be stored  (CAN'T be used by multiple containers)  
-v [/path/to/bot_media]:/app/ts3mb_media - Here is the music for the bot stored  (can be used by multiple containers)
-v [/path/to/shared/bot_temp]:/app/ts3mb_tmp - Here are shared librarys stored (USE THE SAME FOR ALL)
-v /dev/shm:/dev/shm - Give access to shared memory. Reduces memory consumtion for Browser and Player

*Botsettings
-e BETA=true - If you want to use the beta version of the bot set this ENV.
-e BIND_IP=23.45.278.90 - Bind query and webinterface to one ipaddress (remove env to disable it)
-e BIND_IP_WEBINTERFACE=23.45.278.90 - Bind only webinterface to one ipaddress (remove env to disable it)
-e CLP="" - additional command-line parameters (remove env to disable it)
-e CONFIG_NUMBER=1 - Only for private licence  [Values = 1, 2, 3, 4, 5 or 6] Define which config the bot load  (remove env to disable it)
-e CONNECT_OVER_PUBLIC_IP=23.45.278.90 - Connect-over-public-ip  (remove env to disable it)
-e DEMO_MODE=true - Disables the permissionsystem. Everyone can use admin chatcommands
-e DISBALE_YTDL=true - Disables the download-function of the bot
-e DISABLE_CLICKABLE_URLS_CHECK=true - Enable clickable urls for musicsearch in TS3 Chat
    -> force enables the clickable url feature and does not check if the webinterface port is open
-e ENABLE_CLICKABLE_URLS=true - Enable clickable urls for musicsearch in TS3 Chat
    -> ENABLE_CLICKABLE_URLS works only if external port and internal port for the container is the same or DISABLE_CLICKABLE_URLS_CHECK is set
-e EXAMPLE_FILES_MUSIC=/folder - if enabled bot will copy folder to ts3mb_media/music/examples folder [Limited to 100MB and 50 Files] (remove env to disable it)
-e EXAMPLE_FILES_RADIO=/folder - if enabled bot will copy folder to ts3mb_media/radio/examples folder [Limited to 100MB and 50 Files] (remove env to disable it)
-e EXAMPLE_FILES_PLAYLIST=/folder - if enabled bot will copy folder to ts3mb_media/playlist/examples folder [Limited to 100MB and 50 Files] (remove env to disable it)
-e EXAMPLE_FILES_FORCE=true - if enabled bot will cleanup the destination (one way synch)
[not supported yet] -e FORCE_CHANNEL=3 - forces the bot to stay in a specific channel (remove env to disable it)
-e FORCE_DISCORD_TXT_CHANNEL=3 - forces the bot to stay in a specific text channel in discord(remove env to disable it)
-e FORCE_DIRECT_MODE=true - disables the indirect playback mode
-e FORCE_USERNAME=Bot234 - forces the username for the bot (remove env to disable it)
[not supported yet] -e FORCE_WHISPER=true - forces the bot to activate whisper mode
-e HOSTERKEY=jhdzwjsh - Only for Hoster-API (remove env to disable it)
-e IDENTITY=ts3identity.ini- forces the bot to load this identity on startup (remove env to disable it)
-e KEEP_LOGIN=true - Disable automatic seed generation for login. This can break tools like Soundstream or Webstream
-e MAX_DISKSPACE=500 - How much space the bot should use for music, playlists and co? (remove env for infinite)
-e OTC=true - One Time Code that will be added to the password and to the Username (if username is forced)
    -> OTC can be readed from logs or from startcommand (in startcommand b64 encoded) 
-e PASSWORD_ADMIN=admin - The admin password of the webinterface (visible settings) 
-e PASSWORD_USER=user - The user password of the webinterface (hidden settings) 
	-> All passwords will be automatical base64 encoded and if ENV not set a password will be generated at startup.
	--> You can set your own base64 string. You need to add b64 infront of it. (e.g. PASSWORD_ADMIN='b64dGVzdA==' for dGVzdA==)
-e PORTABLE=true - Starts the bot in portable mode. Uses 10 times more disk space. Use only in case of bugs!
-e QUERY=true - run bot in query mode
-e SET_MUSIC_PERMISSIONS=true|force - try to set permissions for music library at startup
-e START_CHANNEL=3 - forces the bot to join a specific channel at startup (remove env to disable it)

**Healthcheck
-e HEALTHI_DEBUG=true - turn on the debug mode for the internal health script
-e DISABLE_HEALTHCHECK=true - Disables the healthcheck (internal & external)

**Webbrowser Feature
-e DISBALE_WEBBROWSER=true - disables the webbrowser
-e WEBBROWSER_MEMLIMIT=300 - sets a memory limit for the browser in MB (default 300) [ 0 = unlimited]
-e WEBBROWSER_CPULIMIT=80 - sets a cpu limit for the browser in % (default 80) [ 0 = unlimited | can be higher than 100]

**MaxLifeTime Feature
-e MAX_LIFETIME=300 - stops the bot container after x seconds (remove env to disable it)
-e MAX_LIFETIME_BLOCK=true - prevent bot container from restarting, if it's maximal lifetime is reached - reset by recreate container 
-e MAX_LIFETIME_WEBSTART=true - starts countdown on first login
-e MAX_LIFETIME_COMMANDSTART=true - starts countdown on first command

**Bridge/Hub Feature
-e FORCE_BRIDGE_MODE=true - force enables the bridge mode for the bot
-e FORCE_BRIDGE_TOKEN=true - forces the bot to use the given token
-e FORCE_HUB_MODE=true - force enable the hub mode for the bot

**Ports
-e PORT=8080 - Webinterface port (Standard 8080) 
-e STREAMPORT=9000 - Port for Soundstream (Standard 9000)

**Reset Feature
-e RESET_CORE=true - removes the systemfolder of the bot EVERY startup
-e RESET_MEDIA=true - removes the mediafolder of the bot EVERY startup [**Attention** - Deletes all music]
-e RESET_SETTINGS=true - the bot deletes the configuration at startup (-number affects which config will be deleted)

**Runtime Parameter
-e PUID=1000 - run as user with id 1000
-e PGID=1000 - run as user group with id 1000
-e TZ=Europe/Berlin - Timezone

  -p 8080 - Webinterface Port
  -p 9000 - Streaming Port

Monitor and restart unhealthy docker containers. 
This functionality was propose to be included with the addition of HEALTHCHECK, however didn't make the cut. 

A process for watching your Docker containers and automatically restarting them whenever their base image is refreshed.

Portainer is a lightweight management UI which allows you to easily manage your Docker host or Swarm cluster.

nginx-proxy sets up a container running nginx and docker-gen. 
docker-gen generates reverse proxy configs for nginx and reloads nginx when containers are started and stopped.

-v /path/to/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf:r

client_max_body_size 100M;

letsencrypt-nginx-proxy-companion is a lightweight companion container for nginx-proxy.
It handles the automated creation, renewal and use of Let's Encrypt certificates for proxyed Docker containers.

This driver let create you volumes with defined path