Skip to main content
Version: 2.x

Hosting on Linux

Note

This page assumes that you have already completed the Pre-Installation Steps If you haven not yet completed the pre-installation steps, please go back and complete them because the bot cannot function without them.

Warning

The following guide only covers instructions for CLI installation. For GUI installation, please read the relevant Blog Post

Installation​

We provide for three Linux distributions: Debian, ArchLinux and Fedora. If you are using a different distribution that is not a spin of those main three; feel free to request instructions or/and support for those on our Discord Server

The instructions found below make use of several packages to make the CLI installation as convenient as possible. You may substitute packages that offer similar functionality, or alternatively use a GUI installation method like SFTP.

1. Install Depdenencies​

sudo apt install zip unzip wget jq curl gawk

Ubuntu 20.04 does not include the latest version of nodejs. You can install it using one of the following commands:

# Using Ubuntu
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs
# Using Debian, as root
curl -fsSL https://deb.nodesource.com/setup_16.x | bash -
apt-get install -y nodejs

2. Download Proxima​

The universal bash script below can be used the download the latest version of Proxima from Github Releases. It requires wget, curl, jq , and gawk to be installed. Those packages are usually installed by default on most Linux distributions. 

#!/bin/bash
LATEST=$(curl https://api.github.com/repos/NeuShore/Proxima/releases/latest -s | jq .name -r | awk '{ print $2 }')
URL="https://github.com/NeuShore/Proxima/releases/download/$LATEST/Proxima-$LATEST.zip"

wget "$URL"

3. Unzip Proxima​

After downloading the zip file, we need to unzip it and move into the Proxima directory.

unzip Proxima-*.zip -d ./Proxima && cd Proxima

4. Copy the example config to the main config.yml​

Proxima needs config.yml to be in the Proxima directory. We will copy example.config.yml to the main config.yml file and insert our Bot's token.

cp example.config.yml config.yml && nano config.yml

Enter your bot token in the config.yml file, save, and exit nano with Ctrl+X

5. Install node modules & Start Proxima​

npm install && npm run start --skip-dependencies

And that's it, you have successfully installed and started Proxima!

Power Controls​

If you would like to keep the bot running after you log out of your terminal/machine; you may use PM2. It will also allow you to have Proxima persist between reboots, if you configure it that way.

Using PM2 Process Manager​

# Install PM2 through NPM
sudo npm install -g pm2
# Start Proxima with PM2
pm2 start index.js --name Proxima
  • pm2 stop Proxima # Stops the pm2 process
  • pm2 restart Proxima # Restart the process
  • pm2 logs Proxima # View recent logs as well as a live console
  • pm2 logs Proxima --lines 1000 | nc termbin.com 9999 # Export the bot's past logs and paste them to termbin.

Getting Help​

💡 Ran into a problem?

Join our support server and open a ticket.