diff --git a/README.md b/README.md index b921cab..5a01ba9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# {{Service}} with Tailscale Integration +# Prometheus with Tailscale Integration -![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}") +![Prometheus with Tailscale](https://prometheus.io/assets/prometheus_logo_grey.svg "Prometheus") -This project sets up a {{Service}} instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your {{Service}} instance using Tailscale. +This project sets up a Prometheus instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Prometheus instance using Tailscale. ## Prerequisites @@ -12,21 +12,24 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using ## Project Structure ``` -ts-{{service}}/ +ts-prometheus/ ├── docker-compose.yml ├── tailscale/ -│ ├── tailscale-data/ # Persistent Tailscale state -│ └── config/ # Tailscale configuration files -└── {{service}}/ - └── config/ # {{service}} configuration files +│ ├── tailscale-data/ # Persistent Tailscale state +│ └── config/ # Tailscale configuration files +└── prometheus/ + ├── prometheus/ + │ └── etc/ + │ └── prometheus/ # Prometheus configuration files + └── data/ # Prometheus data ``` ## Setup Instructions 1. **Clone the Repository** ```bash - git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} - cd ts-{{service}} + git clone https://gitea.damconsulting.llc/DAM/ts-prometheus + cd ts-prometheus ``` 2. Create Required Directories ```bash @@ -37,8 +40,8 @@ ts-{{service}}/ - Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations - CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet -4. Configure {{Service}} - - See {{service_docs}} for configuration options +4. Configure Prometheus `/prometheus/etc/prometheus/prometheus.yml` + - See https://prometheus.io/docs/prometheus/latest/configuration/configuration/ for configuration options 5. Start the Services ```bash @@ -51,26 +54,26 @@ ts-{{service}}/ ## Services -### {{service}}-ts (Tailscale) +### prometheus-ts (Tailscale) - Runs Tailscale VPN client - Image: tailscale/tailscale:latest -- Container name: {{service}}-ts -- Hostname: {{service}} +- Container name: prometheus-ts +- Hostname: prometheus - Requires NET_ADMIN and SYS_MODULE capabilities - Persists state in ./tailscale/tailscale-data - Uses configuration from ./tailscale/config -### {{service}} +### prometheus -- Depends on {{service}}-ts service +- Depends on prometheus-ts service ## Usage -- After starting the services your service should be available via tailnet at `https://{{service}}.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://{{service}}.tail12345.ts.net/` +- After starting the services your service should be available via tailnet at `https://prometheus.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://prometheus.tail12345.ts.net/` - To manually get the Tailscale IP/hostname of your container: ```bash - docker logs {{service}}-ts + docker logs prometheus-ts ``` Look for the Tailscale IP address in the logs. @@ -79,7 +82,7 @@ ts-{{service}}/ - Uncomment and adjust the ports mapping if you need direct access (without Tailscale): ```yaml ports: - - 3000:3000 + - 9000:9000 ``` - Stopping the Services ```bash @@ -89,19 +92,18 @@ ts-{{service}}/ ## Troubleshooting - Check container logs: ```bash - docker logs {{service}}-ts - docker logs {{service}} + docker logs prometheus-ts + docker logs prometheus ``` - Ensure your Tailscale auth key is valid and not expired - Verify the configuration files have proper permissions - Make sure required directories exist before starting ## Notes -- The {{Service}} service uses the Tailscale service's network stack via `network_mode: service:{{service}}-ts` +- The Prometheus service uses the Tailscale service's network stack via `network_mode: service:prometheus-ts` - Direct port mapping is disabled by default as Tailscale handles the networking - Services restart automatically unless explicitly stopped - For more information: - Tailscale documentation: https://tailscale.com/kb/ - - {{Service}} documentation: {{service_docs}} - - {{Service}} repository: {{service_repo}} - - {{Service}} linuxserve.io: {{service_lcsr}} \ No newline at end of file + - Prometheus documentation: https://prometheus.io/docs/introduction/overview/ + - Prometheus repository: https://github.com/prometheus/prometheus \ No newline at end of file