From 66f5d12992c3f66e8fe2d537c4c0431df2964965 Mon Sep 17 00:00:00 2001 From: peskyadmin Date: Tue, 8 Apr 2025 21:19:38 -0500 Subject: [PATCH] update template for case --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 133fd40..a02c238 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# {{service}} with Tailscale Integration +# {{Service}} with Tailscale Integration -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. +![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}") + +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. ## Prerequisites @@ -23,8 +25,8 @@ ts-{{service}}/ 1. **Clone the Repository** ```bash - git clone - cd + git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} + cd ts-{{service}} ``` 2. Create Required Directories ```bash @@ -35,7 +37,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 {{Service}} - See {{service_docs}} for configuration options 5. Start the Services @@ -45,7 +47,7 @@ ts-{{service}}/ 6. Wait for Certificate to propagate [~2m] -7. Login with default credentials `usr:admin` `pwd:admin` +7. Login ## Services @@ -97,12 +99,13 @@ ts-{{service}}/ - 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 {{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/ - - {{service}} documentation: {{service_docs}} - - {{service}} repository: {{service_repo}} - - {{service}} linuxserve.io: {{service_lcsr}} \ No newline at end of file + - {{Service}} documentation: {{service_docs}} + - {{Service}} repository: {{service_repo}} + - {{Service}} linuxserve.io: {{service_lcsr}} \ No newline at end of file