Skip to main content

Hosting on MacOS


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.

Installation

1. Install Depdenencies

To install certain dependencies (like wget or the latest version of curl) you will need brew installed on your machine.

  1. Install brew
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  1. Install necessary packages
brew install wget nano curl jq awk 

2. Download BrayanBot

The universal bash script below can be used the download the latest version of BrayanBot from Github Releases. It requires wget, curl, jq , and gawk to be installed.

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

wget "$URL"

3. Unzip BrayanBot

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

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

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

BrayanBot needs config.yml to be in the BrayanBot 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 BrayanBot

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

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

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 BrayanBot persist between reboots, if you configure it that way.

Using PM2 Process Manager

# Install PM2 through NPM
npm install -g pm2
# Start BrayanBot with PM2
pm2 start index.js --name brayanbot
  • pm2 stop brayanbot # Stops the pm2 process
  • pm2 restart brayanbot # Restart the process
  • pm2 logs brayanbot # View recent logs as well as a live console
  • pm2 logs brayanbot --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.