Skip to main content

Prerequisites

Before you begin, ensure you have the following installed on your server or local machine:
  • Node.js (includes npm)
  • npm (Node Package Manager)
  • PM2

Installation Steps

1

Get the latest release

Download the latest release of the application from our GitHub releases page.You can also use the following command to download the latest release directly to your server:
2

Extract the downloaded file

Once the download is complete, extract the contents of the tarball:
3

Install dependencies

Install the necessary dependencies using npm:
4

Build the application

Build the application using npm:
5

Start the application with PM2

Start the application using PM2:
This command will start the application and keep it running in the background. You can check the status of your application with:
6

Set up PM2 to start on boot (optional)

To ensure that your application starts automatically when the server reboots, set up PM2 to start on boot:
Follow the instructions provided by the command to complete the setup.

Prerequisites

Before you begin, ensure you have the following installed on your server or local machine:

Installation Steps

1

Get the latest release

Download the latest release of the application from our GitHub releases page.You can also use the following command to download the latest release directly to your server:
2

Extract the downloaded file

Once the download is complete, extract the contents of the tarball:
3

Install dependencies

Install the necessary dependencies using npm:
4

Build the application

Build the application using npm:
5

Start the application with Screen

Start a new Screen session:
Then, start the application:
To detach from the Screen session and keep it running in the background, press Ctrl + A, then D. You can reattach to the session later with:
To stop the application, reattach to the Screen session and press Ctrl + C.
Last modified on June 18, 2026