Skip to content

Commit 5fc8ecf

Browse files
authored
Update README.md
1 parent 288e5e9 commit 5fc8ecf

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ A lightweight Python-based agent that provides real-time monitoring of Docker co
1212
- **Fast & Lightweight**: Designed for quick responses, even with many containers.
1313
- **Easy Deployment**: Runs as a Docker container with minimal configuration.
1414

15+
## Screenshot
16+
17+
![image](https://github.com/user-attachments/assets/b7a1f2dc-6f58-4edc-bb29-ba92002c26a5)
18+
![image](https://github.com/user-attachments/assets/3960da14-9f7a-4b45-8e46-90d84ddcbb21)
19+
20+
1521
---
1622

1723
## Quick Start
@@ -136,6 +142,43 @@ curl http://localhost:8080/status | jq
136142

137143
---
138144

145+
## Web Dashboard
146+
147+
A modern, interactive dashboard UI is included! Just open:
148+
149+
http://localhost:8080/dashboard.html
150+
151+
in your browser after starting the agent. No extra setup is required.
152+
153+
### Dashboard Features
154+
- **System Overview**: Uptime, CPU idle %, core count, memory, swap, and disk usage cards.
155+
- **Charts**: Real-time graphs for system load, CPU modes, memory, disk IO, network, and swap.
156+
- **Container Selector**: Switch between running containers to view their stats.
157+
- **Per-Container Stats**: Status, image, uptime, restart count, ports, and resource usage (CPU %, memory MB) with historical charts.
158+
- **Responsive Design**: Works on desktop and mobile.
159+
160+
---
161+
162+
## API
163+
164+
- **/status**: Returns a JSON object with host and container stats. See example above for structure.
165+
- **/dashboard.html**: Serves the dashboard UI.
166+
167+
---
168+
169+
## Running Without Docker (Advanced)
170+
171+
You can run the agent directly with Python 3.8+ (Linux recommended):
172+
173+
```bash
174+
pip install flask psutil docker humanize
175+
python agent.py
176+
```
177+
178+
Then visit http://localhost:8080/dashboard.html in your browser.
179+
180+
---
181+
139182
## Configuration
140183

141184
- **Port**: Default is `8080` (see `agent.py`).

0 commit comments

Comments
 (0)