Installing dependencies

Before using modmail you have to install some prerequisites.

On your computer

Putty

Windows

Install PuTTY on Windows directly from here.

Linux

It is not recommended to use PuTTY on Linux.

Enable the universe repository using:

sudo add-apt-repository universe

Install PuTTY by using:

sudo apt install -y putty

You can open PuTTY by running putty on the terminal or you can manually search for the application.

Mac

It is not recommended to use PuTTY on MacOS.

Install XCode developer tools from the app store here and run these two commands.

xcodebuild -license

xcode-select --install

Install XQuartz from here.

Install PuTTY by running this command

sudo port install putty

Run putty by using putty

Termius

Windows and Mac

Install Termius directly from here for Windows or here for Mac.

Linux

Install Termius by running the command below otherwise you can install the .deb package from here if you are on a debian-based distro (Ubuntu, Debian, Linux Mint, etc).

sudo snap install termius-app

If you don't have Snap installed, you can find instructions on how to download it here.

On your VPS

If at any time during installing dependencies the "(package name) has no installation candidate/(package name) is not available" error appears, your apt version is outdated as explained below. Run "sudo apt update && sudo apt upgrade" to fix this issue.

Upgrading the system

It is necessary to update the system before proceeding.

Start by updating the repositories:

sudo apt update

Then upgrade all packages:

sudo apt upgrade

If "Pending kernel upgrade" or "Daemons using outdated libraries" appears, hit Enter.

Once apt has finished upgrading, reboot the VPS:

sudo reboot

Wait ~1 minute for the reboot to finish then reconnect to your VPS.

Sometimes apt doesn't get upgraded. To avoid this, upgrade the system once more.

sudo apt update

Then:

sudo apt upgrade

Pip and pipenv

Install pip by running:

sudo apt install python3-pip

Install pipenv by running:

sudo pip install pipenv

PM2

If you're not planning on using PM2, skip this section. PM2 is required for keeping your bot alive 24/7.

Start by installing node.js and npm:

sudo apt install nodejs npm

npm depends on a considerable amount of packages. Expect this to take some time.

Install pm2 by running:

sudo npm i -g pm2

libcairosvg

Install libcairosvg by running:

sudo apt install libpangocairo-1.0-0