Quick Start

Get started with Trapdoor in under a minute.

1. Install

macOS/Linux

curl -fsSL https://trapdoor.sh/install.sh | sh

Windows

irm https://trapdoor.sh/install.ps1 | iex

2. Start Your Local Server

Make sure you have a local server running. For example:

# Python
python -m http.server 8080

# Node.js
npx serve -p 8080

# Or your own app
npm run dev

3. Open the Trapdoor

trapdoor 8080

You'll see output like:

Tunnel established!
  Tunnel ID:  abc123
  Public URL: https://abc123.trapdoor.sh
  Forwarding: https://abc123.trapdoor.sh -> http://localhost:8080

Press Ctrl+C to stop

4. Share Your URL

Your local server is now accessible at https://abc123.trapdoor.sh from anywhere in the world!

Custom Subdomain

Want a memorable URL? Add a name:

trapdoor 8080 myapp

This gives you https://myapp.trapdoor.sh.

Next Steps

• Installation - Detailed installation instructions
• Configuration - All available options
• Webhooks - Test webhooks locally