Skip to content

Proxy Providers

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
proxy-providers:
  provider1:
    type: http
    url: "http://test.com"
    path: ./proxy_providers/provider1.yaml
    interval: 3600
    proxy: DIRECT
    size-limit: 0
    header:
      User-Agent:
      - "Clash/v1.18.0"
      - "mihomo/1.18.3"
      Authorization:
      - 'token 1231231'
    health-check:
      enable: true
      url: https://www.gstatic.com/generate_204
      interval: 300
      timeout: 5000
      lazy: true
      expected-status: 204
    override:
      tfo: false
      mptcp: false
      udp: true
      udp-over-tcp: false
      down: "50 Mbps"
      up: "10 Mbps"
      skip-cert-verify: true
      dialer-proxy: proxy
      interface-name: tailscale0
      routing-mark: 233
      ip-version: ipv4-prefer
      additional-prefix: "provider1 prefix |"
      additional-suffix: "| provider1 suffix"
      proxy-name:
      - pattern: "IPLC-(.*?)倍"
        target: "iplc x $1"
    filter: "(?i)港|hk|hongkong|hong kong"
    exclude-filter: "xxx"
    exclude-type: "ss|http"
    payload:
      - name: "ss1"
        type: ss
        server: server
        port: 443
        cipher: chacha20-ietf-poly1305
        password: "password"

Name

Required, such as provider1, must be unique. It is advisable not to duplicate names with policy groups.

Type

Required, provider type, options are http / file / inline.

URL

If the type is http, this must be configured.

Path

Optional, the file path, must be unique. If not provided, the MD5 of the URL will be used as the filename.

For security reasons, this path is restricted to only allow locations within HomeDir (configured with the -d startup parameter). If you wish to store it in any location, set the environment variable SKIP_SAFE_PATH_CHECK=1.

Interval

The update time for the provider, measured in seconds.

Proxy

Download/update through the specified proxy.

size-limit

The maximum size of downloadable files is restricted, with the default being 0, which means no size limit; the unit is bytes (b)

Custom HTTP request headers.

Health Check

Health check (latency testing).

health-check.enable

Whether to enable, optional true/false.

health-check.url

Health check address, it is recommended to use one of the following addresses:

https://cp.cloudflare.com

https://www.gstatic.com/generate_204

health-check.interval

Health check interval, measured in seconds.

health-check.timeout

Health check timeout, measured in milliseconds.

health-check.lazy

Lazy state, defaults to true, no testing is performed when this provider node is not in use.

health-check.expected-status

Refer to expected status.

Override

Override node content, the following fields are supported.

override.additional-prefix

Add a fixed prefix to the node name.

override.additional-suffix

Add a fixed suffix to the node name.

override.proxy-name

Replace the content of the node name, supporting regular expressions, where pattern is the replacement content and target is the replacement target.

override.Configuration_items

Refer to common fields tfo

Refer to common fields mptcp

Refer to common fields udp.

Refer to Shadowsocks udp-over-tcp

Refer to Hysteria/Hysteria2 up.

Refer to Hysteria/Hysteria2 down.

Refer to common fields skip-cert-verify.

Refer to common fields dialer-proxy.

Refer to common fields interface-name.

Refer to common fields routing-mark.

Refer to common fields ip-version.

Filter

Filter nodes that meet keywords or regular expressions, multiple regular expressions can be separated by `.

Exclude Filter

Exclude nodes that meet keywords or regular expressions, multiple regular expressions can be separated by `.

Exclude Type

Regular expressions are not supported; use | to separate and exclude based on node type.

The exclude-type of the provider uses the type from the configuration file for exclusion

payload

Content, only effective when type is inline