# DockTail

DockTail automatically exposes Docker containers as Tailscale Services using label-based configuration. It watches Docker containers, reads `docktail.*` labels, and advertises matching containers through the local Tailscale daemon.

## Primary URLs

- Homepage: https://docktail.org/
- Human documentation: https://docktail.org/docs/
- Markdown documentation: https://docktail.org/docs.md
- Source code: https://github.com/marvinvr/docktail
- Container image: ghcr.io/marvinvr/docktail:latest

## What DockTail Does

- Discovers labeled Docker containers.
- Proxies directly to container IPs by default, so exposed app containers do not need published Docker ports.
- Creates or advertises Tailscale Services for HTTP, HTTPS, TCP, and TLS-terminated TCP.
- Supports Tailscale HTTPS automatic certificates.
- Supports Tailscale Funnel for public internet exposure.
- Supports multiple Tailscale services from a single container.
- Reconciles service state when containers restart and IPs change.

## Most Important Labels

- `docktail.service.enable=true`: enable a private Tailscale service for the container.
- `docktail.service.name`: Tailscale service name, such as `web` or `api`.
- `docktail.service.port`: backend container port.
- `docktail.service.protocol`: backend protocol, defaulting to HTTP unless the backend port implies HTTPS.
- `docktail.service.service-port`: Tailscale-facing port.
- `docktail.service.service-protocol`: Tailscale-facing protocol.
- `docktail.service.direct`: whether to proxy directly to the container IP. Defaults to `true`.
- `docktail.service.network`: Docker network used for direct container IP detection. Defaults to `bridge`.
- `docktail.tags`: comma-separated service tags. Defaults to `tag:container`.
- `docktail.funnel.enable=true`: enable Tailscale Funnel.
- `docktail.funnel.port`: backend container port for Funnel.
- `docktail.funnel.funnel-port`: public Funnel port. Defaults to `443`.

## Recommended Reading Order For Agents

1. Read `https://docktail.org/docs.md` for the clean Markdown version.
2. Use `https://docktail.org/docs/#quick-start` for the minimal Docker Compose example.
3. Use `https://docktail.org/docs/#configuration` for OAuth, API key, and manual modes.
4. Use `https://docktail.org/docs/#labeling` and `https://docktail.org/docs/#reference` for labels and environment variables.