Weblutions Documentation
Weblutions Main Site Contact Us Our Discord
Some pages are still pending proper formatting, if required refer to the legacy documentation website.
Product Documentation IconProduct Documentation

Weblutions Documentation / Product Documentation / FaxTrack Installation

Updated

FaxTrack Installation

By Josh M. 1 mins 5

The installation of FaxTrack is fairly simple and the application itself only has a few requirements.

Requirements

  • VPS or dedicated server running Linux (Our guides use and recommend Ubuntu)

  • A domain name (like www.example.com)


1. Server Setup

To allow FaxTrack to run the required software needs to be present on the server. This software includes; Nginx (web-server), MySQL (database) and, Node.Js with NPM.

If this software is not installed, our LEMN stack setup can be followed for more the installation of any of those components.

2. File Upload

By downloading an uploading the files to a server the database can be setup in step three and application started later on. The files are obviously required. Download the latest version of FaxTrack from the Weblutions website.

  1. Download and extract the contents of the RAR file to your computer.

  2. Upload the FaxTrack folder to the server, for example /home/faxtrack
    This should mean that the index is located at /home/faxtrack/index.js

3. Install the MySQL Database

Log into your MySQL database server with your required credentials and run the below command to create and setup the table structure.

In most installs accessing the MySQL server can be done by running the mysql -u root -p command.

source /home/faxtrack/installme.sql

If you have installed FaxTrack to another directory be sure to update the path in the above command.

4. Configuration & Package Installation

Before installing required packages to run FaxTrack configure the config.json to your needs. After this install the Node modules per the below steps.

  1. Edit the config.json to the desired configuration and save

  2. Install the required modules with the below commands from within the directory.

Change directories into FaxTracks installation

cd /home/faxtrack

Install the Node modules with the npm command

npm install

This will install the required content for FaxTrack.

If any dependency warning messages display they can likely be ignored as a package may be requesting an outdated package.

5. Starting

To start FaxTrack we recommend a screen session is used to ensure the application continues to operate once the terminal is closed. To start FaxTrack use the node command.

node .

FaxTrack should now be installed without any issues. If it's the first time installing FaxTrack the setup page will be accessed by navigating to the /setup pathway.