https://github.com/almeidapaulopt/tsdproxy
Tailscale Docker Proxy
https://github.com/almeidapaulopt/tsdproxy
docker go proxy self-hosted tailscale vpn
Last synced: about 1 month ago
JSON representation
Tailscale Docker Proxy
- Host: GitHub
- URL: https://github.com/almeidapaulopt/tsdproxy
- Owner: almeidapaulopt
- License: mit
- Created: 2024-10-07T08:57:00.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-05-05T14:40:54.000Z (about 1 month ago)
- Last Synced: 2025-05-05T15:55:47.865Z (about 1 month ago)
- Topics: docker, go, proxy, self-hosted, tailscale, vpn
- Language: Go
- Homepage: https://almeidapaulopt.github.io/tsdproxy/
- Size: 886 KB
- Stars: 928
- Watchers: 11
- Forks: 39
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# TsDProxy - Tailscale Proxy
TsDProxy simplifies the process of securely exposing services and Docker containers
to your Tailscale network by automatically creating Tailscale machines for each
tagged container. This allows services to be accessible via unique, secure URLs
without the need for complex configurations or additional Tailscale containers.
## Version 2
Version 2 is already in beta. Please try and open issues if bugs detected.
Some configurations of Version 1.x are deprecated or changed please verify it in
[Documentation changelog](https://almeidapaulopt.github.io/tsdproxy/docs/changelog/).
Because of some breaking changes, final version 2 arrive will not set as latest
Docker image. We will wait some weeks to give you time to update.
Version 1 will not get new features.
## Full Documentation
- [Official Documentation](https://almeidapaulopt.github.io/tsdproxy/)
## Breaking Changes
Please read the [Documentation changelog](https://almeidapaulopt.github.io/tsdproxy/docs/changelog/)
for details.
## Help needed
Please help with documentation, tests development, new features, bug fixes.
If you don't feel comfortable to this kind of tasks, [sponsor](https://github.com/sponsors/almeidapaulopt)
the project.
## Docker Images
1. almeidapaulopt/tsdproxy:vx.x.x - Version x.x.x
2. almeidapaulopt/tsdproxy:1 - Latest release of version 1.x.x
3. almeidapaulopt/tsdproxy:2 - Latest release of version 2.x.x (beta)
4. almeidapaulopt/tsdproxy:latest - Latest stable
5. almeidapaulopt/tsdproxy:dev - Latest Development Build
## Core Functionality
- **Automatic Tailscale Machine Creation**: For each Docker container tagged
with the appropriate labels, TsDProxy creates a new Tailscale machine.
- **Default Serving**: By default, each service is accessible via
`https://{machine-name}.funny-name.ts.net`, where `{machine-name}` is derived
from your container name or custom label.
## Key Features
- **Simplified Networking**: Eliminates the need for a separate Tailscale
container for each service.
- **Label-Based Configuration**: Easy setup using Docker container labels.
- **Automatic HTTPS**: Leverages Tailscale's built-in LetsEncrypt certificate support.
- **Flexible Protocol Support**: Handles HTTP and HTTPS traffic (defaulting to HTTPS).
- **Lightweight Architecture**: Efficient, Docker-based design for minimal overhead.
## How It Works
TsDProxy operates by creating a seamless integration between your Docker
containers and Tailscale network:
1. **Container Scanning**: TsDProxy continuously monitors your Docker
environment for containers with the `tsdproxy.enable=true` label.
2. **Tailscale Machine Creation**: When a tagged container is detected, TsDProxy
automatically creates a new Tailscale machine for that container.
3. **Hostname Assignment**: The Tailscale machine is assigned a hostname based
on the `tsdproxy.name` label or the container's name.
4. **Port Mapping**: TsDProxy maps the container's internal port to the Tailscale
machine.
5. **Traffic Routing**: Incoming requests to the Tailscale machine are routed to
the appropriate Docker container and port.
6. **Dynamic Management**: As containers start and stop, TsDProxy automatically
creates and removes the corresponding Tailscale machines and routing configurations.
## Requirements
Before using this application, make sure you have:
- [Tailscale](https://tailscale.com/) installed and configured on your host machine.
- [Docker](https://www.docker.com/) installed and running.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
for details.
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to help improve the app.