generated from DAM/ts-TEMPLATE
done
This commit is contained in:
parent
e75903d773
commit
e190554f02
48
README.md
48
README.md
@ -1,8 +1,8 @@
|
||||
# {{Service}} with Tailscale Integration
|
||||
# n8n 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.
|
||||
This project sets up a n8n instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your n8n instance using Tailscale.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -12,33 +12,34 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
|
||||
|
||||
## Project Structure
|
||||
```
|
||||
ts-{{service}}/
|
||||
ts-n8n/
|
||||
├── docker-compose.yml
|
||||
├── tailscale/
|
||||
│ ├── tailscale-data/ # Persistent Tailscale state
|
||||
│ └── config/ # Tailscale configuration files
|
||||
└── {{service}}/
|
||||
└── config/ # {{Service}} configuration files
|
||||
└── n8n/
|
||||
└── config/ # n8n 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-n8n
|
||||
cd ts-n8n
|
||||
```
|
||||
2. Create Required Directories
|
||||
```bash
|
||||
mkdir -p tailscale/tailscale-data
|
||||
mkdir -p n8n_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
|
||||
- CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet
|
||||
|
||||
4. Configure {{Service}}
|
||||
- See the [documentation]({{service_docs}}) for configuration options
|
||||
4. Configure n8n
|
||||
- See the [documentation](https://docs.n8n.io/?_gl=1*19afx3*_gcl_au*MjAxNDcxMjcxMi4xNzUwNzI3OTUy*_ga*NTQxOTAxNzE1LjE3NTA3Mjc5NTI.*_ga_0SC4FF2FH9*czE3NTA5MDQ5MzAkbzIkZzEkdDE3NTA5MDU0OTIkajMwJGwwJGgw) for configuration options
|
||||
|
||||
5. Start the Services
|
||||
```bash
|
||||
@ -48,30 +49,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://n8n.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://n8n.tail12345.ts.net/
|
||||
|
||||
## Services
|
||||
|
||||
### {{service}}-ts (Tailscale)
|
||||
### n8n-ts (Tailscale)
|
||||
|
||||
- Runs Tailscale VPN client
|
||||
- Image: tailscale/tailscale:latest
|
||||
- Container name: {{service}}-ts
|
||||
- Hostname: {{service}}
|
||||
- Container name: n8n-ts
|
||||
- Hostname: n8n
|
||||
- Requires NET_ADMIN and SYS_MODULE capabilities
|
||||
- Persists state in ./tailscale/tailscale-data
|
||||
- Uses configuration from ./tailscale/config
|
||||
|
||||
### {{service}}
|
||||
### n8n
|
||||
|
||||
- Depends on {{service}}-ts service
|
||||
- Depends on n8n-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://n8n.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://n8n.tail12345.ts.net/`
|
||||
- To manually get the Tailscale IP/hostname of your container:
|
||||
```bash
|
||||
docker logs {{service}}-ts
|
||||
docker logs n8n-ts
|
||||
```
|
||||
Look for the Tailscale IP address in the logs.
|
||||
|
||||
@ -90,19 +91,18 @@ ts-{{service}}/
|
||||
## Troubleshooting
|
||||
- Check container logs:
|
||||
```bash
|
||||
docker logs {{service}}-ts
|
||||
docker logs {{service}}
|
||||
docker logs n8n-ts
|
||||
docker logs n8n
|
||||
```
|
||||
- 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 n8n service uses the Tailscale service's network stack via `network_mode: service:n8n-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}})
|
||||
- n8n [documentation](https://docs.n8n.io/?_gl=1*19afx3*_gcl_au*MjAxNDcxMjcxMi4xNzUwNzI3OTUy*_ga*NTQxOTAxNzE1LjE3NTA3Mjc5NTI.*_ga_0SC4FF2FH9*czE3NTA5MDQ5MzAkbzIkZzEkdDE3NTA5MDU0OTIkajMwJGwwJGgw)
|
||||
- n8n [repository](https://github.com/n8n-io/n8n)
|
||||
@ -4,7 +4,7 @@ services:
|
||||
hostname: n8n
|
||||
container_name: n8n-ts
|
||||
environment:
|
||||
- TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}}
|
||||
- TS_AUTHKEY=tskey-auth-kGdib6Ws8S11CNTRL-DkDVMZivAxSn7jBFbBJ1ySn2xpSDqF4K
|
||||
- TS_STATE_DIR=/var/lib/tailscale
|
||||
- TS_SERVE_CONFIG=/config/serve.json
|
||||
volumes:
|
||||
@ -18,8 +18,8 @@ services:
|
||||
n8n:
|
||||
image: docker.n8n.io/n8nio/n8n
|
||||
container_name: n8n
|
||||
ports:
|
||||
- 5678:5678
|
||||
# ports:
|
||||
# - 5678:5678
|
||||
volumes:
|
||||
- ./n8n_data:/home/node/.n8n
|
||||
environment:
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
"${TS_CERT_DOMAIN}:443": {
|
||||
"Handlers": {
|
||||
"/": {
|
||||
"Proxy": "http://127.0.0.1:3000"
|
||||
"Proxy": "http://127.0.0.1:5678"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user