These pages are published, with search, at https://matchory.github.io/tslink/. They read the same here on GitHub. New to tslink? Start with the tutorial.
- Getting started: install tslink on one host, and open a container over HTTPS from your tailnet.
How to get one task done.
- Install and upgrade tslink: install the plugin, upgrade it safely, and change its settings.
- Provision a host: get a host ready for production, on its own or as a Swarm node.
- Deploy on Swarm: give each stack its own tags and credential.
- Expose a service: serve a container over HTTPS, and put replicas behind a Tailscale Service.
- Update without downtime: roll out versions, restart Docker and upgrade tslink without dropping requests.
- Monitor tslink: get an alert when a node isn't running.
- Troubleshoot: find the cause of a symptom.
Every fact about one interface, to look up.
- Network options: the options of
docker network create. - Container labels: what a container can configure.
- Plugin settings: the settings of
docker plugin set. - Credentials: credential types, precedence, ephemeral nodes and tag rules.
- Readiness endpoint: the endpoint for Docker healthchecks.
- Files and paths: the data directory, logs and status files.
- tslink diag: diagnostics and the preflight check.
Why tslink works the way it does.
- Architecture: how a container becomes a node of its own.
- Security model: how tslink keeps stacks apart, and whom you have to trust.
- HTTPS certificates: how certificates are shared, and Let's Encrypt's limits.
- Limitations: what tslink can't do, and why.
CONTRIBUTING.md covers building, testing and releasing tslink, and how these pages are published. The style guide says how to write them, testing and releasing describe the test suites and the release checklist, and specs hold the design history. Security reports go through SECURITY.md; every release's changes are in the changelog.