DocsGetting StartedIntroduction

Introduction

ServerMe is an open-source tunneling platform that exposes your local servers to the internet.

ServerMe creates secure, encrypted tunnels from the public internet to your local machine. Think of it as an open-source alternative to ngrok — fully self-hostable with a generous free tier.

What can you do with ServerMe?

  • Share local work — Show a client your local site without deploying
  • Test webhooks — Receive Stripe, GitHub, or Slack webhooks on localhost
  • Expose APIs — Let teammates or CI hit your local API server
  • Debug mobile apps — Point your phone at a public URL that tunnels to your machine
  • Demo anything — Share a link to your localhost, instantly

How it works

code
Internet → ServerMe Server → Encrypted Tunnel (smux/TLS) → CLI → Your Local Service
  1. You run serverme http 3000 on your machine
  2. The CLI establishes an encrypted connection to the ServerMe server
  3. The server assigns a public URL like https://abc123.serverme.site
  4. Anyone visiting that URL gets routed through the tunnel to your local port 3000

Tunnel types

TypeCommandUse case
HTTPserverme http 3000Web apps, APIs, webhooks
TCPserverme tcp 5432Databases, game servers, SSH
TLSserverme tls 443TLS passthrough (no termination)

Key features

  • Request inspection — View every HTTP request in real-time at localhost:4040
  • Replay — Re-send any captured request with one click
  • Custom domains — Bring your own domain with automatic TLS
  • Google OAuth — Log in with your Google account
  • SDKs — JavaScript/TypeScript and Python
  • Self-hostable — Deploy your own server with one command
  • Open source — MIT licensed, all code on GitHub
NextQuickstart