kenzok8-small/luci-app-homeproxy/docs/Ruleset-URI-Scheme.md
2024-09-06 21:23:25 +08:00

1.4 KiB
Raw Permalink Blame History

Import rule-set links format

Structure

remote: http[s]://[auth@]<host><path>?file=<rulefmt>[&key=value][#label]
local: file://[host]<path>?file=<rulefmt>[&key=value][#label]
inline: inline://<base64edJsonStr>[#label]

Components

Scheme

Can be http or https or file or inline.

Auth

Add it only if required by the target host.

Host

The format is hostname[:port].
hostname can be Domain or IP Address.
:port is optional, add it only if required by the target host.

Path

The shortest format is /.

Base64edJsonStr

Generation steps:

  1. Base64 encode Headless Rule .rules.
  2. Replace all + with - and all / with _ in base64 string.
  3. Remove all = from the EOF the base64 string.

QueryParameters

  • file: Required. Available values refer to Rulefmt.
  • rawquery: Optional. Available values refer to rawQuery.

Rulefmt

Can be json or srs. Rule file format.

rawQuery

This parameter is required if the original link contains a url query.
Encrypt the part key1=value1&key2=value2 after ? in the original link with encodeURIComponent and use it as the payload of this parameter.

URIFragment

Ruleset label. Empty strings are not recommended.
Need encoded by encodeURIComponent.