A simple, pluggable dashboard and status page
A simple dashboard used to show the status of various connected pieces of software.
The video below showcases a single docker socket connection (But it does much more than docker!)
https://user-images.githubusercontent.com/2565465/123544521-efc73780-d753-11eb-9d79-ca176320fe2e.mov
To display a simple status and list of all of my docker containers. I've been toying with making myself a proper home dashboard and I think think this is a good start.
I also wanted to play with GraphQL subscriptions and observables
And this has since grown into something that can give an up to date status on various different connectors.
docker-compose.yml:
version: "2.1"
services:
plugsy:
image: plugsy/core
container_name: plugsy
volumes:
- /var/run/docker.sock:/var/run/docker.sock
ports:
- 3000:3000
restart: unless-stopped
vikunjadb:
image: mariadb:10
labels:
plugsy.name: "DB"
plugsy.parents: "Todo"
plugsy.icon: "@styled-icons/feather/Database"
container_name: vikunjadb
command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
restart: unless-stopped
vikunjaapi:
container_name: vikunjaapi
image: vikunja/api
restart: unless-stopped
labels:
plugsy.name: "API"
plugsy.parents: "Todo"
plugsy.icon: "@styled-icons/feather/Server"
vikunjafrontend:
image: vikunja/frontend
container_name: vikunjafrontend
restart: unless-stopped
labels:
plugsy.name: "Todo"
plugsy.category: "Home"
plugsy.icon: "@styled-icons/fa-solid/Horse"
plugsy.link: https://my.vikunja.com
There is now a configuration file that can be optionally added in order to include various connectors (Such as website connections or other arbitrary links). See connectors
This file should be mounted at /config.json
in the container.
Note: Including the $schema
field in the JSON file will help with auto complete in your preferred IDE.
config.json
{
"$schema": "https://github.com/plugsy/core/releases/download/v7.0.0/core-config-schema.json",
"connectors": [
{
"type": "DOCKER",
"config": {}
},
{
"type": "RAW",
"config": {
"id": "file",
"items": [
{
"category": "Other",
"name": "Beer Tab",
"state": "GREEN",
"icon": "@svg-icons/boxicons-regular/Beer"
},
{
"name": "Beer Tab Dependency",
"state": "GREEN",
"icon": "@svg-icons/ionicons-solid/Beer",
"parents": ["Beer Tab"]
}
]
}
}
]
}
docker-compose.yml:
version: "2.1"
services:
plugsy:
image: plugsy/core
container_name: plugsy
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- ./config.json:/config.json
ports:
- 3000:3000
restart: unless-stopped
NEW IN V6
We've moved to styled-icons (In particular the svg-icons packages)
You can use any icons available in styled-icons. Super simple, go to the page above, click the icon you would like to use, and use it in your config or docker labels.
Example using docker labels:
plugsy.icon: '@svg-icons/simple-icons/Plex'
is to load the Plex
icon in the simple-icons pack
plugsy.icon: '@svg-icons/simple-icons/Homeassistant'
is to load the Homeassistant
icon in the simple-icons pack
Example using config.json:
"connectors": [
{
"type": "DOCKER",
"config": {
"containerMap": {
"plugsy-container-name": {
"category": "Home",
"icon": "@svg-icons/boxicons-regular/Crown",
"name": "Plugsy"
}
}
}
}
]
}
** NEW IN V6 **
You can now use icons using a URL!
Example using docker labels:
plugsy.icon: 'https://symbols.getvecta.com/stencil_82/45_google-icon.d8d982f8a1.png'
Example using config.json:
"connectors": [
{
"type": "DOCKER",
"config": {
"containerMap": {
"plugsy-container-name": {
"category": "Home",
"icon": "https://symbols.getvecta.com/stencil_82/45_google-icon.d8d982f8a1.png",
"name": "Plugsy"
}
}
}
}
]
}
In order to show dependent containers, you need only ensure that the item you wish to show has a parents label pointing at the same name as another item.
Example using the raw connector:
{
"$schema": "https://github.com/plugsy/core/releases/download/v7.0.0/core-config-schema.json",
"connectors": [
{
"type": "DOCKER",
"config": {}
},
{
"type": "RAW",
"config": {
"id": "file",
"items": [
{
"category": "Other",
"name": "Beer Tab",
"state": "GREEN",
"icon": "@svg-icons/boxicons-regular/Beer"
},
{
"name": "Beer Tab Dependency",
"state": "GREEN",
"icon": "@svg-icons/ionicons-solid/Beer",
"parents": ["Beer Tab"]
}
]
}
}
]
}
An example of the same logic being applied using the docker connector docker-compose.yml can be shown below:
vikunjaapi:
container_name: vikunjaapi
image: vikunja/api
restart: unless-stopped
labels:
plugsy.name: "API"
plugsy.parents: "Todo"
plugsy.icon: "@styled-icons/feather/Server"
vikunjafrontend:
image: vikunja/frontend
container_name: vikunjafrontend
restart: unless-stopped
labels:
plugsy.name: "Todo"
plugsy.category: "Home"
plugsy.icon: "@styled-icons/fa-solid/Horse"
plugsy.link: https://my.vikunja.com
Simple enough:
docker-compose up --build
Based off of AsyncAPIs blog
Ensure that a both a category and a name are defined,
if you're using the default docker configuration and labels,
that will require both the plugsy.category
and plugsy.name
labels on your container.
Category is required, you can only omit category when you want the container to appear as a child of another item on the dashboard.