Skip to content

Add Tailscale reverse proxy example to README#1365

Open
thatwonguy wants to merge 2 commits into
element-hq:mainfrom
thatwonguy:feat/tailscale-reverse-proxy-example
Open

Add Tailscale reverse proxy example to README#1365
thatwonguy wants to merge 2 commits into
element-hq:mainfrom
thatwonguy:feat/tailscale-reverse-proxy-example

Conversation

@thatwonguy

Copy link
Copy Markdown

Closes #823. Relates to #341.

Adds a Tailscale configuration example to the "Example configurations" section of the reverse proxy documentation, covering the CGNAT use case for users hosting ESS for a private group of friends or family.

The example covers:

  • Prerequisites: tailnet membership for all users, domain name, DNS01 cert-manager challenge (required since port 80 is not publicly reachable)
  • Tailscale install steps
  • Nginx and Caddy configs bound to the Tailscale interface

Closes element-hq#823. Relates to element-hq#341.

Adds a Tailscale configuration example to the "Example configurations"
section of the reverse proxy documentation, covering the CGNAT use case
for users hosting ESS for a private group of friends or family.

The example covers:
- Prerequisites: tailnet membership for all users, domain name, DNS01
  cert-manager challenge (required since port 80 is not publicly reachable)
- Tailscale install steps
- Nginx and Caddy configs bound to the Tailscale interface
@thatwonguy thatwonguy requested a review from a team as a code owner May 31, 2026 07:37
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@gaelgatelement

Copy link
Copy Markdown
Member

Hello,

Thank you for your suggestion !

Why didn't you go with setting up tailscale in the k3s cluster, and profit from https://tailscale.com/docs/features/kubernetes-operator/how-to/cluster-ingress ?

This section being dedicated to external proxies, it seems a bit strange to mention tailscale in this context. It feels like it should be documented as an option in nginx/caddy configuration instead, where you would bind to specific addresses instead of all ips.

We'd be willing to take your contribution if you refactored the documentation accordingly.

Remember to sign the CLA to allow us to merge your contribution if you push forward.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ess-community with Tailscale

3 participants