FaxDesk Installation

The installation of FaxDesk is like many of our applications in which it uses JavaScript to operate.

File & MySQL Setup

Download FaxDesk and extract it to the Linux server. For the purposes of this installation we'll be using the /home/faxdesk directory.

Once files are uploaded the MySQL database can be installed. Login to your MySQL server using the mysql command. If you don't have MySQL installed, install it on to the server with the below two commands.

sudo apt install mysql-server
sudo mysql_secure_installation

Install NPM Packages

Switch to the directory and install the Node packages with the below command.

Use the change directory command into the install location. Eg; cd /home/faxdesk
Use npm install to install required dependencies

Configuration & Start up

Edit the configuration files on the server to your desired settings. All configuration files will be JSON files. FaxDesk comes with a generic configuration file along with a form configuration file.

Once configured and saved start the application from the command line with the below command.

node .

Configuration File Structure (config.json)

Configuration Variable	Description	Default Value
siteName	The website title	`"FaxDesk"`
processPort	The port the web-application will operate under	`3000`
siteDescription	A description of the website	`"Demo FaxDesk Installation"`
siteThemeColor	A hex color for accents	`"#7289da"`
siteLogo	A relative path to a logo file	`"/assets/logo.png"`
domain	The protocol and domain of the website	`"http://localhost:3000"`
tokens.discordBotToken	A Discord bot token. Used for fetching users and logs
tokens.oAuth2ClientId	A Discord application ID. Used for logins
tokens.oAuth2ClientToken	A Discord OAuth2 token. Used for logins
tokens.faxesLicenseKey	The Weblutions license key for the application to run
SQLInformation.host	The IP or host for the database	`"localhost"`
SQLInformation.username	The Username for the database
SQLInformation.password	The password for the database
SQLInformation.database	The database name to connect to	`"faxdesk"`
homePage.titleOne	The home page upper title	`"Need help? We got you!"`
homePage.descriptionOne	The home page upper description
homePage.titleTwo	The title displayed above the buttons	`"Other ways to find us."`
homePage.bottomButtons	An array of buttons	`[]`
homePage.bottomButtons.title	Button name
homePage.bottomButtons.link	Button URL
homePage.bottomButtons.image	Button image URL
autoReplies	An array of auto reply objects
autoReplies.title	Title of an auto reply
autoReplies.content	Content of the auto reply
discordConfig.useDiscordChannelLogs	Whether to enable Discord channel logs.	`false`
discordConfig.loggingChannelId	The Discord channel Id used to log everything.	`"CHANNEL_ID"`