Installation Debian & Ubuntu

flyth edited this page Nov 4, 2016 · 43 revisions
Keep in mind: This software is highly experimental. It will reach a stable state soon.

If you are new to Linux and/or wish to have everything installed for you in a more convenient way, we encourage you to use the Install Script.

Let's start by installing several dependencies:

apt-get install x11vnc xvfb libxcursor1 ca-certificates bzip2 -y
update-ca-certificates

On Debian and some Ubuntu versions you might as well have to install, so at least try

apt-get install libglib2.0-0

Let's assume that you're going to install the bot to /opt/ts3soundboard and are using the user sinusbot with the group sinusbot. We will install the bot with root then switch to this user account when running the bot.

You will need to add the user sinusbot to your server, so to do so type the following command.

adduser sinusbot

You will then be prompted to set a password for the account, do that and then simply press enter when it asks you for the name etc.

Now you will need to install the bot to the server.

mkdir -p /opt/ts3soundboard
cd /opt/ts3soundboard
wget https://www.sinusbot.com/dl/sinusbot-beta.tar.bz2

If that command results in SSL-Errors, you can alternatively try

curl -O https://www.sinusbot.com/dl/sinusbot-beta.tar.bz2

Next, extract the bot:

tar -xjf sinusbot-beta.tar.bz2

Copy the configuration (if you haven't started the bot before)

cp config.ini.dist config.ini

If you're running the bot under another user than root (and that's highly recommended), you need to change the ownership of the bot directory to that user now.

chown -R sinusbot:sinusbot /opt/ts3soundboard

(If you're using another user/group than "sinusbot", replace sinusbot:sinusbot with yourusername:yourusergroup)

Now you need to download the TeamSpeak 3 Client and install it.

wget http://dl.4players.de/ts/releases/3.0.18.2/TeamSpeak3-Client-linux_amd64-3.0.18.2.run
chmod 0755 TeamSpeak3-Client-linux_amd64-3.0.18.2.run
./TeamSpeak3-Client-linux_amd64-3.0.18.2.run

You will need to accept the terms. You do this by pressing enter to scroll through the text or press q to simply go to the end.

Now you need to configure the ini-File of the bot to match your directories.

nano config.ini

Make sure that the TS3Path is correct (if you followed this tutorial step by step, it should already match):

TS3Path = "/opt/ts3soundboard/TeamSpeak3-Client-linux_amd64/ts3client_linux_amd64"

Close the editor (Ctrl+O, Enter, Ctrl+X).

And finally copy the plugin to the plugins-directory of the TeamSpeak-Installation

cp plugin/libsoundbot_plugin.so /opt/ts3soundboard/TeamSpeak3-Client-linux_amd64/plugins

Just to make sure that the bot is executable, enter

chmod 755 sinusbot

Update

Make sure you're using the latest version:

cd /opt/ts3soundboard
wget https://www.sinusbot.com/dl/sinusbot-beta.tar.bz2
tar -xjvf sinusbot-beta.tar.bz2
cp plugin/libsoundbot_plugin.so /opt/ts3soundboard/TeamSpeak3-Client-linux_amd64/plugins

Usage

Notes

You will need to switch to the user that you have installed the bot on, if you followed the tutorial, this will be 'sinusbot". To do this use the following command.

su sinusbot

If you want to keep the bot running when you exit out of the terminal, see below for instruction on how to use sinusbot with screen.

Starting the bot

./sinusbot

Stopping the bot

Ctrl + C

The bot will launch the TS3Client once and shut it down immediately. This is normal behavior, as this creates an initial configuration for the client. If you want to actually launch the bot, you'll have to do that from within the frontend.

If you absolutely need the bot to start as root, use the following command instead. This is however not recommended!

./sinusbot -RunningAsRootIsEvilAndIKnowThat

Now login at http://yourip:8087/ with default user admin and password foobar.

Troubleshooting

If the bot doesn't connect and you only see a "INFO TSClient quit" every time you try to start the bot via the webinterface, you might need to set your locale info manually when starting up the bot. Try to start it with

LC_ALL="en_US.UTF-8" ./sinusbot

Exchange en_US.UTF-8 to whatever locale you're using.

If that still doesn't help, try to manually start a TS client instance and see if that reports something useful:

xinit /opt/ts3soundboard/TeamSpeak3-Client-linux_amd64/ts3client_linux_amd64 -- /usr/bin/Xvfb :1 -screen 0 800x600x16 -ac

Starting in a screen

If you want the bot to not shutdown when you close the connection to your server, you might want to use the tool screen or an init-script for your distribution (those have not yet been written).

You are going to have to install screen to begin with

apt-get install screen

When you have done that, simply start a screen with the following command

screen -S sinusbot

When you have entered the screen, switch to the sinusbot directory

cd /opt/ts3soundboard

Then start the bot

./start.sh

To exit out of the screen when you have started the bot, press these keys

Ctrl A + D

And to enter the screen again use this command

screen -r sinusbot

If you have logged onto your server with root and have switched to the user sinusbot, this command will not work. There are 2 simple ways you can overcome this. One, is you type this command as root then when the screen has opened switch to the user. Two, you simply connect to the server with the username, this option is less convent because if your bot user account has no permission for the server, you will need to log out and back in with root again. The choice is up to you.

Optional

You can create a Shell File with Nano or GEdit(Desktop).

You need screen for the Shell.

Now, create the Shell File in the Folder from Musicbot and write in the File:

./sinusbot

Save the File and give the File the Permissions with:

chmod 777 start.sh

Run the file.

./start.sh

The Bot is running.