Skip to content

Commit 15b8025

Browse files
committed
docs: [#1579] add tracker demo section to README
1 parent 34a6635 commit 15b8025

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@
1919
- [x] Support [newTrackon][newtrackon] checks.
2020
- [x] Persistent `SQLite3` or `MySQL` Databases.
2121

22+
## Tracker Demo
23+
24+
Experience the **Torrust Tracker** in action with our comprehensive demo environment! The [Torrust Demo][torrust-demo] repository provides a complete setup showcasing the tracker's capabilities in a real-world scenario.
25+
26+
The demo takes full advantage of the tracker's powerful metrics system and seamless integration with [Prometheus][prometheus]. This allows you to monitor tracker performance, peer statistics, and system health in real-time. You can build sophisticated Grafana dashboards to visualize all aspects of your tracker's operation.
27+
28+
![Sample Grafana Dashboard](./docs/media/demo/torrust-tracker-grafana-dashboard.png)
29+
30+
**Demo Features:**
31+
32+
- Complete Docker Compose setup.
33+
- Pre-configured Prometheus metrics collection.
34+
- Sample Grafana dashboards for monitoring.
35+
- Real-time tracker statistics and performance metrics.
36+
- Easy deployment for testing and evaluation.
37+
38+
Visit the [Torrust Demo repository][torrust-demo] to get started with your own tracker instance and explore the monitoring capabilities.
39+
2240
## Roadmap
2341

2442
Core:
@@ -49,7 +67,7 @@ Utils:
4967

5068
Others:
5169

52-
- [ ] Support for Windows.
70+
- [ ] Intensive testing for Windows.
5371
- [ ] Docker images for other architectures.
5472

5573
<https://github.com/orgs/torrust/projects/10/views/6>
@@ -274,3 +292,5 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D
274292
[Naim A.]: https://github.com/naim94a/udpt
275293
[greatest-ape]: https://github.com/greatest-ape/aquatic
276294
[Power2All]: https://github.com/power2all
295+
[torrust-demo]: https://github.com/torrust/torrust-demo
296+
[prometheus]: https://prometheus.io/
254 KB
Loading

0 commit comments

Comments
 (0)