GHGatehousePublic alpha
Documentation/Deployment runbook · 10 minutes

Deployment runbook · 10 minutes

Connect one private web application

You need a server that can already reach the target application, Docker Engine with Compose, and outbound TCP 443 access to relay.gatehousebox.com.

Working production route Docker Compose No inbound port
01

You already have a web app

Gatehouse starts with an HTTP or HTTPS application that is reachable from one machine in your private network.

http://grafana:3000
  • No public DNS required
  • No inbound firewall rule
  • Exact host and port only
02

Run the connector beside it

Download the connector bundle, paste the one-time enrollment values from your workspace, and start the container.

docker compose up -d --build
  • Outbound WSS to the relay
  • Credential stored locally
  • Automatic reconnect
03

Open it through Gatehouse

Register that exact target, grant a named user access, and send the generated browser URL.

gatehousebox.com/access/…
  • Identity and expiry checked
  • Methods explicitly allowed
  • Immediate revocation
01

Before you begin

Choose the machine that will run Gatehouse Connector. From that machine or its Docker network, confirm the private application is reachable by a stable hostname and port.

  • Docker Engine 24+ and Compose v2
  • Outbound DNS and HTTPS/WSS
  • No inbound firewall opening
  • HTTP or HTTPS target only
Configuration
curl -I http://grafana:3000/
# Expect an HTTP response from the target application
02

Create the owner account

Open Create account, enter your name, work email, organization name, and a strong password. Registration creates a real owner account and an isolated organization workspace.

  • Console routes require authentication
  • Organization records are tenant-scoped
  • Alpha limit: 2 connectors and 5 services

If you already have an access invitation, register with the exact invited email instead of creating a second organization.

03

Download and enroll the connector

Open Connectors in the console, download the bundle, and generate a one-time enrollment token. The console gives you the relay URL, enrollment URL, and token.

Configuration
unzip gatehouse-connector.zip -d gatehouse-connector
cd gatehouse-connector
cp .env.example .env
# Paste the three values shown in the Gatehouse console into .env
04

Start it on your server

Build and start the connector. The one-time token is exchanged for a long-lived random connector credential stored in the connector-data Docker volume.

  • Look for enrollment accepted
  • Look for tunnel connected
  • Confirm the connector changes to Online in Gatehouse
Configuration
docker compose up -d --build
docker compose logs -f connector
05

Register the exact private service

Open Services and add the application. Use the hostname as seen from inside the connector container. For a service on the Docker host, use host.docker.internal; for another container, attach both to a shared Docker network.

  • Protocol: HTTP or HTTPS
  • Target host and port
  • Base path and optional health path
  • Explicitly allowed methods
Configuration
Name: Production Grafana
Connector: Office edge
Protocol: HTTP
Target host: grafana
Target port: 3000
Base path: /
Allowed methods: GET, POST
06

Verify reachability

Open the service detail and run Check reachability. The relay asks the enrolled connector to make the check from the private network. A failure here is a network or target configuration problem, not a visitor authorization problem.

  • Confirm DNS inside the connector container
  • Confirm target port
  • Confirm health path returns 2xx or 3xx
  • Review SSRF policy if using loopback
07

Grant and open access

Open Access grants, choose the service, enter the visitor email, allowed methods, grant duration, and maximum session duration. Send the generated URL to that same email identity.

  • Visitor signs in or creates an account
  • Access page shows exact authority
  • Relay rechecks the grant for every stream
  • Revocation blocks subsequent requests immediately
Ready to connect a server?

Create the workspace first. The signed-in Connectors page will generate your one-time enrollment values.

Create account