Configuration

Configuration

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

General Settings

General settings contains some global configuration options.

Dashbord Title

This is the text that appears on the dashboard on the very top center acting as the title.

Browser Tab Title

This allows you to change the text in the browser tab.

Favicon URL

This allows you to set a favicon for the browser tab. As of now, I have only tested with image links to .ico formatted images.

Theme Mode

There are 5 theme modes

1. Light Mode
2. Dark Mode
3. Transparent Light
4. Transparent Dark
5. Service Mode

Service mode enables service pings for each of the listed services on the dashboard. The backend pings the service every 60 seconds.

• Green = Reachable
• Red = Unreachable

Show Details Toggle

This toggles showing service details on the service card.

Background URL

This allows you to set a background URL from an image link. I have tested .jpg and .png so far.

Font Family

Allows you to change the font

Font Size

Allows you to change the size of the font

Icon Size

Allows you to change the size of the small icons under the search bar.

Pages

These are the settings for different pages. You can add/remove new pages, name/rename them, change the order, etc.

Groups

This section allows you to set groups (Categories or sections) of services. Configuration of a group has 3 parts. Name, Page, Display Order.

Name

Setting the name will display whatever is written on screen in sections

Page

You can set groups to display on specific pages to keep things separately organized

Display Order

Self Explanatory

Services

Services are the individual cards that display your services. There are multiple parts of configuration below.

Service Name

This will be displayed on the service card

Service URL

This is the URL that clicking the service card will direct to.

Icon URL

You can set whatever icon you want for the service. I have tested with selfh.st icons at this point and some .ico and .png files.

IP Address (Optional)

This is optional, if you want the backend to ping the service, then this and port will need to be filled in.

Port (Optional)

Optional unless you want the backend to ping the service.

Group

This is where you can set the group you want the service to show up in.

Display Order

Self Explanatory

Icons

These are small icons under the search bar that allow quick access services. These persist across pages.

Additional information

Pictures and additional configuration will be added soon and as needed.

Widgets

More Extensive Widget configuration can be found on the dedicated Wiki page for Widgets

Adding Widgets

1. Go to /config in your dashboard
2. Click the "Widgets" tab
3. Click "Add Widget"
4. Select 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