Installation of shellnut

From Natenoms discontinued Wiki
Jump to: navigation, search

Shellnut is a brigde that connects a Mumble server with one or more IRC channels.

1 Install dependencies

Install the following dependencies as root or via sudo:

apt-get install curl libyaml-dev git libopus-dev \
build-essential zlib1g zlib1g-dev libssl-dev mpd mpc tmux \
automake autoconf libtool libogg-dev psmisc util-linux

2 Create a user which should host the shellnut bot

As root or via sudo:

adduser shellnut

All relevant scripts will run within this user context.

Now it is the time to log in as your new user with:

su - shellnut

All the following steps are done as the user shellnut.

3 Install and set up ruby and all needed libraries

We are using RVM (Ruby Version Manager) to install a local version of Ruby instead of using a system wide installed Ruby which may be too old.

First get and add the GPG key of RVM:

gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3

We need at least Ruby 1.9.x, here we use the latest stable version:

curl -L https://get.rvm.io | bash -s stable

Now we need to tell our current shell to use rvm:

source ~/.rvm/scripts/rvm

Because of 'I don't remember' we disable autolibs :P:

rvm autolibs disable

Now we install the latest stable version of Ruby:

rvm install ruby --latest


3.1 Set up a Ruby environment and install the dependencies

Now setup the environment for Ruby:

rvm --create use @bridge
rvm use @bridge
rvm @bridge do gem install Ruby-IRC
rvm @bridge do gem install mumble-ruby

4 Install the shellnut bot

git clone https://github.com/pixeldesu/shellnut.git

5 Configure the bot

cd
cd shellnut
cp config.yml.example config.yml

Now adapt config.yml to your needs.

6 Run the bot

rvm use @bridge
cd
cd shellnut
ruby shellnut.rb

Thats it :)