Skip to content

Getting Started

The OmniGate home screen is the domain list. A typical workflow is: first add a domain, then add resources under the domain, and finally tap a resource to access it.

1. Adding a Domain

  1. Open the app and go to the domain list.
  2. Tap the menu or add button in the top-right corner.
  3. Select the domain type.
  4. Fill in the domain name and protocol configuration.
  5. Save and return to the domain list.

The free version allows only one domain. Purchase OmniGate Pro to add an unlimited number of domains.

2. Adding a Resource

  1. Tap a domain in the domain list.
  2. In the resource list, tap the add button.
  3. Select the resource type, such as Web, SSH, FTP, SMB, or VNC.
  4. Fill in the resource name and connection details.
  5. Save and tap the resource to open it.

Resources are attached to a domain. The same NAS, router, or server can have multiple resources under the same domain, such as a management web page, SSH, SMB file sharing, and a VNC desktop.

3. Opening a Resource

When you tap a resource, OmniGate first prepares the corresponding domain, then opens the resource page.

The navigation bar displays a two-step connection progress:

  • Step 1: Domain connection. Starting FRP.
  • Step 2: Resource connection. Connecting to Web, SSH, file service, or VNC.

Each step uses color to indicate status: gray for waiting, blue for connecting, green for connected, and red for connection failed.

  • If the domain step turns red: the domain itself failed to connect. Check the domain configuration.
  • If the domain turns green but the resource step turns red: the domain is available, but the target resource is unreachable or authentication failed.

If you already have an FRP configuration (https://github.com/fatedier/frp/tree/dev/conf), add the FRP domain first, then add resources for testing.

The FRP domain requires at least::

  • Domain name
  • FRP Server IP or domain
  • FRP Service port, commonly 7000
  • Auth token
  • Connection protocol

A Web resource only needs:

  • Resource name
  • Path, for example /
  • Type STCP or XTCP
  • ServerUser (same as peer)
  • ServiceName (same as peer)
  • ServiceSecretKey

5. If It Won't Open

First, determine which layer the failure occurred at:

  • If the status is stuck at domain connecting, check the domain configuration first.
  • If the domain is connected but the resource fails, check the resource address, port, credentials, and server-side firewall.
  • If an issue occurs after switching domains, go back to the resource list and reopen the resource, or restart the app if necessary.

For detailed troubleshooting, see Troubleshooting.

OmniGate User Manual