License System Installation

The License System runs as a separate Node.js application and typically operates behind Nginx as a reverse proxy, similar to FaxStore itself. This guide assumes FaxStore is already installed and running, and that all standard system requirements have already been met.

Table of Contents

1. Upload the License System Files

Begin by extracting the License System files to a new directory on the server FaxStore operates on. A common location is:

/home/licensesystem

2. Configure Nginx

Next, configure Nginx to route requests from a domain or subdomain to the License System application. Navigate to the Nginx sites configuration directory:

/etc/nginx/sites-available

Open the configuration file used for FaxStore (this is commonly named default or is the FaxStore domain name, but may vary depending on your setup).

Replace DOMAIN_HERE and PORT_HERE in the below template and add it to the bottom of the file

server {
  server_name DOMAIN_HERE; # Change this to your domain

  location / {
    proxy_pass http://localhost:PORT_HERE; # Change if the License System port is different
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'upgrade';
    proxy_set_header Host $host;
    proxy_cache_bypass $http_upgrade;
    proxy_set_header X-Real-IP $remote_addr;
  }
}

Be sure to use a unique port and not the port FaxStore uses.

3. Restart Nginx

After saving the configuration changes, restart Nginx to apply them:

service nginx restart

If Nginx fails to restart or presents errors try the Nginx test command nginx -t to see whether there's a syntax issue.

4. Generate SSL Certificate

The License System should be secured with SSL using Certbot which is the same method typically used for FaxStore. Run the CertBot command to create this.

sudo certbot --nginx -d license.example.com

Replace the domain with the domain or subdomain configured for the FaxStore License System.

5. Database Setup

If using License System version 1.4.2 or newer, the required database tables will automatically be created during installation.
For versions older than 1.4.2, the database must manually be imported into the MySQL server.

6. Configure The License System

Open the License System configuration file and update it according to the desired environment settings, be sure to use the same domain and port from step two.

For authentication to function correctly, you may need to add additional redirect URIs to the platforms used for login authentication. These should match the domain used for the License System and be configured similarly to how they were set for FaxStore.

Refer to the FaxStore authentication setup for more information.

8. Start The License System

By using screen sessions the License System can be started for the first time. Do this by running the below commands in order.

Start a screen session

screen -S license

Navigate to the installation directory

cd /home/licensesystem

Install Node dependencies. This only has to be done once for the first ever boot of the License System, to start the License System in the future this step can be bypassed.

npm install

Once Node modules have been installed, start the application with the node command

node .

The FaxStore License System is now installed and operational. If the service does not start or the site is inaccessible, check the terminal output inside the screen session for any errors and verify your Nginx configuration and port settings.