erohtar / Dasherr

A minimal and lightweight dashboard for your self-hosted services (and bookmarks)
GNU General Public License v3.0
190 stars 8 forks source link
bookmark-manager dashboard docker homelab homepage self-hosted startpage theme

image image

Dasherr

A minimal and lightweight dashboard for your self-hosted services (and bookmarks)

Features:

Installation

With Docker

Without Docker

Configuration

A sample settings.json is included in the release. It should be used as a template to edit/add your own Sections and Tiles (services). All the configuration settings are explained below.

Page

The 'page' settings allow you to define these top-level options:

Sample:

"page": {
    "title": "Dasherr",
    "theme": "Onedark",
    "openTab": "new"
}

Widgets

This is an array of any number of widgets on your dashboard (single or multiple instances of each)

Glances

To keep with the minimalist theme and stay light on resources, there's only one type of widget currently supported - Glances.

Configurable settings:

Sample:

"widgets": [
    {
        "name": "Stats",
        "type": "glances",
        "disable": 0,
        "settings": {
            "url": "http://homeserver:61208/",
            "refreshMs": 5000
        }
    }
]

Sections

This is an array of any number of individual Sections in your dashboard.

Configurable settings:

Tiles

This is an array of any number of individual Tiles (services) in a section.

Configurable settings:

Sample (Section and Tiles):

"sections": [
    {
        "name": "Maintenance",
        "tiles": [
            {
                "name": "Portainer",
                "url": "http://homeserver:9000/",
                "faIcon": "fab fa-docker"
            },
            {
                "name": "FileBrowser",
                "url": "http://homeserver:8020/",
                "faIcon": "fa fa-folder-tree"
            }
        ]
    }
]

Themes

Dasherr comes with several built-in themes, and you can easily add your own by copying any existing theme in settings file and making edits to the hex color values and/or add picture background.

Configurable settings:

Sample:

"Onedark": {
    "background": "",
    "colorBg": "#282c34",
    "colorPr": "#dfd9d6",
    "colorSc": "#98c379",
    "colorOn": "#98c379",
    "colorOf": "#282c34"
}

Alternate Configurations

Dasherr supports using alternate settings files. This allows having a different theme, a whole different set of sections/services on another Dasherr page without having multiple Dasherr installations. This file could group a different set of services (a self-hosted cloud instance, for example) or another home server etc.

Usage:

See settings.sample.json for usage example, it loads settings.sh.json via index.php?s=settings.sh.json

Credits