Skip to main content

Quick Start Guide

This guide should be simple enough to get your locally hosted web-site or service accessible on the public Internet within 1-3 minutes.

Accessing the agent​

Cruma.io is currently in private beta. Agent downloads and credentials are shared directly with beta participants. If you need access, contact the team through your beta channel or reach out via our support channels.

Anonymous quick test​

You can run an anonymous tunnel without a tunnel ID/secret. A unique FQDN is assigned and persisted in .cruma_tunnel_cache in the directory where you run the command:

cruma-tunnel-ui http --target 127.0.0.1:3000

This is great for quick local tests; anonymous tunnels have tighter limits (see Rate Limits & Fair Use).

Basic usage​

This assumes your service is running locally on port 8080. Replace TUNNEL_ID and SECRET_KEY with the values you received for the beta.

cruma-tunnel-ui http --target 127.0.0.1:8080 --tunnel-id TUNNEL_ID --secret-key SECRET_KEY
  • --target is the local address and port you want to expose.
  • --tunnel-id is the tunnel name; leave it out to use the default ANON.
  • --secret-key is provided with your beta invite.
  • --tower-server defaults to tower.cruma.io:443; override if the team asks you to target a different region.

You’ll receive the public URL after the tunnel is established.

Using a config file​

If you prefer to manage multiple targets in one place, you can load them from a config file (YAML, JSON, or TOML) with cruma-tunnel-ui config ./cruma.yaml. See the configuration guide for an example and the schema.

Forwarding Raw TCP services​

Use raw for TCP services where you want to handle TLS yourself.

cruma-tunnel-ui raw --target 127.0.0.1:4943 --tunnel-id TUNNEL_ID --secret-key SECRET_KEY

This creates a raw TCP tunnel; the platform will provide the reachable endpoint once the tunnel is up.