Files

peskyadmin e71e6f8bf5 feat: improve template structure and documentation

- Add dual serve config (serve.json + serve.headscale.json)
- Add SECURITY.md with default passwords warning
- Add .env.example with clear REQUIRED / REFERENCE / CUSTOMIZE sections
- Rewrite README with clear Tailscale vs Headscale paths
- Harden .gitignore (env files, keys, Tailscale state)
- Update docker-compose.yml with clear section labels
- Make volume names service-specific ({{service}}-db-data)
- Ensure both db and app services depend on the Tailscale sidecar

2026-08-02 19:03:59 -04:00

2.0 KiB

Raw Blame History

{{Service}} with Tailscale Integration

This project sets up a {{Service}} instance with Tailscale VPN integration using Docker Compose.

Quick Start (Tailscale)

Copy the example environment file and fill in your values:
```
cp .env.example .env
```
Edit .env and set:
- TS_AUTHKEY — your Tailscale auth key
Start the stack:
```
docker compose up -d
```
Customize the app config per official documentation
Access {{Service}} at http://{{service}}.<your-tailnet>.ts.net

Headscale

If you're using Headscale instead of Tailscale:

Copy the example environment file:
```
cp .env.example .env
```
Edit .env and set:
- TS_AUTHKEY — your Headscale auth key
- TS_LOGIN_SERVER — your Headscale server URL

Switch to the Headscale serve config:

cp tailscale/config/serve.headscale.json tailscale/config/serve.json

Edit serve.json and replace {{service}}.example.com with your actual domain
Start the stack:
```
docker compose up -d
```
Customs the app config per official documentation
Access {{Service}} at http://{{service}}.yourdomain.com

Configuration

See .env.example for all available options.

Switching Serve Configs

Environment	File to use	Notes
Tailscale (default)	`tailscale/config/serve.json`	Supports HTTP + HTTPS with certs
Headscale	`tailscale/config/serve.headscale.json`	HTTP only

After changing the serve config, restart the sidecar:

docker compose restart {{service}}-ts

Optional: Direct Host Access

Uncomment the ports section in docker-compose.yml if you need direct access without Tailscale:

ports:
  - {{port}}:{{port}}

Links

put links to offical site, and git repo

2.0 KiB Raw Blame History