Hex Status

Hex Status Setup Guide

Welcome to the Hex Status setup guide! Follow the steps below to configure your system and get started with Hex Status.

---

Prerequisites

Before starting, ensure you have the following installed on your system:

1. Node.js (v14 or higher)

2. npm (Node Package Manager)

3. A valid license key

---

Step 1: Install Core Dependencies

Hex Status requires specific core dependencies to function. During the setup process, these will be installed automatically if they are missing.

npm install colors chalk figlet inquirer js-yaml

---

Step 2: Run the Setup Wizard

The setup wizard will guide you through configuring your Hex Status instance. Follow the prompts to:

1. Enter your license key

2. Configure site details (name, description, footer)

3. Set system options (port number, refresh interval)

4. Add essential URLs (GitHub URL, thumbnail URL)

5. Customize the theme (colors for primary, secondary, accent, and background)

6. Provide critical service details (MongoDB URI, Discord bot token)

To start the wizard, run:

node setup.js

---

Configuration Options

License

You will be prompted to input your license key:

• License Key: Enter the key provided during purchase or registration.

Site Configuration

Set the basic details for your site:

• Site Name: A descriptive name for your Hex Status instance (default: Hex Status)

• Site Description: A short description of your site (default: Real-time Service Status Monitor)

• Footer Text: Text displayed in the footer (default: Hex Status)

System Configuration

Define key system-level settings:

• Port Number: The port number to run the server on (default: 3000)

• Refresh Interval: How frequently the site updates, in milliseconds (default: 1000)

URLs Configuration

Provide the necessary URLs:

• GitHub URL: The repository link for Hex Status or a related project (default: https://HexRift.net/github)

• Thumbnail URL: A logo or thumbnail image (default: https://HexRift.net/assets/logo.png)

Theme Configuration

Customize the look of your Hex Status site:

• Primary Color: Hex code for the primary theme color (default: #ff0000)

• Secondary Color: Hex code for the secondary theme color (default: #000000)

• Accent Color: Hex code for the accent color (default: #ff3333)

• Background Color: Hex code for the background color (default: #1a1a1a)

Critical Services Configuration

Provide credentials for key services:

• MongoDB URI: Your MongoDB connection string

• Discord Bot Token: The token for your Discord bot

---

Saving Your Configuration

Once you have completed the wizard, the configuration will be saved to a config.yml file in your project directory. This file contains all your settings in YAML format.

If the setup wizard detects an existing config.yml, it will not overwrite it unless you delete the file manually.

---

Authentication Check

The setup process will verify your license key. If authentication fails:

• Ensure your license key is valid

• Re-run the setup wizard after resolving any issues

---

Starting Hex Status

To start the Hex Status application, use the following command:

npm start

Your instance should now be running and accessible on the specified port (default: http://localhost:3000).

---

Troubleshooting

• Dependency Errors: Ensure all dependencies are installed by running npm install.

• Authentication Issues: Verify your license key and network connectivity.

• Configuration Issues: Delete config.yml and re-run the setup wizard.

---

Thank you for using Hex Status! If you encounter any issues, feel free to reach out to support.