This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Configuration

Configuration is all done through a configuration UI. This allows for easy config changes.

General Settings

• Dashboard Title: Sets the main title at the top-center of the dashboard.

• Browser Tab Title: Customizes the text in the browser tab.

• Favicon URL: Specifies a favicon for the tab (preferably .ico images).

• Theme Mode: Choose one of five modes:

  1. Light
  2. Dark
  3. Transparent Light
  4. Transparent Dark
  5. Service Mode Light/Dark
     • Service Mode enables backend pings for each listed service every 60 seconds.
     • Green = Reachable
     • Red = Unreachable
  6. Retro
  7. Matrix
  8. Nuclear

• Show Details Toggle: Toggles visibility of service details on cards.

• Background URL: Sets a custom dashboard background image (.jpg and .png supported).

• Font Family & Size: Adjusts font style and size.

• Icon Size: Changes the size of icons under the search bar.

Pages

Manage dashboard pages—add, remove, rename, and reorder them as needed.

Groups

Organize services into groups (categories/sections):

• Name: Displayed as the section label.
• Page: Assign to a specific page for organization.
• Display Order: Arrange group order.

Services

Configure individual service cards:

• Service Name: Displayed on the card.
• Service URL: Destination when clicked.
• Icon URL: Customize the card icon (.ico and .png supported).
• IP Address & Port (Optional): Required for backend ping functionality.
• Group: Assign to a group.
• Display Order: Set the card’s position.

Icons

Configure persistent quick-access icons beneath the search bar.

Additional Information

Images and further configuration options will be added as needed.

Widgets

For advanced widget setup, refer to the dedicated Wiki page.

Adding Widgets

1. Go to /config in your dashboard.
2. Click the "Widgets" tab.
3. Click "Add Widget".
4. Select the widget type.
5. Choose the page where the widget will appear.
6. Configure widget settings (JSON format).
7. Set display order.
8. Save the widget.

Alerts

You can setup Alerts for your services, refer to the dedicated wiki page