DAM/ts-grafana
1
0
Fork 0
generated from DAM/ts-TEMPLATE
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

manual init

Browse Source
This commit is contained in:
peskyadmin 2025-04-14 20:26:37 -05:00
parent 59e5d56570
commit 67cf7c0a2a
1 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -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 ## Prerequisites
@ -12,21 +12,20 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-grafana/
├── docker-compose.yml ├── docker-compose.yml
├── tailscale/ ├── tailscale/
│ ├── tailscale-data/ # Persistent Tailscale state │ ├── tailscale-data/ # Persistent Tailscale state
│ └── config/ # Tailscale configuration files │ └── config/ # Tailscale configuration files
└── {{service}}/ └── grafana/ # Grafana configuration files
└── config/ # {{service}} configuration files
``` ```
## Setup Instructions ## Setup Instructions
1. **Clone the Repository** 1. **Clone the Repository**
```bash ```bash
git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} git clone https://gitea.damconsulting.llc/DAM/ts-grafana
cd ts-{{service}} cd ts-grafana
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
@ -37,7 +36,7 @@ ts-{{service}}/
- Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations - 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 - 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 - See {{service_docs}} for configuration options
5. Start the Services 5. Start the Services
@ -48,30 +47,30 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m] 6. Wait for Certificate to propagate [~2m]
7. Login 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 ## Services
### {{service}}-ts (Tailscale) ### grafana-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: grafana-ts
- Hostname: {{service}} - Hostname: grafana
- Requires NET_ADMIN and SYS_MODULE capabilities - Requires NET_ADMIN and SYS_MODULE capabilities
- Persists state in ./tailscale/tailscale-data - Persists state in ./tailscale/tailscale-data
- Uses configuration from ./tailscale/config - Uses configuration from ./tailscale/config
### {{service}} ### grafana
- Depends on {{service}}-ts service - Depends on grafana-ts service
## Usage ## 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: - To manually get the Tailscale IP/hostname of your container:
```bash ```bash
docker logs {{service}}-ts docker logs grafana-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@ -90,19 +89,18 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs grafana-ts
docker logs {{service}} docker logs grafana
``` ```
- Ensure your Tailscale auth key is valid and not expired - Ensure your Tailscale auth key is valid and not expired
- Verify the configuration files have proper permissions - Verify the configuration files have proper permissions
- Make sure required directories exist before starting - Make sure required directories exist before starting
## Notes ## 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 - Direct port mapping is disabled by default as Tailscale handles the networking
- Services restart automatically unless explicitly stopped - Services restart automatically unless explicitly stopped
- For more information: - For more information:
- Tailscale documentation: https://tailscale.com/kb/ - Tailscale documentation: https://tailscale.com/kb/
- {{Service}} documentation: {{service_docs}} - Grafana documentation: https://grafana.com/docs/grafana/latest/
- {{Service}} repository: {{service_repo}} - Grafana repository: https://github.com/grafana/grafana
- {{Service}} linuxserve.io: {{service_lcsr}}