RimbraDocsDashboard

Tunnels

Put a server on your computer at a public HTTPS address with rimbra tunnel, for webhooks, demos and testing on your phone.

Install the CLI

On macOS and Linux, run the installer. It puts rimbra in /usr/local/bin, or ~/.local/bin when that isn’t writable. On Windows, download rimbra-windows-amd64.exe from the link below and run it from a terminal.

bash
curl -fsSL https://rimbra.app/install.sh | sh
rimbra version

Sign in with a tunnel token

  1. Open Tunnels in the dashboard sidebar and choose New token. Give it the name of the computer it’s for.
  2. Copy the token. It’s shown only once; Rimbra keeps only a hash of it.
  3. Run rimbra login and paste it. It’s saved in ~/.config/rimbra/config.json, readable only by you.

Start a tunnel

Give the port your app listens on. The address prints at once and each request is listed as it arrives. Press Ctrl+C to stop.

bash
rimbra tunnel 3000

  https://tunnel-8f2c1a9e.rimbra.live  →  http://localhost:3000

  10:42:07  GET    /            200  14ms
  10:42:08  POST   /api/hook    204  3ms

Options

FlagWhat it does
--name apiA fixed address, api-<workspace>.rimbra.live, the same every run.
--auth user:passVisitors sign in with this username and password before anything reaches your machine.
--host 127.0.0.1The local host to forward to. Defaults to localhost.
--host-header preservePass the public address as Host. By default your app sees Host: localhost:<port>.
--token rtk_…Use this token for one run instead of the saved one.

What your app receives

  • Every method, header and body, with request bodies up to 32 MB.
  • Streamed responses and server-sent events, as your app writes them.
  • Websockets, including the hot reload of most dev servers.
  • X-Forwarded-For with the visitor’s IP, X-Forwarded-Host with the public address and X-Forwarded-Proto: https.
  • Your app has 60 seconds to start answering. After that the visitor gets a 504.

Price and limits

Tunnels is a $4/month add-on on any plan: 1 tunnel with its own subdomain and 5 GB transfer a month, then $0.20 per GB from your points. The $10/month Developer pack includes Functions, Queues, Tunnels and Buckets with double the allowances. Without the add-on the Tunnels page asks you to pay first, and new tokens can’t be made.

Transfer counts what goes through a tunnel in both directions and resets each billing cycle. Past it, pay as you go pays from your points; with it off, or with no points left, tunnels stop carrying requests until the next cycle.

Without the add-on the CLI is refused with 402 plan_required until you add Tunnels. Tokens are kept, so the same ones work again.

A tunnel with no requests for 4 hours closes on its own. A tunnel never takes the address of a live app: if a name is already an app’s, pick another.

Tunnels at onceTransfer a monthPast that
Tunnels add-on, $4/month1, with a fixed name5 GB$0.20 per GB
Developer pack, $10/month2, with fixed names10 GB$0.20 per GB

See and stop tunnels

The Tunnels page charts requests through your tunnels by status over the last 24 hours or 7 days (30 days on paid plans), lists every connected tunnel with its address, local port, start time and request count, and shows the latest 50 requests across them. Open a tunnel to see only its requests. Stop ends a tunnel and tells the CLI not to reconnect. Tokens live on their own tab; revoking a token closes every tunnel using it.

Messages from the CLI

MessageWhat to do
That tunnel token isn’t validThe token was revoked or mistyped. Make a new one and run rimbra login.
Tunnels need the Tunnels add-onAdd Tunnels from its page in the dashboard, then run the command again.
N tunnels are already runningStop one in the dashboard, or get the Developer pack for two at once.
An app already lives at …Pick a different --name.
Nothing is running on port N (in the browser)The tunnel is up but your app isn’t. Start it and refresh.