From 9c3513be6e2aebc26041a8c29b51a4d020fa0bb3 Mon Sep 17 00:00:00 2001 From: peskyadmin Date: Tue, 8 Apr 2025 16:36:45 -0500 Subject: [PATCH] remove all references of a service --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 130b1d0..782e304 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,14 @@ your-project/ ``` 2. Create Required Directories ```bash - mkdir -p tailscale/tailscale-data tailscale/config homepage/config + mkdir -p tailscale/tailscale-data ``` 3. Configure Tailscale - Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key - Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations 4. Configure {{service}} - - Add your Homepage configuration files to homepage/config/ - - See https://gethomepage.dev/latest/configs/ for configuration options - - The default setup allows all hosts (HOMEPAGE_ALLOWED_HOSTS: "*") + - See {{service_docs}} for configuration options 5. Start the Services ```bash @@ -50,8 +48,8 @@ your-project/ - Runs Tailscale VPN client - Image: tailscale/tailscale:latest -- Container name: homepage-ts -- Hostname: homepage +- Container name: {{service}}-ts +- Hostname: {{service}} - Requires NET_ADMIN and SYS_MODULE capabilities - Persists state in ./tailscale/tailscale-data - Uses configuration from ./tailscale/config @@ -71,7 +69,7 @@ your-project/ ## Optional Features -- Uncomment the Docker socket volume mapping in the Homepage service to enable Docker integrations: +- Uncomment the Docker socket volume mapping in the service to enable Docker integrations: ```yaml - /var/run/docker.sock:/var/run/docker.sock ``` @@ -95,9 +93,9 @@ your-project/ - Verify the configuration files have proper permissions - Make sure required directories exist before starting ## Notes -- The Homepage service uses the Tailscale service's network stack via network_mode: service:homepage-ts +- The {{service}} service uses the Tailscale service's network stack via network_mode: service:{{service}}-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/ -- Homepage documentation: https://gethomepage.dev/ +- {{service}} documentation: {{service_docs}}