Skip to content

Proxy providers

A proxy provider loads a collection of nodes. Replace url with a subscription endpoint returning node YAML. The group's use references the provider name.

yaml
proxy-providers:
  Subscription:
    type: http
    url: https://subscription.example.com/nodes.yaml
    interval: 3600
    health-check:
      enable: true
      url: https://www.gstatic.com/generate_204
      interval: 300
      timeout: 5000
    override:
      additional-prefix: "Sub-"
proxy-groups:
  - name: Proxy
    type: select
    use: [Subscription]
rules:
  - MATCH,Proxy

Provider fields

FieldHow to configure it
Provider nameSubscription in the example; must be unique
typehttp downloads, file reads a local resource, inline embeds nodes
urlDownload address for an HTTP provider
pathLocal resource or cache path; do not share paths between providers. HTTP providers can omit this for client management
intervalResource update interval in seconds, separate from health checks
proxyNode or group used for downloading; avoid depending on this provider before it has loaded
headerRequest headers with list values, for example Authorization: ["Bearer YOUR_TOKEN"]
filter / exclude-filterRegular expressions for including or excluding node names
overrideReplace imported node options; additional-prefix and additional-suffix help distinguish names
health-checkenable, url, interval in seconds, timeout in milliseconds, and lazy for on-demand checks

Downloaded file format

The downloaded YAML contains a proxies list. Each entry follows the outbound proxy format:

yaml
proxies:
  - name: Node-A
    type: trojan
    server: proxy.example.com
    port: 443
    password: YOUR_PASSWORD
    sni: proxy.example.com
    udp: true

For type: inline, omit url and put the node list under the provider's payload. For file, set path to a prepared resource accessible to the app.

Platform behavior and field status

Remote resources may be prepared by the app or loaded by the core after connection. Check provider status if nodes are not ready. tvOS may clear caches, so remote resources must remain downloadable.

1 fields shown

FieldTypeiOSmacOStvOSPlatform notes
proxy-providersMappingManaged / limitedManaged / limitedManaged / limitedInline content loads directly; remote resources may be prepared by the app or loaded by the core after startup. Precompiled rule updates may take effect at the next activation.

Reference: mihomo.