Skip to main content

Web UI Guide

The GateKey Web UI provides a browser-based interface for downloading VPN configurations and managing your account.

Accessing the Web UI​

Navigate to your GateKey server URL:

https://vpn.yourcompany.com

Login​

GateKey Login Page

  1. Click your identity provider button (Keycloak, SAML, etc.)
  2. You'll be redirected to your company's identity provider
  3. Enter your credentials (Okta, Azure AD, Google, etc.)
  4. After authentication, you're redirected back to GateKey

You can also sign in as a local user if your administrator has enabled local authentication.

Dashboard​

GateKey Dashboard

The dashboard provides a comprehensive overview of your VPN infrastructure:

Stats Overview​

  • Gateways - Number of available VPN gateways
  • Networks - CIDR blocks defined for routing
  • Users - SSO users registered in the system
  • Access Rules - IP/hostname rules controlling access
  • Proxy Apps - Web applications available for clientless access

Quick Actions​

  • Connect to VPN - Download configs or get CLI commands
  • Mesh Networks - Access hub-and-spoke mesh VPN
  • Web Access - Launch clientless web applications
  • Help & Docs - Getting started documentation

Resource Panels​

  • Your Gateways - VPN gateways with online/offline status
  • Your Mesh Networks - Mesh hubs with connected spokes
  • Your Web Apps - Quick access to internal applications (ArgoCD, Grafana, etc.)

Download VPN Config​

Connect to VPN

Click "Connect to VPN" from the dashboard to access the gateway selection screen:

The right panel shows CLI commands for the easiest connection experience:

# First time setup (run once)
gatekey config init --server https://gatekey.dye.tech

# Connect to VPN
gatekey connect --gateway gateway

Don't have the CLI? Install it with:

curl -sSL https://gatekey.dye.tech/scripts/install-client.sh | bash

Manual Configuration​

Expand "Manual Configuration" to download config files directly:

  1. Select your gateway from the left panel
  2. Choose your VPN protocol:
    • OpenVPN - .ovpn file
    • WireGuard - .conf file
  3. Import the config into your VPN client
Config Expiration

Configs are valid for 24 hours by default. After expiration, simply download a new config from the web UI.

Mesh Networks​

If you have access to mesh networks:

  1. Navigate to "Mesh Hubs" in the sidebar
  2. Select a mesh hub
  3. Click "Download Config"
  4. Import into your VPN client

API Keys​

Generate API keys for CLI or automation:

  1. Navigate to "Settings" → "API Keys"
  2. Click "Create API Key"
  3. Set a name and optional expiration
  4. Copy the key (shown only once)

Session Management​

View and manage your active sessions:

  1. Navigate to "Settings" → "Sessions"
  2. See all your active logins
  3. Click "Revoke" to end a session

GateKey Menu

The sidebar provides access to all GateKey features, organized by category:

User Features​

  • Dashboard - Overview and quick actions
  • Connect - VPN gateway connection
  • Web Access - Clientless web applications
  • My Configs - Your downloaded configurations
  • API Keys - Personal API key management

Identity & Access (Admin)​

  • Users - User management
  • OIDC Providers - OpenID Connect configuration
  • SAML Providers - SAML identity provider setup

Network (Admin)​

  • Topology - Network visualization
  • Gateways - VPN gateway management
  • Mesh - Mesh networking configuration
  • Networks - CIDR block definitions
  • Access Rules - Access policy management

Applications (Admin)​

  • Proxy Apps - Clientless web application proxy

Diagnostics (Admin)​

  • Network Tools - Troubleshooting utilities
  • Remote Sessions - Remote agent access

System (Admin)​

  • Monitoring - System health and metrics
  • Geo-Fencing - IP-based access restrictions
  • All Configs - View all user configurations
  • Settings - System settings
  • Certificate CA - PKI management