DAM/ts-mosquitto
1
0
Fork 0
generated from DAM/ts-TEMPLATE
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

manual init

Browse Source
This commit is contained in:
peskyadmin 2025-04-15 20:42:05 -05:00
parent cdbd392d08
commit be18411950
1 changed files with 41 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -1,8 +1,8 @@
# {{Service}} with Tailscale Integration # Mosquitto with Tailscale Integration
![{{Service}} with Tailscale](https://jellyfin.org/images/logo.svg "{{Service}}") ![Mosquitto with Tailscale](https://jellyfin.org/images/logo.svg "Mosquitto")
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 Mosquitto instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Mosquitto instance using Tailscale.
## Prerequisites ## Prerequisites
@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
## Project Structure ## Project Structure
``` ```
ts-{{service}}/ ts-mosquitto/
├── 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}}/ └── mosquitto/
└── config/ # {{service}} configuration files └── config/ # mosquitto 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-mosquitto
cd ts-{{service}} cd ts-mosquitto
``` ```
2. Create Required Directories 2. Create Required Directories
```bash ```bash
@ -37,8 +37,9 @@ 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 Mosquitto
- See {{service_docs}} for configuration options - A minimal config is provided in `/mosquitto/config/mosquitto.conf`
- See official [documentation](https://mosquitto.org/documentation/) for more configuration options (recomended for production)
5. Start the Services 5. Start the Services
```bash ```bash
@ -47,31 +48,30 @@ ts-{{service}}/
6. Wait for Certificate to propagate [~2m] 6. Wait for Certificate to propagate [~2m]
7. Login 7. Connect with your preferred client
- 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/
## Services ## Services
### {{service}}-ts (Tailscale) ### mosquitto-ts (Tailscale)
- Runs Tailscale VPN client - Runs Tailscale VPN client
- Image: tailscale/tailscale:latest - Image: tailscale/tailscale:latest
- Container name: {{service}}-ts - Container name: mosquitto-ts
- Hostname: {{service}} - Hostname: mosquitto
- 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}} ### mosquitto
- Depends on {{service}}-ts service - Depends on mosquitto-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://mosquitto.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://mosquitto.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 mosquitto-ts
``` ```
Look for the Tailscale IP address in the logs. Look for the Tailscale IP address in the logs.
@ -80,7 +80,8 @@ 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 - 1883:1883
- 8883:8883
``` ```
- Stopping the Services - Stopping the Services
```bash ```bash
@ -90,19 +91,32 @@ ts-{{service}}/
## Troubleshooting ## Troubleshooting
- Check container logs: - Check container logs:
```bash ```bash
docker logs {{service}}-ts docker logs mosquitto-ts
docker logs {{service}} docker logs mosquitto
``` ```
- 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
## Service Port details
- 1883 : MQTT, unencrypted, unauthenticated
- 1884 : MQTT, unencrypted, authenticated
- 8883 : MQTT, encrypted, unauthenticated
- 8884 : MQTT, encrypted, client certificate required
- 8885 : MQTT, encrypted, authenticated
- 8886 : MQTT, encrypted, unauthenticated
- 8887 : MQTT, encrypted, server certificate deliberately expired
- 8080 : MQTT over WebSockets, unencrypted, unauthenticated
- 8081 : MQTT over WebSockets, encrypted, unauthenticated
- 8090 : MQTT over WebSockets, unencrypted, authenticated
- 8091 : MQTT over WebSockets, encrypted, authenticated
## Notes ## Notes
- The {{Service}} service uses the Tailscale service's network stack via `network_mode: service:{{service}}-ts` - The Mosquitto service uses the Tailscale service's network stack via `network_mode: service:mosquitto-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}} - Mosquitto [documentation](https://mosquitto.org/documentation/)
- {{Service}} repository: {{service_repo}} - Mosquitto [repository](https://github.com/eclipse-mosquitto/mosquitto)
- {{Service}} linuxserve.io: {{service_lcsr}} - A [helpful article](https://crodrigues.com/setting-up-a-secure-mosquitto-mqtt-broker-with-ssl-tls-and-user-access-control-mqtt-series-2/)