Setup

Search…

English

What is WildBeast?

Guides

Fundamentals

Extras

Creating a bot account

Adding your bot to your server

Setup

Instructions to run WildBeast on Linux

The basics
Good to know: For the purpose of this guide, we'll use Ubuntu 20.04. 
Any modern Linux distribution will work, however the commands described here only work on Debian based distributions.
For safety reasons, please don't run WildBeast with the root account.
If you don't know how to create a new user on Linux, please see DigitalOcean's guide on making new sudo-enabled users​
We need a few prerequisites:
A computer running any supported version of Ubuntu​
You need sudo or doas privileges, or access to the root account
If you want to run WildBeast 24/7, you should get a VPS​
​Git​
A text editor. We're going to use nano, but you can use anything you'd like.
Installation
Installing Node.js
1.Run the following code in your terminal:
1
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
Copied!
(Not a fan of curl <url> | bash -? You can do this manually too.)
2.Install Node.js with the following command:
1
sudo apt-get install -y nodejs
Copied!
Installing Postgres
Postgres is available to install by default on Ubuntu, just run the following code in your terminal:
1
sudo apt install postgresql postgresql-contrib
Copied!
We need to do some extra steps to prepare Postgres for use:
1.Create a new user for WildBeast to use:
1
sudo -u postgres createuser --interactive
Copied!
The new user does not need to be a superuser, and can be called whatever you want.
2.Finally, create a new database:
1
sudo -u postgres createdb wildbeast
Copied!
(We used wildbeast here as the database user, change it if you used something else in the previous step)
Setting up
Getting the code
Clone the code and install the required modules:
1
git clone https://github.com/TheSharks/WildBeast.git
2
cd ./WildBeast
3
npm install
Copied!
Setting the options
Open the example configuration file in nano and enter your details:
1
nano .env.example
Copied!
When you're done, save the file as .env
Starting the database
Before we can start, we need to initialize the database. Run the following code:
1
npm run-script migrations:up
Copied!
Testing it out!
Now for the fun part, testing to see if it worked!
Start WildBeast for the first time with the following command:
1
npm start
Copied!
You should see something similar to the following if everything went well
19:11:41 [info] Gateway: Client ready 
19:11:41 [info] Gateway - shard 0: Gateway ready
Test if your bot works by running the /ping command
​
​
Slash commands can take a while to appear.
Don't have your bot in your server yet? Check this guide.​
Next steps
​Running as a service for autostart​

Guides - Previous

Linux guides

Running as a service

Last modified 6mo ago

Export as PDF

Copy link

Contents

Starting the database

Testing it out!

Next steps