6. Starting FaxStore

Congratulations - this is the final step in the FaxStore installation process. After completing the previous configuration steps, the store is ready to be launched.

This guide explains how to prepare the environment, install dependencies, and start the FaxStore application.

If using Discord, GitHub, or Google, it's recommended to place your service user ID into the configuration file to gain site master admin access.

Create a FaxStore License Key

Before starting FaxStore, a valid license key must be generated.

Visit the FaxStore licensing portal at license.weblutions.com
Create a new license key
Copy the generated license key

Once obtained, paste the license key into the FaxStore configuration file in the appropriate license field. Save the file before continuing.

Create a Screen Session

Running FaxStore inside a screen session is recommended so the application continues running even after closing the terminal.

Create a new screen session using:

screen -S faxstore

This will create and attach to a new session named faxstore.

Navigate to The FaxStore Directory

Once inside the screen session, navigate to the FaxStore installation directory:

cd /home/faxstore

This directory contains the FaxStore application files.

Install Node Modules

If it's the first time starting FaxStore, all required Node.js packages must be installed.

Run the following command:

npm install

This installs the dependencies required for FaxStore to operate.

Start FaxStore

Once dependencies have been installed, start the application using:

node .

FaxStore will now start and begin running on the configured port.

Optional: Increasing Memory Allocation

While FaxStore is a optimised application, if FaxStore crashes due to out-of-memory errors, Node.js can be started with additional memory allocation.

Use one of the following commands depending on the available system memory:

node . --max-old-space-size=1024  # 1 GB
node . --max-old-space-size=2048  # 2 GB
node . --max-old-space-size=3072  # 3 GB
node . --max-old-space-size=4096  # 4 GB
node . --max-old-space-size=5120  # 5 GB
node . --max-old-space-size=6144  # 6 GB
node . --max-old-space-size=7168  # 7 GB
node . --max-old-space-size=8192  # 8 GB

Choose a value that fits within the available RAM of the system.

FaxStore is Now Running

FaxStore should now be fully operational.

For managing the application, such as reconnecting to the session or stopping the server, refer to the screen session guide for additional information. 🚀