Michael.McGuire/ts-smokeping
1
0
Fork 0
forked from DAM/ts-smokeping
Code Pull Requests Activity

done

Browse Source
This commit is contained in:
worker1 2025-06-25 21:56:33 -04:00
parent d2d52f607d
commit 51f87b4811
3 changed files with 50 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration # SmokePing with Tailscale Integration
![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}") ![SmokePing with Tailscale](https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_5ca8465f5b01fc1048c47aba6f79b6c6/smokeping.png "SmokePing")
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 SmokePing instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your SmokePing instance using Tailscale.
## Prerequisites ## Prerequisites
@ -12,33 +12,37 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-smokeping/
├── docker-compose.yml ├── docker-compose.yml
├── tailscale/ ├── tailscale/
│ ├── tailscale-data/ # Persistent Tailscale state │ ├── tailscale-data/ # Persistent Tailscale state
│ └── config/ # Tailscale configuration files │ └── config/ # Tailscale configuration files
└── {{service}}/ └── smokeping/
└── config/ # {{Service}} configuration files ├── data/ # SmokePing data files
└── config/ # SmokePing configuration files
``` ```
## Setup Instructions ## Setup Instructions
1. **Clone the Repository** 1. **Clone the Repository**
```bash ```bash
git clone https://gitea.damconsulting.llc/DAM/ts-{{service}} git clone https://gitea.damconsulting.llc/DAM/ts-smokeping.git
cd ts-{{service}} cd ts-smokeping
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
mkdir -p tailscale/tailscale-data mkdir -p tailscale/tailscale-data
mkdir -p smokeping/data
mkdir -p smokeping/config
``` ```
3. Configure Tailscale 3. Configure Tailscale
- Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key - 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 - 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 SmokePing
- See the [documentation]({{service_docs}}) for configuration options - See the [documentation](https://oss.oetiker.ch/smokeping/doc/smokeping_cgi.en.html) for configuration options
- Linux Server IO Docker [Config](https://docs.linuxserver.io/images/docker-smokeping/#usage)
5. Start the Services 5. Start the Services
```bash ```bash
@ -48,30 +52,30 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m] 6. Wait for Certificate to propagate [~2m]
7. Login 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://smokeping.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://smokeping.tail12345.ts.net/
## Services ## Services
### {{service}}-ts (Tailscale) ### smokeping-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: smokeping-ts
- Hostname: {{service}} - Hostname: smokeping
- Requires NET_ADMIN and SYS_MODULE capabilities - Requires NET_ADMIN and SYS_MODULE capabilities
- Persists state in ./tailscale/tailscale-data - Persists state in ./tailscale/tailscale-data
- Uses configuration from ./tailscale/config - Uses configuration from ./tailscale/config
### {{service}} ### smokeping
- Depends on {{service}}-ts service - Depends on smokeping-ts service
## Usage ## 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://smokeping.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://smokeping.tail12345.ts.net/`
- To manually get the Tailscale IP/hostname of your container: - To manually get the Tailscale IP/hostname of your container:
```bash ```bash
docker logs {{service}}-ts docker logs smokeping-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@ -80,7 +84,7 @@ ts-{{service}}/
- Uncomment and adjust the ports mapping if you need direct access (without Tailscale): - Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
```yaml ```yaml
ports: ports:
- 3000:3000 - 80:80
``` ```
- Stopping the Services - Stopping the Services
```bash ```bash
@ -90,19 +94,18 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs smokeping-ts
docker logs {{service}} docker logs smokeping
``` ```
- 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 SmokePing service uses the Tailscale service's network stack via `network_mode: service:smokeping-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}}) - SmokePing [documentation](https://oss.oetiker.ch/smokeping/doc/smokeping_cgi.en.html)
- {{Service}} [repository]({{service_repo}}) - SmokePing [repository](https://github.com/linuxserver/docker-documentation)
- {{Service}} [linuxserve.io]({{service_lcsr}})

27
docker-compose.yml
View File

@ -1,8 +1,8 @@
services: services:
{{service}}-ts: smokeping-ts:
image: tailscale/tailscale:latest image: tailscale/tailscale:latest
hostname: {{service}} hostname: smokeping
container_name: {{service}}-ts container_name: smokeping-ts
environment: environment:
- TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}} - TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}}
- TS_STATE_DIR=/var/lib/tailscale - TS_STATE_DIR=/var/lib/tailscale
@ -15,7 +15,22 @@ services:
- net_admin - net_admin
- sys_module - sys_module
restart: unless-stopped restart: unless-stopped
{{service-compose}} smokeping:
network_mode: service:{{service}}-ts image: lscr.io/linuxserver/smokeping:latest
container_name: smokeping
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- MASTER_URL=http://127.0.0.1:80/smokeping/ #optional
- SHARED_SECRET=password #optional
- CACHE_DIR=/tmp #optional
volumes:
- ./smokeping/config:/config
- ./smokeping/data:/data
# ports:
# - 80:80
restart: unless-stopped
network_mode: service:smokeping-ts
depends_on: depends_on:
- {{service}}-ts - smokeping-ts

2
tailscale/config/serve.json
View File

@ -8,7 +8,7 @@
"${TS_CERT_DOMAIN}:443": { "${TS_CERT_DOMAIN}:443": {
"Handlers": { "Handlers": {
"/": { "/": {
"Proxy": "http://127.0.0.1:3000" "Proxy": "http://127.0.0.1:80"
} }
} }
} }