Post

Create Your Dashboard with Dashy

Prerequisites

  • Docker-CE
  • Docker-Compose

create a folder called docker and sub-folder called dashy

mkdir -p docker/dashy && cd docker/dashy

vim docker-compose.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
version: "3.4"
services:
  dashy:
    image: lissy93/dashy:latest
    container_name: Dashy
    # Pass in your config file below, by specifying the path on your host machine  
    volumes:
      - ./conf.yml:/app/public/conf.yml
    ports:
      - 4000:80
    # Set any environmental variables
    environment:
      - NODE_ENV=production
    restart: always
    # Configure healthchecks
    healthcheck:
      test: ['CMD', 'node', '/app/services/healthcheck']
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s

Icons

referrence icons list

eg:

1
2
3
4
5
6
7
8
9
10
11
sections:
- name: Home Lab Icons Example
  items:
  - title: AdGuard Home
    icon: hl-adguardhome
  - title: Long Horn
    icon: hl-longhorn
  - title: Nagios
    icon: hl-nagios
  - title: Whoogle Search
    icon: hl-whooglesearch
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
pageInfo:
  title: My Dashboard
  description: Welcome to My dashboard!
  navLinks:
    - title: GitHub
      path: https://github.com/Lissy93/dashy
    - title: Documentation
      path: https://dashy.to/docs
appConfig:
  theme: color-block
  layout: auto
  iconSize: medium
  language: en
sections:
  - name: Getting Started
    icon: fas fa-rocket
    items:
      - title: ESXi
        description: VMware ESXi
        icon: hl-vmwareesxi
        url: 'https://192.168.1.1'
        target: newtab
        statusCheckAllowInsecure: true
        id: 0_1481_esxi
      - title: Proxmox
        description: Proxmox
        icon: hl-proxmox
        url: https://192.168.1.2:8006
        target: newtab
        id: 1_1481_proxmox
      - title: Docs
        description: Configuring & Usage Documentation
        provider: Dashy.to
        icon: far fa-book
        url: https://dashy.to/docs
        id: 2_1481_docs
      - title: Showcase
        description: See how others are using Dashy
        url: https://github.com/Lissy93/dashy/blob/master/docs/showcase.md
        icon: far fa-grin-hearts
        id: 3_1481_showcase
      - title: Config Guide
        description: See full list of configuration options
        url: https://github.com/Lissy93/dashy/blob/master/docs/configuring.md
        icon: fas fa-wrench
        id: 4_1481_configguide
      - title: Support
        description: Get help with Dashy, raise a bug, or get in contact
        url: https://github.com/Lissy93/dashy/blob/master/.github/SUPPORT.md
        icon: far fa-hands-helping
        id: 5_1481_support
  - name: Today
    icon: far fa-smile-beam
    displayData:
      collapsed: false
      hideForGuests: false
    widgets:
      - type: clock
        options:
          timeZone: Asia/Hong_Kong
          format: en-GB
        id: 0_513_clock
      - type: weather
        options:
          apiKey: efdbade728b37086877a5e83442004db
          city: hongkong
        id: 1_513_weather
  - name: CPU History
    icon: fas fa-microchip
    displayData:
      cols: 2
    widgets:
      - type: gl-cpu-history
        options:
          hostname: http://192.168.1.2:61208
          limit: 60
        id: 0_1018_glcpuhistory
  - name: CPU & Memory
    icon: fas fa-tachometer
    widgets:
      - type: gl-current-cpu
        options:
          hostname: http://192.168.1.2:61208
        id: 0_967_glcurrentcpu
      - type: gl-current-mem
        options:
          hostname: http://192.168.1.2:61208
        id: 1_967_glcurrentmem
  - name: Disk Space
    icon: fas fa-hdd
    widgets:
      - type: gl-disk-space
        options:
          hostname: http://192.168.1.2:61208
        id: 0_919_gldiskspace
  - name: Network Interfaces
    icon: fas fa-ethernet
    widgets:
      - type: gl-network-interfaces
        options:
          hostname: http://192.168.1.2:61208
          limit: 500
        id: 0_1806_glnetworkinterfaces
  - name: System Load
    icon: fas fa-tasks-alt
    widgets:
      - type: gl-system-load
        options:
          hostname: http://192.168.1.2:61208
        id: 0_1061_glsystemload
This post is licensed under CC BY 4.0 by the author.