Skip to content

Its4Nik/DockStat

Repository files navigation

DockStat Logo

Dockstat is a monitoring frontend powered by the DockStatAPI.
It provides usage statistics like CPU, RAM, and Network usage.
Integrations can also be enabled using optional variables. Check the documentation (WIP) here for more information.
To see more screenshots please visit the wiki here.

Mockups DockStat Mockup DockStat Mockup

πŸ–ŠοΈ Work in Progress

  • Refactoring
  • Fix theme switcher
  • WebUI for API config (Read only)
  • WebUI for adding/removing hosts from DockStatAPI config
  • Sorting for Hosts
  • Custom host tags (e.g., "Raspberry", "Cloudserver")
  • Alert System (using Apprise or similar)
  • Improved mobile UI
  • Host Stats (CPU cores, Max RAM, RAM used by containers)
  • More themes
  • More advanced sub-pages
  • Exclude network mode "host" from network stats or other handling
  • Add "Secondary API Host" for high availability
  • Persistent theme/refresh rate choice
  • Changable size of "Container Cards"
  • Integration with cup, DockStat Wiki: Integrations - Cup

🎁 Integrations

Integrations allow you to connect external sercives to DockStat.

List:

To configure your integrations and see more details please visit the wiki.


⬇️ Installation Using Docker

name: DockStat
services:
  # Frontend
  dockstat:
    image: ghcr.io/its4nik/dockstat:latest
    container_name: dockstat
    ports:
      - "4444:3000"
    environment:
      - API_URL="http://localhost:7070" # DockStatAPI endpoint
      - DEFAULT_THEME="dracula"
      - SECRET="CHANGME"
      - LOGO_SIZE="M" # Default Logo Size "M"
      - DM_LOGO_COLOR="#FFFFFF" # Dark mode logo color
      - LM_LOGO_COLOR="#000000" # Light mode logo color
    volumes:
      - ./dockstat/icons:/app/build/icons
    restart: always

  # API
  dockstatapi:
    image: ghcr.io/its4nik/dockstatapi:latest
    container_name: dockstatapi
    environment:
      - SECRET=CHANGEME # Required in the header 'Authorization': 'CHANGEME'
    ports:
      - "7070:7070"
    volumes:
      - ./dockstatapi:/api/config # Place your hosts.yaml file here
    restart: always

Configuration

Wiki


🌟 StarHistory 🌟

Star History Chart


⚠ Known Issues ⚠

Open

  1. #24

Resolved

  1. Theme switching only works once. See code logic for details.

  2. Adding the default theme will make other themes unusable due to not being able to select them. See code logic for details.