FASTPANELWIKI

Extended features

Branding Customization

On this page

The Branding section in the FASTPANEL® allows to customize the visual appearance and style of the control panel. This menu is located in "Settings" → "Main" → "Branding".

Color Schemes

Navigate to the "Color schemes" tab to change the panel's primary color theme. Choose from a variety of predefined color palettes (e.g., blue, orange, red, green).

Adjust the Theme:

  • Light: Use a bright theme
  • Dark: Switch to a dark mode
  • Like on the device: Automatically adapts to the user’s device settings

Logo Customization

The "Logo" tab allows uploading a custom logo for different panel areas.

Login Screen
Separate logos can be uploaded for Light and Dark themes.
Use the Upload button to add a new logo or Reset to revert to the default.

  • Supported formats: jpeg, png, svg, webp
  • Maximum resolution: 256x100 pixels
  • Maximum file size: 5 MB

Header Logo
Displayed in the header of the control panel.

  • Supported formats: jpeg, png, svg, webp
  • Maximum resolution: 200x22 pixels
  • Maximum file size: 5 MB

Favicon Customization

The "Favicon" tab allows uploading a favicon, displayed in browser tabs and search results.
Use the Upload button to add a favicon or Reset to revert to the default.

  • Supported format: ico
  • Maximum file size: 1 MB

The "Links" tab provides fields to customize links in the side menu.

  • Knowledge base: URL for accessing the knowledge base

After modifying the links, click Save to apply changes.

Disk usage statistics

info

FASTPANEL Extended is enabled by default for everyone. No license activation is required.

FASTPANEL® includes a Disk Usage Statistics feature that lets you quickly see which files and directories consume space in your websites’ user directories.

To use this feature, open "Management" → "File Manager" and click the round icon in the top right corner

On the next screen, you will see detailed disk usage statistics, including Directories, Top large files, and Extension statistics.

  1. Click the folder icon in the top right corner to return to the file manager.
  2. Click the refresh icon (circular arrows) in the top right corner to reload the data.
  3. Click the username in the top left corner to switch between different users’ home directories; the statistics will update accordingly.

Node.js

On this page
info

FASTPANEL Extended is enabled by default for everyone. No license activation is required.

Introduction

Node.js is a server platform that runs applications written in JavaScript.

First, you need to install Node.js:

  • Go to "Settings" -> "Applications"
  • Click the "Install" button for the required Node.js version

Create a website:

  • Select a template for a Node.js website
  • Specify the domain and related parameters. At the configuration stage you can change the DB, FTP user, and Backend
  • Upload the application files into the website directory
  • To install dependencies run npm20.15.1 install in Terminal (need to install ttyd application for FASTPANEL®)
  • Restart Node.js by going to the site dashboard and then opening the "Services" section.

Express framework

Using the Express framework as an example, let’s create a simple web server:

  • Connect to the server via SSH as the user who owns the site (you can use the ttyd application for FASTPANEL®)
  • Create a file app.js in the website directory and fill it with the following code:
const express = require('express');
const app = express();
const PORT = process.env.SERVICE_PORT;

app.get('/', (req, res) => {
  res.send('Hello! This is my first server on Node.js + Express 🚀');
});

app.listen(PORT, () => {
  console.log(`Server is running at http://localhost:${PORT}`);
});
  • In the website directory, run the command to install express
npm20.15.1 install express
  • Go to the site dashboard, then to the Services section
  • Restart the service
  • Check the website

Docusaurus

Using the Docusaurus web application as an example, let’s configure settings:

  • Connect to the server via SSH as the user who owns the site (you can use the ttyd application for FASTPANEL®)
  • In the website directory, run the Docusaurus installation
npx20.15.1 create-docusaurus -j ./docs
  • When asked to select a template, answer classic (recommended)
  • After installation, replace one line in the file docs/package.json
"start": "docusaurus start",
# replace with 
"start": "docusaurus start --port $SERVICE_PORT",

$SERVICE_PORT is a system variable set in FASTPANEL®

  • In the control panel, go to "site settings" -> "Backend"
  • Select the Standalone or PM2 handler.
  • Choose the desired Node.js version.
  • Specify the working folder docs
  • In the Launch command field, enter: npm run start
  • Save. Wait for the application to compile (information will appear in the logs). Check the website

Next.js

Using Next.js with Node.js 20.19 as an example, let’s create a simple web server:

  • Connect to the server via SSH as the user who owns the website (you can also use the ttyd application in FASTPANEL®).
  • In the website directory, run the project initialization command:
yarn20.19.4 init -y
yarn20.19.4 add next react react-dom
  • Add a scripts block to the package.json file:
"scripts": {
  "dev": "next dev -p $SERVICE_PORT",
  "build": "next build",
  "start": "next start -p $SERVICE_PORT"
}
  • Create a pages directory and inside it, add a file named index.js:
mkdir pages
cat <<EOF > pages/index.js
export async function getServerSideProps() {
  return {
    props: {
      nodeVersion: process.version,
      port: process.env.SERVICE_PORT || 3000,
    },
  };
}

export default function Home({ nodeVersion, port }) {
  return (
    <div style={{
      fontFamily: 'sans-serif',
      textAlign: 'center',
      marginTop: '20vh'
    }}>
      <h1>✅ It works!</h1>
      <p>Next.js app running on Node.js {nodeVersion}</p>
      <p>Port: {port}</p>
    </div>
  );
}
EOF
  • Run the project build.
yarn20.19.4 build
  • In the control panel, go to "site settings" -> "Backend"
  • Select the Standalone or PM2 handler.
  • Choose the desired Node.js version.
  • In the Launch command field, enter: yarn run start.
  • Save. Wait for the application to compile (information will appear in the logs). Check the website

Additional information

In Standalone mode, a Node.js process is launched to execute your scripts.

In PM2 mode, the PM2 process manager is used to manage Node.js processes, logs, and system load.
This mode also allows you to specify the number of workers — that is, the number of Node.js processes handling incoming requests to the server.
Additionally, this mode provides the Enable file watch option — PM2 automatically restart your application when a file is modified in the current directory or its subdirectories. Please note that this mode introduces additional system load and is not recommended for production environments.

Similarly, you can configure the application if it requires YARN instead of NPM

You can install your project’s dependencies listed in package.json using YARN or NPM directly from FASTPANEL®. To do this, open the website card and go to the Services section:

Logs

A Node.js application can generate logs. In FASTPANEL®, they are located in the site dashboard, in the Logs section, under the "Backend log" tab

Console commands

After installing Node.js in FASTPANEL®, users can work with their projects using console commands such as:

  • pm2
  • yarn20.15.1
  • npx20.15.1
  • npm20.15.1
  • node20.15.1

Example:

$ npm20.15.1 list
node-socket-port-server@1.0.0 /var/www/node_user/data/www/node.site
└── express@4.21.2
$ pm2 ls
┌────┬─────────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
│ id │ name        │ namespace   │ version │ mode    │ pid      │ uptime │ ↺    │ status    │ cpu      │ mem      │ user     │ watching │
├────┼─────────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
│ 0  │ amazing_site│ default     │ 1.0.0   │ cluster │ 9355     │ 2m     │ 0    │ online    │ 0%       │ 62.4mb   │ user     │ disabled │
│ 1  │ amazing_site│ default     │ 1.0.0   │ cluster │ 9362     │ 2m     │ 0    │ online    │ 0%       │ 62.5mb   │ user     │ disabled │
└────┴─────────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘

Each command name includes the version number of Node.js that was installed. In this example, the available version is Node.js 20.15.1.

FASTPANEL Extended

Mail statistics

On this page
info

FASTPANEL Extended is enabled by default for everyone. No license activation is required.

FASTPANEL® includes a Mail statistics feature that allows you to easily monitor outgoing email activity for an entire domain or individual mailboxes. You can quickly see how many messages were sent, delivered, or bounced, and view detailed SMTP error codes with recommendations explaining why certain emails were rejected.

Configure automatic statistics collection

  1. To enable automatic mail statistics collection, navigate to "Settings" → "Mail" → "Statistics" and toggle the "Enable statistics collection" option.

If you prefer not to collect data automatically, disable this option. You will then need to manually click the "Update" button in the statistics view (see the next section) to refresh the data.

  1. You can define how often the statistics are automatically updated — from every 1 hour up to every 24 hours.

  2. To save your settings don't forget to click on the "Save" button.

Statistics view

To view the statistics, navigate to "Management" → "Mail", and click the graph icon next to the domain you want to analyze.

The statistics view is divided into three main sections, which are described in detail below.

Statistics chart

Displays the total number of sent, delivered, and bounced messages over the selected time period. The chart helps you identify trends and delivery issues at a glance.

You can customize the displayed data by:

  1. Selecting a mail domain.

  2. Selecting statistics for the entire domain or a specific mailbox.

  3. Choosing the time range for the report — from the last 24 hours to the last month.

  4. Clicking the "Update" button to manually refresh the statistics and retrieve the latest data.

Top bounce reasons

Lists the most frequent causes of message delivery failures, along with their corresponding SMTP error codes. This allows you to understand and address recurring problems.

Outbound error events

Provides detailed information about each rejected or undelivered message, with recommended actions to resolve issues.

For each record, the following details are displayed:

  • Date/Time — the exact time when the delivery attempt occurred

  • Queue ID — the unique identifier of the message in the mail queue

  • From / From domain / To — sender and recipient addresses, as well as the originating domain

  • SMTP code — the response code returned by the recipient’s mail server (for example, 550-5.7.26)

  • Advice — a short explanation of the issue and a recommended action (e.g., “Message rejected by Gmail: missing or failing SPF/DKIM authentication”)

  • Detail — the complete SMTP response text, which may include a link to external documentation from the recipient server (for example, Gmail support pages)

  • Unknown code — indicates whether the SMTP response could not be classified

  • Bytes — size of the email message

  • Retry count — number of delivery attempts made before the message was permanently rejected

  • Last try — timestamp of the final delivery attempt

  • Spam score — spam evaluation result, if applicable

This data provides a comprehensive overview of outbound delivery issues, helping you diagnose authentication, reputation, or configuration issues.

Prometheus

On this page
info

FASTPANEL Extended is enabled by default for everyone. No license activation is required.

Integration of FASTPANEL with Prometheus for metrics collection

FASTPANEL® now supports integration with Prometheus for collecting system metrics. This guide will walk you through the steps needed to add your FASTPANEL® instance to Prometheus, allowing you to gather and monitor system metrics in real time.

Create a Token

To allow Prometheus to collect metrics, you need to create a special token with limited access:

  1. Connect to your FASTPANEL® server via SSH.

  2. Run the following command to create a token:

mogwai users tokens add -n metrics_test_token -s read_only -s metrics_only
  • metrics_test_token is a custom name for the token; you can choose any name
  • The token will be granted the following scopes:
    • read_only — read-only access
    • metrics_only — access restricted to metrics

Add a job to Prometheus

Once the token is created, you need to configure Prometheus to start scraping metrics from your FASTPANEL® instance.

Open your Prometheus configuration file and add a new job:

- job_name: "fastpanel2"
  scheme: https
  static_configs:
    - targets: ["$IP:8888"]
  metrics_path: /api/metrics
  tls_config:
    insecure_skip_verify: true
  bearer_token: I_AM_TOKEN
  scrape_interval: 60s
  • job_name — a custom name for the job
  • targets — the IP address and port of your FASTPANEL® server. Replace $IP with your servers IP address
  • metrics_path — the API endpoint to fetch metrics from
  • bearer_token — replace this with your generated token (metrics_test_token)
  • scrape_interval — how often Prometheus should scrape the metrics (set to 60 seconds in this case)

Configure the Monitoring Dashboard

After successfully adding your FASTPANEL® instance to Prometheus, you can set up your first dashboard to visualize the collected metrics.

For importing the dashboard, please follow this guide.

Now Prometheus will start collecting metrics from your FASTPANEL® instance, enabling you to monitor system performance in real time.

Server notifications

On this page
info

FASTPANEL Extended is enabled by default for everyone. No license activation is required.

FASTPANEL® allows monitoring of key server metrics: CPU load, Load Average 5, disk usage, and RAM consumption. When a metric exceeds its threshold, alerts are sent automatically to Telegram or Slack. Configuration is located under "Settings" → "Notifications".

This article explains how to set up delivery channels and configure notification parameters, including thresholds and triggers.

Channel setup

Telegram

  1. Create a new bot using the official Telegram bot @BotFather. Follow the link and click the "Start" button
  1. Type /newbot and press Enter.
  2. Enter the desired name for your bot and press Enter.
  3. Enter the desired username for your bot. It must end with bot, then press Enter.
  4. You will receive a message starting with:
    Done! Congratulations on your new bot.
  5. Click the blue line after Use this token to access the HTTP API: (blurred in the screenshot) to copy your bot's API token to the clipboard. Keep the token secure, as anyone with it can control your bot
note

The API token is stored in @BotFather. If you forget it, send the /mybots command, select your bot, and click the "API Token" button.

  1. Open FASTPANEL® and navigate to "Settings" → "Notifications".
  2. Click the "Create channel" button
  1. Fill in the following fields:
  • Name — Enter a name for the channel to distinguish it visually
  • Channel — Choose "Telegram"
  • Bot token — Paste the bot token copied in step 6
  • Problem period — Set the time interval (in minutes) after which a notification will be sent if the issue persists. Minimum value is 1 minute
  • Notification repeat interval — Set the interval between consecutive notifications for the same issue
  • Notify about solved problems — Enable this option to receive a notification when the issue is resolved
  • Add basic triggers — Enable this option to automatically create triggers for all drives, RAM, and CPU
  1. Click the "Save" button.
  2. On the next screen, click the "Invite" button to invite your bot to the chat or group chat
  1. A link will open in a new tab. Confirm the redirect to the Telegram Desktop application
  1. Click the "Start" button to activate your bot
  1. To verify that the setup is correct, return to the FASTPANEL® tab and click the paper plane button
  1. If everything is configured properly, a test notification will be sent to the chat with your bot
  1. To adjust channel settings later, click the pencil icon next to the channel
  1. Below is an example of a notification generated when a trigger is activated

Slack

  1. Log in to your account and create a Slack app via the apps page.
  2. Select "From scratch".
  3. Enter an App Name, choose the workspace where the app will be created, and click “Create app”.
  4. In the “Features” section, open “Incoming Webhooks” and enable the feature
  1. At the bottom of the same page, click “Add New Webhook”
  1. On the next screen, select the channel where notifications will be sent. It is recommended to create a dedicated channel for alerts. Then click “Allow”.
  2. You will be redirected back to the webhooks page. Scroll down and click “Copy” to copy the webhook URL
  1. Open FASTPANEL® and navigate to "Settings" → "Notifications".
  2. Click the "Create channel" button
  1. Fill in the following fields:
  • Name — Enter a name for the channel to visually distinguish it
  • Channel — Choose "Slack"
  • Webhook url — Paste the webhook URL copied in step 7
  • Problem period — Set the time interval (in minutes) after which a notification will be sent if the issue persists. Minimum value is 1 minute
  • Notification repeat interval — Set the interval between consecutive notifications for the same issue
  • Notify about solved problems — Enable this option to receive a notification when the issue is resolved
  • Add basic triggers — Enable this option to automatically create triggers for all drives, RAM, and CPU
  1. Click the "Save" button.
  2. To verify that the setup is correct, click the paper plane button
  1. If everything is configured correctly, a test notification will be sent to the channel selected in step 6
  1. To adjust channel settings later, click the pencil icon next to the channel
  1. Below is an example of a notification generated when a trigger is activated

Triggers configuration

To configure triggers, click the cog icon in the row of the channel you want to edit

In the opened section, you can:

  1. Disable unnecessary triggers using the toggle on the left.
  2. Create a new trigger of one of the following types: CPU, Disk (for each disk individually), Load Average 5 (average system load over the last 5 minutes), RAM.
  3. Edit existing triggers

Thresholds for CPU, Disk, and RAM are set in percentages. Threshold for Load Average 5 is set in integer values.

note

As a general rule, a normal Load Average 5 value is approximately equal to the number of CPU cores on the server, or up to twice that number.