Compare commits

..

3 Commits

Author SHA1 Message Date
45b94abdc8 basic readme 2025-11-03 15:26:14 -05:00
bb136a230b day0 2025-11-03 15:21:27 -05:00
30e3b793aa git ignore 2025-11-03 15:18:01 -05:00
3 changed files with 68 additions and 30 deletions

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
tailscale-data/
db/

View File

@@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration # Umami with Tailscale Integration
![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}") ![Umami with Tailscale](https://camo.githubusercontent.com/5d971e061b6433fcd75a0b29f0cf4e4dfd2c8a1ec93a85ff69fcad58145f52b8/68747470733a2f2f636f6e74656e742e756d616d692e69732f776562736974652f696d616765732f756d616d692d6c6f676f2e706e67 "Umami")
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 Umami instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Umami instance using Tailscale.
## Prerequisites ## Prerequisites
@@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-umami/
├── 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}}/ └── umami/
└── config/ # {{Service}} configuration files └── db/ # Umami database 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-umami
cd ts-{{service}} cd ts-umami
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
@@ -37,8 +37,8 @@ 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 Umami
- See the [documentation]({{service_docs}}) for configuration options - See the [documentation](https://umami.is/docs) for configuration options
5. Start the Services 5. Start the Services
```bash ```bash
@@ -48,30 +48,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://umami.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://umami.tail12345.ts.net/
## Services ## Services
### {{service}}-ts (Tailscale) ### umami-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: umami-ts
- Hostname: {{service}} - Hostname: umami
- 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}} ### umami
- Depends on {{service}}-ts service - Depends on umami-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://umami.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://umami.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 umami-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@@ -90,19 +90,18 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs umami-ts
docker logs {{service}} docker logs umami
``` ```
- 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 Umami service uses the Tailscale service's network stack via `network_mode: service:umami-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}}) - Umami [documentation](https://umami.is/docs)
- {{Service}} [repository]({{service_repo}}) - Umami [repository](https://github.com/umami-software/umami)
- {{Service}} [linuxserve.io]({{service_lcsr}})

View File

@@ -1,21 +1,58 @@
services: services:
{{service}}-ts: umami-ts:
image: tailscale/tailscale:latest image: tailscale/tailscale:latest
hostname: {{service}} hostname: umami
container_name: {{service}}-ts container_name: umami-ts
environment: environment:
- TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}} - TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}}
- TS_STATE_DIR=/var/lib/tailscale - TS_STATE_DIR=/var/lib/tailscale
- TS_SERVE_CONFIG=/config/serve.json - TS_SERVE_CONFIG=/config/serve.json
- TS_EXTRA_ARGS=--login-server=https://controlplane.tailscale.com
volumes: volumes:
- ./tailscale/tailscale-data:/var/lib/tailscale - ./tailscale/tailscale-data:/var/lib/tailscale
- ./tailscale/config:/config - ./tailscale/config:/config
- /dev/net/tun:/dev/net/tun - /dev/net/tun:/dev/net/tun
ports:
- '3000:3000'
cap_add: cap_add:
- net_admin - net_admin
- sys_module - sys_module
restart: unless-stopped restart: unless-stopped
{{service-compose}} umami:
network_mode: service:{{service}}-ts image: ghcr.io/umami-software/umami:postgresql-latest
# ports:
# - '3000:3000'
environment:
DATABASE_URL: postgresql://umami:umami@localhost:5432/umami
DATABASE_TYPE: postgresql
APP_SECRET: replace-me-with-a-random-string
depends_on:
db:
condition: service_healthy
umami-ts:
condition: service_started
init: true
restart: always
healthcheck:
test: ['CMD-SHELL', 'curl http://localhost:3000/api/heartbeat']
interval: 5s
timeout: 5s
retries: 5
network_mode: service:umami-ts
db:
image: postgres:15-alpine
environment:
POSTGRES_DB: umami
POSTGRES_USER: umami
POSTGRES_PASSWORD: umami
volumes:
- ./umami/db:/var/lib/postgresql/data
restart: always
healthcheck:
test: ['CMD-SHELL', 'pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}']
interval: 5s
timeout: 5s
retries: 5
network_mode: service:umami-ts
depends_on: depends_on:
- {{service}}-ts - umami-ts