DAM/ts-TEMPLATE
Template
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

update template for case

Browse Source
This commit is contained in:
peskyadmin 2025-04-08 21:19:38 -05:00
parent 9b0c43be65
commit 66f5d12992
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -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 ## Prerequisites
@ -23,8 +25,8 @@ ts-{{service}}/
1. **Clone the Repository** 1. **Clone the Repository**
```bash ```bash
git clone <repository-url> git clone https://gitea.damconsulting.llc/DAM/ts-{{service}}
cd <repository-name> cd ts-{{service}}
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
@ -35,7 +37,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 {{Service}}
- See {{service_docs}} for configuration options - See {{service_docs}} for configuration options
5. Start the Services 5. Start the Services
@ -45,7 +47,7 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m] 6. Wait for Certificate to propagate [~2m]
7. Login with default credentials `usr:admin` `pwd:admin` 7. Login
## Services ## Services
@ -97,12 +99,13 @@ ts-{{service}}/
- 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 {{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 - 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}} - {{Service}} documentation: {{service_docs}}
- {{service}} repository: {{service_repo}} - {{Service}} repository: {{service_repo}}
- {{service}} linuxserve.io: {{service_lcsr}} - {{Service}} linuxserve.io: {{service_lcsr}}