Skip to content

appliance.rst

Latest commit

 

History

History
204 lines (121 loc) · 6.82 KB

appliance.rst

File metadata and controls

204 lines (121 loc) · 6.82 KB

VirtualBox Appliance for Mumble-Ruby-Pluginbot

This page shows you how to download the VirtualBox Appliance for the :ref:`Mumble-Ruby-Pluginbot <start-label>` and import it into your VirtualBox.

You only need to configure the ip of your Mumble-Server, the username. Then you can register your bot on your server; thats it :)

The result is a fully functional instance of the :ref:`Mumble-Ruby-Pluginbot <start-label>`.

Choose which appliance you need

There are two flavors of the appliance:

  • Mumble-Ruby-Pluginbot Terminal – shell only
  • Mumble-Ruby-Pluginbot GUI – with a lightweight Desktop Environment and shortcuts to control the bot and edit its configuration

Download the appliance

Download one of the appliances from here and save it somewhere on your computer.

Import appliance into VirtualBox

Of course you must have VirtualBox installed.

Start it, open the menu and select "Import Appliance...":

images/appliance/Virtualbox_appliance_mumblerubypluginbot_import.png

Navigate to the downloaded file and select it in the dialog.

Then you get the following to see:

images/appliance/Virtualbox_appliance_mumblerubypluginbot_import_2.png

Click on "Import" and wait.

When the import finished you should have a new virtual machine called "Mumble-Ruby-Pluginbot".

Start the virtual machine

Now start the virtual machine and login.

  • The username is: botmaster
  • The password is: botmaster

General notes

Note

  • Please note that on most Mumble servers you can't use space characters in usernames; use an underscore _ instead.
  • If you set the value of mumbleserver_targetchannel to an empty string "" the bot will enter the default channel on the first connect and after that the previous channel on reconnect once it is registered.

Virtual Appliance with Shell only

Your bot is already running and by default connected to Natenoms Mumble-Server. To let it connect to your own server you must now adapt the bots configuration and then restart the bot or just restart the complete virtual machine.

Note

You can create a GUI flavor out of your Terminal flavor if you run the script /home/botmaster/src/.export/install_desktop.sh.

Change bot settings so that the bot can connect to your Mumble server

images/appliance/Virtualbox_appliance_mumblerubypluginbot_login.png

Edit the bot configuration:

nano /home/botmaster/src/bot1_conf.yml

images/appliance/Virtualbox_appliance_mumblerubypluginbot_edit_botconf.png

If you made your changes press Ctrl + o followed by Enter to save the file and then Ctrl + x to leave the editor.

Now restart the virtual machine with reboot.

Virtual Appliance with GUI

images/appliance/Virtualbox_appliance_mumblerubypluginbot_login_gui.png

After logging in you can see a window to control the MPD (music server), one to view the log of your bot and another one to edit the bots configuration "bot1_conf.yml".

images/appliance/Virtualbox_appliance_mumblerubypluginbot_gui_desktop.png

Your bot is already running and by default connected to Natenoms Mumble-Server. To let it connect to your own server you must now adapt the bots configuration and then restart the bot or just restart the complete virtual machine.

On the desktop there are three shortcuts to control your bot:

  • Edit your bots config...
  • Restart your bot
  • Watch bot logs live

There is also a shortcut named "music_of_your_bot" where the bots music is located.

Have fun...

Thats it :)

Have fun with your own :ref:`Mumble-Ruby-Pluginbot <start-label>` and contact me if you have feedback related to this documentation or contact us if you have general feedback about this project.

Now register your new bot on your Mumble server and write .help to it.

Administration of the bot

Set up keyboard

The keyboard is set to german layout (de:nodeadkeys); to change it run:

sudo dpkg-reconfigure keyboard-configuration

Then reboot the virtual machine.

Stop the bot

To stop the bot, press the red X of the virtual machine window and choose Send the shutdown signal from the dialog.

images/appliance/Virtualbox_appliance_mumblerubypluginbot_close_vm.png

Autoupdate

The appliance does an auto update of the Mumble-Ruby-Pluginbot – the main compoment of the appliance – on every start.

If you want to disable this function please remove it from /etc/rc.local.

Manual update

Log in as user botmaster with password botmaster and do the following:

/home/botmaster/src/mumble-ruby-pluginbot/scripts/updater.sh
reboot

Information about the appliance

This is just for your information, no need to do anything here.

VirtualBox configuration

  • System partition: 5 GB (dynamic size)
  • Home partition: 100 GB (dynamic size, it grows up to that size when you download songs)
  • No swap partition is available.
  • RAM: 768 MiB (Terminal version), 1GB (GUI version)
  • CPU count: 1
  • Network type: NAT
  • Both partitions are configured as "Solid State Disks" and discard is enabled in the xml configuration file so that the partition size should shrink when you delete files. Thanks @neti for this hint :) This is done once a week in Ubuntu through the fstrim command.

System settings

  • System: Ubuntu Server 16.04 LTS 64bit
  • Hostname: mumblerubypluginbot
  • Keyboard layout: de:nodeadkeys
  • SSH: Not installed at all, for security reasons :)

User credentials

  • Username: botmaster
  • Password: botmaster

The user is allowed to use sudo.

Known issues

  • If the virtual machine doesn't start on Windows 8+, try to disable Hyper V, see here.
  • If you are using Proxmox, you need to convert the Virtual appliance .ova file, see here.