OneXray

https://onexray.com
Admin
OneXray is an open-source cross-platform proxy client for Xray-core that provides smart routing,...
Tokens:9,761
Snippets:157
Trust Score:5.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install OneXray on Windows with winget

Source: https://onexray.com/docs/install

Install the standalone EXE on Windows via winget. The EXE and ZIP use a native TUN; starting VPN requests administrator approval for Core, not for the main app. Extract the entire ZIP before opening OneXray; it does not register links or create shortcuts automatically.

```shell
winget install --id YuanDevLLC.OneXray -e
```

--------------------------------

### Install OneXraySE on macOS with Homebrew

Source: https://onexray.com/docs/install

Install OneXraySE on macOS via Homebrew. OneXraySE uses a System Extension; for ZIP, move OneXraySE.app to /Applications before opening. Complete setup and approve VPN/Network Extension requests; macOS may direct you to Login Items & Extensions or Privacy & Security.

```shell
brew install --cask onexrayse
```

--------------------------------

### Batch subscription URLs example

Source: https://onexray.com/docs/servers/import

Shows the expected format for batch subscriptions: one HTTPS URL per line, with an optional fragment for the initial display name. The fragment is not part of the saved request URL. These are format examples, not working subscriptions.

```text
https://example.com/sub-one#Personal
https://example.com/sub-two#Work
```

--------------------------------

### Set up OneXray ZIP on Linux with setcap

Source: https://onexray.com/docs/install

Set up a ZIP build on Linux: install required packages and grant Core network capabilities. Reapply capabilities if an update replaces Core. ZIP does not register onexray:// links; GNOME may need the AppIndicator extension for tray controls.

```shell
sudo apt install -y procps libcap2-bin libayatana-appindicator3-1
sudo setcap cap_net_admin,cap_net_raw+eip OneXray/OneXrayCore
```

--------------------------------

### Install OneXray DEB on Debian/Ubuntu

Source: https://onexray.com/docs/install

Install the DEB package on Debian/Ubuntu. The DEB installs dependencies and grants Core its network capabilities. Use OneXray-linux-aarch64.deb for arm64.

```shell
sudo apt install ./OneXray-linux-x86_64.deb
```

--------------------------------

### Minimal custom route JSON example

Source: https://onexray.com/docs/connect/custom-routing

Shows the minimal JSON structure for a custom route with two empty entry slots. The routing strategy is fixed to IPIfNonMatch, rules use ruleTag for names and omit type. Store/export only empty entry slots; do not add direct or block outbound objects.

```json
{
  "name": "Local network direct",
  "outbounds": [{}, {}],
  "routing": {
    "domainStrategy": "IPIfNonMatch",
    "rules": [
      {
        "ruleTag": "Private addresses",
        "ip": ["geoip:private"],
        "outboundTag": "direct"
      },
      {
        "ruleTag": "Example through VPN",
        "domain": ["domain:example.com"],
        "balancerTag": "proxy"
      }
    ]
  }
}
```

--------------------------------

### Custom geodata dependency fragment

Source: https://onexray.com/docs/sharing

A JSON fragment used to declare custom geodata assets within a configuration. This is not a complete runnable configuration and requires replacing the example URL with your own source.

```json
{
  "geodata": {
    "assets": [
      {"file": "other.dat", "url": "https://example.com/other.dat"}
    ]
  }
}
```

--------------------------------

### OneXray link structures

Source: https://onexray.com/docs/sharing

The standard URI formats for adding outbounds, subscriptions, and custom geodata. Choose one value for alternatives and use the fragment for a display name.

```text
onexray://onexray.com/config/add?type=outbound|raw|custom&data=<percent-encoded-base64-json>#Name
onexray://onexray.com/sub/add?url=<percent-encoded-https-url>&age=x25519|hybrid#Name
onexray://onexray.com/dat/add?type=domain|ip&url=<percent-encoded-https-url>#Name
```

--------------------------------

### VPN final exit chain visualization

Source: https://onexray.com/docs/connect/smart-routing

Visual representation of how traffic flows through the device, entry server, and final exit node.

```text
Device → selected entry server → final exit → destination
```
Tokens:
Raw