OmniGate Manual

English

简体中文
繁體中文

English

简体中文
繁體中文

Appearance

OmniGateOmniGate User Manual

OmniGate allows you to access various resources such as Web, SSH, FTP, SMB, and VNC within a single app, and supports connecting to your personal domain such as routers and NAS using the FRP visitors protocol.

Getting Started
Domain Configuration
OmniGate

Multiple Resource Types

Each domain can manage resource entries for Web, SSH, SFTP, FTP, SMB, VNC and more.

Multiple Domains

Supports multiple domain configurations. Multiple domains can be online simultaneously. (In-app data channel only, not a system VPN.)

Built-in Tools

Built-in browser, SSH terminal, dual-pane file manager, basic VNC client, and real-time traffic display.

Multi-Tab & Shortcuts

iPad / macOS support multi-tab browsing. Resources can be added to the home screen as shortcut icons for one-tap access.

Pro Advanced Features

A one-time Pro purchase unlocks unlimited domains, configuration backup and restore, and more advanced features.

Does NOT include any VPN functionality!

It only borrowed some implementation details from well-known remote access projects., and does NOT create a VPN, provide proxy ports, or hijack other apps' traffic!

Who This Manual Is For ​

This manual is intended for OmniGate users. It focuses on how to configure domains, add resources, troubleshoot connection issues, and explains any current implementation limitations.

If you want to get a resource up and running as quickly as possible, start with Getting Started. If you are configuring a specific protocol, jump straight to Domain Configuration or Using Resources.

  1. First, read Core Concepts to understand the relationship between "domains" and "resources."
  2. Then configure a domain based on your actual network setup.
  3. Add resources under the domain, such as Web, SSH, File Manager or VNC.
  4. If a connection fails, follow Troubleshooting to check step by step.

Deploying This Manual ​

This manual is written with VitePress. The source code is located in manual/. Commands for local preview and build:

bash
cd manual
npm install
npm run dev
npm run build

The build output is in manual/.vitepress/dist/, which can be deployed to GitHub Pages, Cloudflare Pages, Vercel, or any static file server.

OmniGate User Manual

Copyright © OmniGate contributors