FoXray URL Scheme #

FoXray private sharing protocol supports one-click opening of the app and importing of configurations.

Please note: FoXray private sharing protocol does not support subscription. If you put sharing links in subscription, they will not be imported.

Xray Setting #

foxray://foxray.yiguo.dev/config/add?core=xray&type=setting&data=yourBase64Data#name

data is the text encoded by XrayJson with base64. It is recommended that you escape it with encodeURIComponent.

name is the configuration name. It is recommended that you escape it with encodeURIComponent.

Note: When you want to share the routing configuration, please also share the associated rule set data. The following import method is supported.

Share links generated via FoXray will automatically include the ruleset data.

foxray://foxray.yiguo.dev/dat/add?type=domain&url=yourDownloadLink#name
foxray://foxray.yiguo.dev/dat/add?type=ip&url=yourDownloadLink#name
foxray://foxray.yiguo.dev/config/add?core=xray&type=setting&data=yourBase64Data#name

Outbound #

Although the app supports this sharing method, it is recommended that you still use the common protocol to avoid duplicate development.

Xray-core #

foxray://foxray.yiguo.dev/config/add?core=xray&type=outbound&data=yourBase64Data#name

data is the text encoded by XrayJson with base64. It is recommended that you escape it with encodeURIComponent.

name is the outbound name. It is recommended that you escape it with encodeURIComponent.

Hysteria 2 #

foxray://foxray.yiguo.dev/config/add?core=hysteria2&type=outbound&data=yourBase64Data#name

data is the text encoded by Hysteria 2 yaml with base64. It is recommended that you escape it with encodeURIComponent.

name is the outbound name. It is recommended that you escape it with encodeURIComponent.

Subscription #

foxray://foxray.yiguo.dev/sub/add?url=yourDownloadLink#name

url is the subscription link, and it is recommended that you use encodeURIComponent to escape it.

name is the subscription name, and it is recommended that you use encodeURIComponent to escape it.

Rule Set #

foxray://foxray.yiguo.dev/dat/add?type=domain&url=yourDownloadLink#name

type is the rule set type, which can be domain or ip.

url is the rule set download link, and it is recommended that you use encodeURIComponent to escape it.

name is the rule set name, and it is recommended that you use encodeURIComponent to escape it.