Skip to main content

How to Set Up a Gateway and Connect?

Set Up a Gateway and Connect​

This page walks through the whole flow, from a new gateway (AuthNull's SSH jump server) to a recorded session on an endpoint. Each step links to the detailed page.

All of these screens are in the admin console under Switch product → PAM.

Step 1: Onboard the gateway​

  1. Go to Gateways and click Onboard gateway.

  2. Register: enter the Gateway name and the Address operators connect to, then click Create & continue.

  3. Install: run the installer on your jump box, click Download console.env, copy the file to /etc/authnull/sshproxy/console.env and restart the service:

    wget https://raw.githubusercontent.com/authnull0/windows-endpoint/main/sshproxy/install.sh
    sudo bash install.sh
    sudo cp ~/Downloads/console.env /etc/authnull/sshproxy/console.env
    sudo systemctl restart authnull-sshproxy

  4. Verify: wait for the first heartbeat, note the host-key fingerprint, and click Finish. The gateway shows as Online.

Details: How to onboard a gateway.

Step 2: Add the endpoints behind the gateway​

Either:

  • go to Targets → Endpoints → Add endpoint → Linux server (via SSH gateway) and fill in Name, Address, Gateway, Sudo username and Authenticate with, or
  • from the gateway row's ⋯ menu choose Enrol machines to enrol many machines with one command.

The Gateway column on the Endpoints list shows which gateway reaches each endpoint.

Step 3: Write a policy​

Under Policies, create a policy that names the person, the endpoint and the account. Without a policy, every session through the gateway is refused.

Step 4: Make sure the operator can approve a push​

Sessions are approved with a push notification from your organisation's MFA provider (Settings → MFA Provider: AuthNull Authenticator, Duo Security or Okta Verify). For AuthNull Authenticator, enrol the operator's device from Users → row ⋯ → Register device.

Step 5: Connect​

  1. Go to Targets → Endpoints and click Connect on the endpoint.
  2. Pick the Account, then either copy the Connection string and run it in your terminal, or choose Open terminal to work in the browser.
  3. Approve the push on your device. The session opens.
  4. Exit the machine when you are done.

Details: How to connect to an endpoint via a gateway.

Step 6: Review the recording​

On Targets → Endpoints, click the icon in the Recordings column for the endpoint. The Session Recordings page lists the sessions recorded on it; click Play to replay one.