Tailscale for DDEV: Simple and Secure Project Sharing

I’ve found that DDEV’s ddev share command is a great way to quickly share my local development environment. However, since it uses ngrok, it generates a new, random URL every time unless you use a stable domain. As an alternative, I’ve created the ddev-tailscale-router add-on.

This add-on uses Tailscale, a VPN service that creates a private and secure network between your devices. It is free for personal use!

As a result, you get a stable, human-readable URL for each of your DDEV projects, which you can access from any device on your Tailscale network.

I’ve found this approach to be particularly useful for:

Cross-device testing: I can easily test my sites on my phone or tablet without being on the same Wi-Fi network.
Stable webhook URLs: I can use the permanent Tailscale URL as a reliable endpoint for webhooks, such as those from payment gateways.
Team collaboration: I can share my development environment with team members so they can see my work in progress.

How it Works

The ddev-tailscale-router add-on works by running a Tailscale container alongside your DDEV project. This container automatically connects to your Tailscale network and securely proxies requests to your project’s web container.

Prerequisites

Before installing the add-on, you need to set up Tailscale:

Install Tailscale on at least two devices (phone, tablet, or computer) by following the installation guide. This is required to generate an auth key.
Enable HTTPS by following the Tailscale HTTPS documentation. This is required for TLS certificate generation.
Generate an auth key by following the Tailscale auth keys documentation. Ephemeral, reusable keys are recommended.

Installation

To get started, follow these steps:

First, set up your auth key (recommended approach): Add the auth key to your shell environment:
```
echo 'export TS_AUTHKEY=tskey-auth-your-key-here' >> ~/.bashrc
source ~/.bashrc
```
Replace ~/.bashrc with ~/.zshrc if you use Zsh, or your relevant shell configuration file.

Alternatively, you can set it per project (NOT RECOMMENDED, because .ddev/.env.tailscale-router is not intended to store secrets):
```
ddev dotenv set .ddev/.env.tailscale-router --ts-authkey=tskey-auth-your-key-here
```

Next, install the add-on:

ddev add-on get atj4me/ddev-tailscale-router

Finally, restart DDEV:
```
ddev restart
```

Using Your Tailscale URL

Once installation is complete, you can access your project using these commands:

Launch your project’s Tailscale URL in browser:

ddev tailscale launch

Get your project’s Tailscale URL:

ddev tailscale url

Your project’s permanent Tailscale URL will look like: https://<project-name>.<your-tailnet>.ts.net. You can also find it in your Tailscale admin console.

Public vs. Private Mode

The add-on offers two modes for sharing your project:

Private (default): Your project is only accessible to devices on your Tailscale network.
Public: Your project is accessible to anyone on the internet.

To switch between modes:

Switch to public mode (accessible to anyone on the internet):

ddev dotenv set .ddev/.env.tailscale-router --ts-privacy=public
ddev restart

Switch back to private mode (default):

ddev dotenv set .ddev/.env.tailscale-router --ts-privacy=private
ddev restart

Note: For public access, you need to configure your Access Control List (ACL) to enable Funnel. See the Tailscale Funnel documentation for details on setting up the required ACL policy.

I hope this add-on helps streamline your development workflow! If you run into any issues or have suggestions for improvements, feel free to open an issue on the GitHub repository.

Additional Resources

Here are some additional resources that you might find helpful:

Tailscale: A VPN service that creates a private and secure network between your devices.
Tailscale Download: Installation guide for Tailscale on various platforms.
Tailscale: Enabling HTTPS: Official documentation on enabling HTTPS for TLS certificate generation.
Tailscale Auth Keys: Detailed information about creating and managing auth keys.
Tailscale Funnel: Documentation on enabling public access to your Tailscale services.
Tailscale DNS: DNS in Tailscale
DDEV dotenv: Documentation on managing environment variables with DDEV.
DDEV Docs: Sharing: The official DDEV documentation on how to share your projects.
Medium: My Journey with PHP Dev Environments: A blog post on setting up a PHP development environment.
LinkedIn: The Day My Development Environment Nearly Broke Me: An article on the importance of a reliable development environment.

This blog post was written with the assistance of Amazon Q and Google Gemini. I used them to help simplify the language, improve the flow, and proofread the text.