aceberg/miniboard

View on GitHub
configs/board.yaml

Summary

Maintainability
Test Coverage
tabs:
    0:  # Tab IDs (integer). Default tab has ID 0
        name: Tab1  # Tab name 
        needs_auth: false
        refresh: "" # Refresh Webpage (seconds). Leave blank for system-wide config:WebRefresh to work
        horiz: false
        panels:     # Panels on this tab
            0: Search   # Place ID (integer):Panel ID (string)
            1: Panel2   # Use Place ID to sort Panels on Tab
    1:
        name: Tab2
        needs_auth: true # If true and auth is enabled, only logged in user will be able to view this tab
        refresh: "240"
        horiz: true # Horizontal layout if true
        panels:
            0: Search
panels:
    Panel2:   # Panel ID (string) must be the same as Panel Name
        name: Panel2    # Panel Name (string) must be the same as Panel ID
        scan: false     # Check if hosts of this panel are online (true or false)
        timeout: "5"    # Minutes between scans (Default: 1)
        hosts:
            0:  # Host ID (integer), use them to sort hosts on Panel
                name: /r/selfhosted     # Host Name (string)
                addr: reddit.com        # IP or DNS-name without http(s) is needed to scan if host is online (if scan=true)
                port: ""                # Port to scan (default: 80)
                url: https://www.reddit.com/r/selfhosted    # URL to click (with http(s) part)
                icon: https://www.redditinc.com/assets/images/site/reddit-logo.png  # Link to icon
    Search:
        name: Search
        scan: true
        hosts:
            0:
                name: Google
                addr: google.com
                port: ""
                url: https://www.google.com/
                icon: ""
            1:
                name: DuckDuckGo
                addr: duckduckgo.com
                port: ""
                url: https://duckduckgo.com/
                icon: ""
uptime:
    enabled: true   # Enable uptime monitoring
    needs_auth: false # If true and auth is enabled, only logged in user will be able to view
    show: 30        # Lines to show on Uptime page (Default: 20)
    notify:         # URLs to notify (See Shoutrrr docs: https://containrrr.dev/shoutrrr/0.7/services/overview/)
        gotify: gotify://192.168.2.2:8083/A2MD-k4uzC8-zuA/?title=Host status changed&DisableTLS=yes # Gotify example
    panels:         # Monitored panels
        Panel2:         # Panel name
            retries: 3  # Retries before notification is send
            notify:     # Which services to notify
                - gotify