Skip to content

Glossary

Terms used in Tubu commands, configuration and guides.

API key / authtoken

A credential that authenticates publishing and reservation requests to your account. The CLI accepts it as --authtoken, YAML authtoken or TUBU_TOKEN. It is separate from an HTTP shared secret.

Caller

The client that accesses a published service. HTTP callers use the public URL. TCP callers run npx tubu-cli forward and point their application at its local listener.

Domain

The exact public tubu.dev hostname assigned to a tunnel, such as app.tubu.dev. Third level names have one label before tubu.dev; fourth level names, such as api.team.tubu.dev, have two.

Listener

The 127.0.0.1 address and port opened by npx tubu-cli forward on the caller machine. A local application connects there to reach the published TCP target.

Publisher

The CLI process that registers tunnels and connects to their targets. It runs on a machine that can reach the local or private services.

Relay

The Tubu service that receives public connections and forwards them through channels to the publisher.

Reservation

An account claim on one exact domain. It can exist without an active tunnel. It does not claim sibling domains or keep a local service running.

Rewrite

A pattern and replacement pair that changes an HTTP request pathname after its destination has been selected. It does not change route selection or the query string.

Route

An HTTP pathname prefix mapped to a target inside a tunnel. The longest matching prefix at a path segment boundary wins. Unmatched requests use the tunnel target.

Secret / secret_hash

An optional HTTP access credential, or its SHA-256 digest in configuration. Callers send the original secret in X-Tubu-Auth. It is separate from the publisher API key.

SSE

Server sent events: a stream of events delivered through a long lived HTTP response. SSE uses an HTTP tunnel.

Target / upstream

The service address the publisher connects to. It can be an integer loopback port or a URL with an HTTP, HTTPS or TCP scheme appropriate to the tunnel type.

TLS

Transport Layer Security, used to encrypt HTTPS and secure WebSocket connections. Public TLS, publisher transport TLS and target application TLS are separate connections.

Tunnel

A mapping from a public domain to a target service through a running publisher. Tubu supports HTTP and TCP tunnels.

WebSocket

A bidirectional connection established through an HTTP upgrade. An HTTP tunnel can forward an application WebSocket. Tubu also uses secure WebSockets internally for tunnel transport.