Installation Guide For Linux - UnforeseenOcean/WildBeast GitHub Wiki
Welcome to the installation guide for WildBeast on Linux! In this guide, we'll walk you through the installation and deployment process for the WildBeast bot.
##Prerequisites
- A Linux server
- Type: VPS is enough to run WB, dedicated is a bit overshooting unless you have something else running there as well.
- OS: Ubuntu, latest version if possible.
- RAM: 512 MB upwards, if you plan on having it on just a few servers. Scale up if necessary.
- Processor: Single core @ 3,30 GHz will work just fine, as above.
- SSH access to the server.
- Programs
##Pre-setup We higly recommend that you go through a basic Linux server setup before starting this, which includes adding a new user, disabling root login (If you feel so) and adding key authentication for logins. If you have no idea what we mean by this, see the Digital Ocean guide for initial server setup. When this is complete, you can proceed to the next step.
##Installation
General note: During installation, some administrative tasks will be executed. For these to work (Especially installations), you need to run these commands as sudo! They might error if you don't.
Luckily, the process of executing as sudo isn't that complicated. Just put sudo ahead of every install command or other administrative equivalent.
You will be asked for a password when doing the command, that's all that really is added.
Keep this in mind when setting up, so you don't waste our time with errors that stem from lacking permissions!
This does of course not apply to you who choose to not do the basic initial server setup and instead run as root.
####Installing Node
First off, we'll install Node.JS, the library WildBeast uses. The current 6.x.x version works fine.
wget -qO- https://deb.nodesource.com/setup_6.x | sudo bash -
After that is completed, you can check your Node version by executing the following:
node --version
The output should then be this or close to that.
v5.10.1
####Retrieving WildBeast Now we'll retrieve the WildBeast files via Git. Install it with the following command:
apt-get install git
When the install completes, clone the WildBeast Git repository.
git clone https://github.com/TheSharks/WildBeast.git
If you mess something up during the installation process, you can delete the directory with rm -d -f -r /WildBeast and reclone the Git repo.
####Installing additional dependencies
Now it's time to install the rest of the dependencies for WildBeast. Change the working directory to WildBeast with the command cd WildBeast before proceeding.
Next, we will install FFMPEG. This is a crucial step if you want to use music playback, so pay attention! Run these commands subsequently:
sudo apt-get install build-essential -y
sudo apt-get install ffmpeg -y
Without changing workdir, we'll now install the Node modules required for usage in WildBeast. Execute the following:
npm install
This will likely take a while as it has a lot to retrieve. If you get warns (Yellow text) you can ignore them as long as the output is somewhere in the ballpark of the one below.
[email protected]
+-- [email protected] (git://github.com/qeled/discordie.git#6fce7e8e552bd64663541ffaf374e07cc5b8fd2d)
| `-- [email protected]
| `-- [email protected]
| `-- [email protected]
`-- [email protected]
(Details may be different)
Note: If you get get errors (Red text), there may be different reasons for that. You can try hotfixing with this command:
sudo add-apt-repository ppa:mc3man/trusty-media && sudo apt-get update && sudo apt-get install ffmpeg -y
After doing that, repeat the above. If you still get errors, feel free to come and ask us over at WildBot's Territory.
Finally, we'll install youtube-dl for the bot to be able to retrieve videos from remote sources. Use this command to accomplish that.
npm install fent/node-youtube-dl -g
If you get errors or the bot fails to run later on, rebuild YTDL by executing this command.
npm rebuild youtube-dl
##Configuration ####Setting up SFTP Next we'll make a config file for WildBeast. Unless you love your command line and editing stuff that way, this is the step where we'd advise you to bring out FileZilla. Using this program, you can transfer files from and to the server. This speeds up the editing process.
Start up FileZilla and open the server manager by hitting Ctrl+S. Click "New Site" and name it whatever you prefer. Then fill in the server's IP address. By default, SFTP (SSH File Transfer Protocol) connections go to port 22. In the dropdown menu below, select SFTP. Using normal FTP will initiate maxmimum borkdrive so don't use that. In the field below, you'll be setting the login method. Depending on the level of privacy or ease you want, you can select either Normal or Ask for password. Fill in your login details accordingly.
Unless you know what you are doing, don't touch the rest of the tabs. They are fine as they are.
Your site should be something like the example below.
####Retrieving the example config
Connect to the server in FileZilla. You should now see the so-called remote site in FileZilla. Open the WildBeast directory. In here you can find a file named config.example.json.
Right click that file and select "Download". This will download the file to your computer for editing. On the left-hand side of the screen, you can see where the file was downloaded.
Find config.example.json on your PC and open it using Notepad++ or any other code editor. Do not edit it with Windows Notepad, that will be a mess.
###The config file
When opening the config file, you should have a file that looks like this. (The CSE is deprecated and likely to be removed, but the others are still needed)
We'll now walk you through the different sections in the config and what they do.
####Bot section
| Property | Explanation | Notes |
|---|---|---|
| isbot | If an OAuth bot account should be used. | Recommended to be true due to Discord bot rules. |
| token | OAuth token for the bot. | Refer to the "Making the config" section. |
| Email for normal user account that the bot will use. | DO NOT input your personal login details here. | |
| password | Password for the account mentioned above. | As above. |
| oauth | The OAuth URL for the bot. | Refer to the "Making the config" section. |
| ####Settings section | ||
| Property | Explanation | Notes |
| -------- | ----------- | ----- |
| prefix | The command prefix the bot will use. | Can be a special character like / etc. |
| ####Permissions section | ||
| Property | Explanation | Notes |
| -------- | ----------- | ----- |
| master | The highest possible access level of 9. Full permissions. | Only give this to yourself and maybe others you really trust. |
| level1, level2, level3 | Settable access levels that give users access to certain commands. | Default access levels can be found in the command files. |
| Notice: By default, when WildBeast joins a server it will set the owner's access level to 5. This is to give them control over normal users. | ||
| ####API keys section | ||
| Property | Explanation | Notes |
| -------- | ----------- | ----- |
| imgflip | Your imgflip login details. | Used in certain meme commands. |
| For retrieving data from YouTube. | Refer to the "Making the config" section. | |
| mashape | For retrieving the Fortune Cow. | Refer to the "Making the config" section. |
| cse | Deprecated and not required, don't bother with this. | This will be removed at some point. |
| ###Making the config |
- OAuth app
- We'll start off by creating an OAuth application in Discord's developer interface so that the bot can login.
- Go to https://discord.com/developers/applications/me and create a new application.
- Name it whatever you prefer and give it a fancy picture. Fill in a description if you want to, then click "Create application".
- Now you'll have a more full-fledged app page. Click "Add Bot User" and confirm to make it a bot.
- Here you'll get a Client ID and a token. Reveal the token (Not the secret) and replace "Bot token" with that in the config.
- If you completed the step above and want to comply with Discord rules, skip the email/password section and leave them be.
- Next we'll make an OAuth URL for the bot so it can be added to the server.
- Just put this placeholder URL somewhere for now, don't open it as it will not work.
https://discord.com/oauth2/authorize?&client_id=CLIENTID&scope=bot&permissions=536345655 - Go back to the app page, and copy the Client ID.
- Replace the
CLIENTIDplaceholder in the URL above with the ID you just copied. You can open the URL to test that you did it right. - If the URL works as intended, copy it and replace "URL" in the config with the one you copied.
- You can also open the URL and add your bot to the server at this point, so you don't forget it. It will have the permissions it wants precalculated due to the number after the
permissionsproperty. Just select your server from the dropdown list and add it. The bot won't do anything at this stage because we're not finished yet. - If you can't select your server, it might be that you lack Manage Server permissions.
- Just put this placeholder URL somewhere for now, don't open it as it will not work.
- We'll start off by creating an OAuth application in Discord's developer interface so that the bot can login.
- Prefix
- Setting the command prefix isn't really rocket science. This can be any special character, for instance
/,?and so forth. - You can also use multiple characters as a prefix, for instance
!!and++. - Note that there is always a so-called global prefix: A mention. Saying
@BotNamein chat will function as a prefix as well. This doesn't need to be specified in the config as it's always active.
- Setting the command prefix isn't really rocket science. This can be any special character, for instance
- Permissions
- This is a section that has a very interesting gimmick to it.
- WildBeast has a command named
setlevelwhich will set the level of a user. However, that is written into a server-specific config. Which means that if you set the level of someone to 2 in Server1, they will not be level 2 in Server2, for example. - The permissions fields here are so-called global permissions, and will apply unless a server-specific level is set.
- Use this to add technicians and others who need permissions regardless of where the bot is.
- WildBeast has a command named
- You can specify users here by adding their IDs into the fields. Only the master field is mandatory.
- You can get the ID of a user by either "backlash mentioning" them, which means to say typing
\@Userin chat or by enabling Developer Mode (Personal Settings -> Appearance -> Enable Developer Mode) and right-clicking on someone, subsequently selecting Copy ID from the list and pasting it in between the quotes. - Remember to follow the example syntax in the master field when adding multiple users!
- You can get the ID of a user by either "backlash mentioning" them, which means to say typing
- This is a section that has a very interesting gimmick to it.
- API keys
- General notice: Anything within these fields is sensitive and could do much harm if revealed to the public.
- Therefore it is imperative that you keep this to yourself.
- WildBeast maintainers will NEVER ask for your login details or API keys. Only show the config to trusted WildBeast maintainers with the
Staffrole in WildBot's Territory.
- imgflip
- The procedure for getting this isn't tricky. Just go to https://imgflip.com, create an account and input your username and password into the fields.
- Google
- This API is used to retrieve data from YouTube, related to music playback.
- Go to https://console.developers.google.com and create a new project. Name it whatever you fancy. Nothing else needs to be changed unless you want to change the project ID or the app engine location.
- Wait a while as the project is being created.
- When the creation process is completed, you'll get taken to the screen below. Click "YouTube Data API" as highlighted below.
- When the API page opens, click the "Enable" button in the top bar. Then you will get a warning saying that you need to create creditentials. That's exactly what we will do.
- Click the "Go to creditentials" button. In the next dropdowns, make them look like following.
- Hit "What creditentials do I need?" and the page will generate a Google API key for you. Copy the API key and replace the "A google key" placeholder with that key in the config.
- This API is used to retrieve data from YouTube, related to music playback.
- Mashape
- This API is used with the
fortunecowcommand.
- Go to the Mashape site and login as you prefer, GitHub login is supported.
- Navigate to the Mashape APIs dashboard and add a new application. Name it as you wish.
- Once the app is created, click "Add API to your application" and search for
fortunecow. - Open the fortunecow API page and in one of the dropdowns on the left, change it to the application you just created and hit "Test Endpoint" on any you wish to test. Only one is required.
- This will add the API to your application. Navigate back to the dashboard and click on the app itself. It should now have an appearance that resembles to this.
- Hit "Get the keys" in the top-right corner. In the drop-down menu that is opened, select "Production". This will be your Mashape API key for that application. Copy that and replace the "A mashape key" placeholder in the config with that key.
- This API is used with the
- CSE
- This option isn't required anymore and can safely be left alone. If you really want to get one you can, but it won't do anything and you'll have to do that yourself.
- Twitch
- This API is used with the
twitchcommand. This will be the client ID the bot passes to Twitch when retrieving stream status.- Go to the Twitch Connections page, scroll down to the bottom and click "Register new application".
- Fill in the fields. Name should be your app name, and set the Redirect URI to
http://localhostunless you want something to function differently. Set the app type to "Chat Bot" as that's what you're basically doing here.
- Click "Register". This will take you to the application management page. Down towards the bottom, there will be a section saying "Client ID".
- Copy that character sequence and replace the "A twitch Client-ID" placeholder in the config with that ID.
- This API is used with the
- General notice: Anything within these fields is sensitive and could do much harm if revealed to the public.
That's all, your config should now be ready to rock! Save it as config.json (NOT config.example.json as the bot will error if you do. TLDR: Don't hit Ctrl+S, hit Ctrl+Alt+S) and upload it to the server via FileZilla.
##Running the bot Congratulations, your WildBeast instance should be ready to launch!
To test if you've done everything correctly, you can do a "test run" with the bot. This means not making it permanently available, just testing if any errors are spat out when running.
Run the following command within the bot's folder:
node DougBot.js --noinitial
The noinitial parameter will skip the configuration process via the console (As you already did that manually in the previous step) and skip straight to running.
If the bot runs without any errors, you have had success so far!
You can test simple functionality by running the ping command (With your desired prefix) in a text channel that the bot can see. If it answers "Pong!", then congratulations, you have successfully set up WildBeast!
##Background running WildBeast
With the current system that we described above, the bot will run but doesn't keep going when you log off but shuts down. How can we combat this? The answer is: PM2!
PM2, short of Process Manager 2, is a Node app intended to run and manage multiple apps running on one account in a Linux environment, which enables more than one process running at a time.
Our official instance, namely WildBot uses PM2, so this resource is a good one to use! ####Installing PM2 and starting the bot Before doing this, hit Ctrl+C (Close command) to shut down WildBeast if it's still running.
You can install PM2 by using the following command in the server root folder:
npm install pm2 -g
When PM2 is installed, navigate to the WildBeast install directory (cd Wildbeast if you are in the server root). Then execute the following command:
pm2 start DougBot.js
It should then start the process and return a small process table with DougBot.js listed. The bot should now be online in your server as well.
You can find out more about PM2 by typing pm2 into the console.
###And that's it! You are now ready to start using your very own WildBeast instance! Keep in mind, if you have further questions or need help, we're around over at our official server! Link below.
On the behalf of the WildBeast team, we hope you enjoy your bot!