Documentation - OmniRelay

1. Introduction

OmniRelay is a desktop application for managing secure and reliable internet access in restricted or unstable environments.

You configure it through a guided interface, start relay operations from the UI, and monitor live health indicators from built-in status panels.

This guide focuses on what you see and do in the product so you can operate OmniRelay confidently without learning internal implementation details.

Screenshot placeholder: Application home or dashboard overview.

Operating system: Windows 10 or Windows 11 (64-bit).
User permissions: local Administrator access is recommended for install/start/stop operations.
Network adapters: at least two active adapters visible in Windows when using split-network scenarios.
Internet expectations: at least one path with outbound access for setup, validation, and license checks.
Remote endpoint access: a reachable gateway server with a user account that can run operational commands.
Time sync: Windows system clock should be accurate for stable status checks and activation flows.

Screenshot placeholder: System/network prerequisites checklist.

Download the latest Windows installer from the official OmniRelay download page.
Run the installer as Administrator.
Follow the setup wizard and complete installation with default options unless your policy requires custom paths.
Launch OmniRelay from the Start Menu after setup completes.
If Windows prompts for permissions, allow access so the app can manage relay operations.

Screenshot placeholder: Installer wizard screens.

On first launch, OmniRelay opens to the onboarding flow and prompts for license activation.
After activation, the main navigation becomes available: Relay Management, Gateway Management, Whitelists, Dashboard, and Settings.
Use the status bar and action logs at the bottom of operation panels to track each command outcome.
Recommended first action: open Relay Management and confirm your network adapters are detected.

Screenshot placeholder: First-run UI and navigation sidebar.

Open the License page.
Paste your license key into the activation field.
Click Activate License.
Wait for the confirmation message and automatic navigation to operational pages.
If activation fails, verify key accuracy, system time, and internet connectivity, then retry.

Screenshot placeholder: License entry and activation success message.

Configure relay behavior from Relay Management. Use the table below to map each field to its purpose.

UI Field	What You Set	Valid Values	Operator Notes
Proxy Listen Port	Main local listening port used by client applications.	1-65535	Use an unused port. Keep consistent with your client settings.
VPS Network (IC1)	Network adapter used for relay-side connectivity.	Any detected adapter	Choose the adapter connected to the relay-side network.
Outgoing Network (IC2)	Network adapter used for outbound internet path.	Any detected adapter	Choose the adapter that provides your preferred outbound path.
Apply Relay Config	Saves current relay field values.	Button action	Always apply after editing ports or adapter selections.
Refresh	Reloads current status and adapter information.	Button action	Use after plugging/unplugging adapters or changing routes.

Screenshot placeholder: Relay Management page with field labels.

Go to Relay Management.
Set Proxy Listen Port, VPS Network (IC1), and Outgoing Network (IC2).
Click Apply Relay Config.
Click Install/Start Relay.
Use Refresh and verify that Service State is Running and Proxy Running is True.
If you changed configuration after start, click Apply Relay Config again and refresh status.

Screenshot placeholder: Install/Start button flow and successful state.

Use the status panels in Relay Management and Gateway Management to confirm operational readiness.

Indicator	Meaning	Expected Value
Service State	Shows whether the local relay service is running.	Running
Proxy Running	Shows whether the listening endpoint is active.	True
Proxy Listen Port	Displays the active listening port.	Matches configured value
Tunnel Connected	Shows whether remote connectivity path is currently established.	True for active sessions
Gateway Service State	Shows remote service readiness from gateway checks.	Healthy/Active states
Health	Overall health summary from latest check.	Healthy
Last Error	Latest user-facing error summary.	Empty or informational only

Screenshot placeholder: Health/status cards and operation log panel.

Problem	What to Do	How to Confirm Fix
Start button completes but status stays stopped	Open OmniRelay as Administrator and run Install/Start Relay again.	Confirm Service State changes to Running after Refresh.
No adapters shown in dropdowns	Click Refresh, then verify adapters are enabled in Windows Network Settings.	Adapters appear in IC1/IC2 lists.
Activation fails with valid key	Check internet access, system date/time, and key formatting (no extra spaces).	Activation success message appears.
Health check shows Unhealthy	Run action sequence: Test Tunnel -> Bootstrap Check -> Health Check, then review operation log lines.	Health moves to Healthy or shows clear actionable error.
Connected earlier but not after outage	Use Refresh, then rerun Test Tunnel and Start operations to re-establish session.	Tunnel Connected returns to True.
Button click seems to do nothing	Hard refresh browser/UI view and retry; check operation log and bottom status message.	Action log receives new lines with result.
Panel unreachable	Verify correct address/port in UI and allow the port in host and provider firewall rules.	Panel opens and health checks pass.

Screenshot placeholder: Example warning/error states in UI.

Screenshot placeholder: Download page and post-update validation view.