|
|
- "description": "Open-source systems monitoring and alerting toolkit. Collects and stores metrics as time series data, with a powerful query language (PromQL) and integration with visualization tools like Grafana.\n## References\n- [Prometheus](https://prometheus.io/)\n- [Documentation](https://prometheus.io/docs/)\n- [GitHub](https://github.com/prometheus/prometheus)",
|
|
|
+ "guide": "## Overview\nOpen-source systems monitoring and alerting toolkit. Collects and stores metrics as time series data, with a powerful query language (PromQL) and integration with visualization tools like Grafana.\n\n## How to Use\nThis template renders `compose.yaml` as a file.\n\n1. Decide on service names, ports, volumes, credentials, and optional integrations before rendering the stack.\n2. Fill in the required variables first, then enable optional sections such as Traefik, metrics, or extra services only when needed.\n3. Render the Compose project, review the generated files, and start it with Docker Compose in the target directory.\n\n## Variable Guide\n### General\n- `service_name`: Service Name; optional; default: prometheus.\n- `restart_policy`: Restart Policy; required; default: unless-stopped; options: unless-stopped, always, on-failure, no.\n\n### Metrics & Storage\n- `metrics_retention_time`: How long to retain samples (e.g., 15d, 30d, 1y); optional; default: 15d.\n- `metrics_retention_size`: Maximum storage size (e.g., 5GB, 10GB, 1TB); optional; default: 0.\n- `metrics_enable_remote_write`: Enable remote write receiver (allows pushing metrics via /api/v1/write); optional; default: false.\n\n### Ports\n- `ports_http`: Ports Http; optional; default: 9090.\n\n### Traefik\n- `traefik_host`: Traefik Host; optional; default: prometheus.\n- `traefik_network`: Traefik Network; required; default: traefik.\n- `traefik_domain`: Traefik Domain; required; default: home.arpa.\n- `traefik_enabled`: Enable Traefik integration; optional; default: false.\n\n### Traefik TLS\n- `traefik_tls_certresolver`: Traefik Tls Certresolver; required; default: cloudflare.\n- `traefik_tls_enabled`: Enable Traefik TLS; optional; default: false.\n\n## References\n- [Prometheus](https://prometheus.io/)\n- [Documentation](https://prometheus.io/docs/)\n- [GitHub](https://github.com/prometheus/prometheus)",
|