Update README.md

This commit is contained in:
peskyadmin 2025-04-13 11:07:16 -05:00
parent 97a46e770c
commit 483bef31a4

View File

@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration
# Gitea Action Runner with Tailscale Integration
![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}")
![Gitea Action Runner with Tailscale](https://jellyfin.org/images/logo.svg "Gitea Action Runner")
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 Gitea Action Runner instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Gitea Action Runner instance using Tailscale.
## Prerequisites
@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure
```
ts-{{service}}/
ts-gitea-act-runner/
├── docker-compose.yml
├── tailscale/
│ ├── tailscale-data/ # Persistent Tailscale state
│ └── config/ # Tailscale configuration files
└── {{service}}/
└── config/ # {{service}} configuration files
└── gitea-act-runner/
└── config/ # gitea-act-runner configuration files
```
## Setup Instructions
1. **Clone the Repository**
```bash
git clone https://gitea.damconsulting.llc/DAM/ts-{{service}}
cd ts-{{service}}
git clone https://gitea.damconsulting.llc/DAM/ts-gitea-act-runner
cd ts-gitea-act-runner
```
2. Create Required Directories
```bash
@ -37,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 Gitea Action Runner
- See {{service_docs}} for configuration options
5. Start the Services
@ -48,30 +48,30 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m]
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://gitea-act-runner.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://gitea-act-runner.tail12345.ts.net/
## Services
### {{service}}-ts (Tailscale)
### gitea-act-runner-ts (Tailscale)
- Runs Tailscale VPN client
- Image: tailscale/tailscale:latest
- Container name: {{service}}-ts
- Hostname: {{service}}
- Container name: gitea-act-runner-ts
- Hostname: gitea-act-runner
- Requires NET_ADMIN and SYS_MODULE capabilities
- Persists state in ./tailscale/tailscale-data
- Uses configuration from ./tailscale/config
### {{service}}
### gitea-act-runner
- Depends on {{service}}-ts service
- Depends on gitea-act-runner-ts service
## 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://gitea-act-runner.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://gitea-act-runner.tail12345.ts.net/`
- To manually get the Tailscale IP/hostname of your container:
```bash
docker logs {{service}}-ts
docker logs gitea-act-runner-ts
```
Look for the Tailscale IP address in the logs.
@ -90,19 +90,18 @@ ts-{{service}}/
## Troubleshooting
- Check container logs:
```bash
docker logs {{service}}-ts
docker logs {{service}}
docker logs gitea-act-runner-ts
docker logs gitea-act-runner
```
- 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 Gitea Action Runner service uses the Tailscale service's network stack via `network_mode: service:gitea-act-runner-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}}
- Gitea Action Runner documentation: https://docs.gitea.com/usage/actions/quickstart
- Gitea Action Runner repository: https://gitea.com/gitea/act_runner