Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

matfire/Dashview

Repository files navigation

Dashview

A dashboard for service status visualization

Discord GitHub License GitHub release (latest by date including pre-releases)

Stack

  • Remix
  • TailwindCSS (+ daisyui)
  • Zod

Goal

provide a way to see at a glance the status of desired services (i.e. urls)

Install

  • Install Docker
  • Get the latest image
docker pull ghcr.io/matfire/dashview:latest
docker run -v <your_config_file>:/app/config.json -e CONFIG=/app/config.json ghcr.io/matfire/dashview:latest

Schema

a config.json schema is as follows

{
    categories: [{
        name: a readable name for the category
        icon: not yet implemented, optional
        color: an hexadecimal color (i.e. #FF00AA), optional
        id: not yet implemented, optional
    }],
    apps: [{
        category: must refer to a category name or id,
        name: a readable name for the app,
        url: the service url,
        icon: not yet implemented, optional
    }]
}

a valid config file looks like this:

{
    "categories": [
        {
            "name":"Category2",
            "color":"#FF0000"
        }
    ],
    "apps": [
        {
            "category":"Category2",
            "name":"test2",
            "url":"https://google.com"
        },
        {
            "category":"Category2",
            "name":"test",
            "url":"https://example.com"
        }
    ]
}