diff --git a/README.md b/README.md index d2ada6a..a10e9e0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# {{Service}} with Tailscale Integration +# Grafana with Tailscale Integration -![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}") +![Grafana with Tailscale](https://github.com/grafana/grafana/raw/main/docs/logo-horizontal-dark.png#gh-dark-mode-only "Grafana") -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 Grafana instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Grafana instance using Tailscale. ## Prerequisites @@ -12,21 +12,20 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using ## Project Structure ``` -ts-{{service}}/ +ts-grafana/ ├── 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 +└── grafana/ # Grafana configuration files ``` ## 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-grafana + cd ts-grafana ``` 2. Create Required Directories ```bash @@ -37,7 +36,7 @@ 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}} +4. Configure Grafana - See {{service_docs}} for configuration options 5. Start the Services @@ -48,30 +47,30 @@ ts-{{service}}/ 6. Wait for Certificate to propagate [~2m] 7. Login - - 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://grafana.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://grafana.tail12345.ts.net/ ## Services -### {{service}}-ts (Tailscale) +### grafana-ts (Tailscale) - Runs Tailscale VPN client - Image: tailscale/tailscale:latest -- Container name: {{service}}-ts -- Hostname: {{service}} +- Container name: grafana-ts +- Hostname: grafana - Requires NET_ADMIN and SYS_MODULE capabilities - Persists state in ./tailscale/tailscale-data - Uses configuration from ./tailscale/config -### {{service}} +### grafana -- Depends on {{service}}-ts service +- Depends on grafana-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://grafana.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://grafana.tail12345.ts.net/` - To manually get the Tailscale IP/hostname of your container: ```bash - docker logs {{service}}-ts + docker logs grafana-ts ``` Look for the Tailscale IP address in the logs. @@ -90,19 +89,18 @@ ts-{{service}}/ ## Troubleshooting - Check container logs: ```bash - docker logs {{service}}-ts - docker logs {{service}} + docker logs grafana-ts + docker logs grafana ``` - 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 Grafana service uses the Tailscale service's network stack via `network_mode: service:grafana-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 + - Grafana documentation: https://grafana.com/docs/grafana/latest/ + - Grafana repository: https://github.com/grafana/grafana \ No newline at end of file