Skip to content

A frontend of DockStatsAPI, showing various docker container statistics using React.

License

Notifications You must be signed in to change notification settings

SenseiUsagi/dockstat

 
 

Repository files navigation

🐳 Dockstat 🐳

A Docker Monitoring Frontend

Dockstat is a monitoring frontend powered by the DockStatAPI. It provides usage statistics like CPU, RAM, and Network usage.

Example, Night Theme

See more examples here.

Check the documentation (WIP) here.


🖊️ 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"

⬇️ 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:

Please see Configuration.md


Star History

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.


Please don't judge this project too harshly—it's my first major React project. For more information, open a new issue! 😄

About

A frontend of DockStatsAPI, showing various docker container statistics using React.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 64.9%
  • CSS 25.8%
  • Shell 4.8%
  • HTML 2.7%
  • Dockerfile 1.8%