|
|
@@ -2,9 +2,10 @@
|
|
|
title: Subscription Server
|
|
|
description: A separate HTTP/HTTPS server that serves proxy subscription links
|
|
|
(standard, JSON, and Clash) to clients. The server listens on its own port
|
|
|
- (default 10882) and is configured in Settings → Subscription. Paths are
|
|
|
- configurable; defaults are shown below. All subscription endpoints set
|
|
|
- response headers for client apps to read traffic/expiry info.
|
|
|
+ (default 2096) and is configured in Settings → Subscription. Fresh panels
|
|
|
+ generate random path prefixes for each format; all paths remain configurable.
|
|
|
+ Every subscription endpoint sets response headers for client apps to read
|
|
|
+ traffic/expiry info.
|
|
|
full: true
|
|
|
_openapi:
|
|
|
preload:
|
|
|
@@ -15,34 +16,36 @@ _openapi:
|
|
|
matching the subscription ID. When the request has an Accept: text/html
|
|
|
header or ?html=1, renders a styled info page instead. With
|
|
|
?format=info, returns the page view-model as JSON (traffic, expiry,
|
|
|
- online status; no links) for live polling. Default path: /sub/:subid.'
|
|
|
- url: '#return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-with-formatinfo-returns-the-page-view-model-as-json-traffic-expiry-online-status-no-links-for-live-polling-default-path-subsubid'
|
|
|
+ online status; no links) for live polling. The path prefix is configured
|
|
|
+ by subPath.'
|
|
|
+ url: '#return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-with-formatinfo-returns-the-page-view-model-as-json-traffic-expiry-online-status-no-links-for-live-polling-the-path-prefix-is-configured-by-subpath'
|
|
|
- depth: 2
|
|
|
- title: 'Return subscription as a JSON array of proxy configs (one per enabled
|
|
|
- client). Only when JSON subscription is enabled in settings. Default
|
|
|
- path: /json/:subid.'
|
|
|
- url: '#return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-default-path-jsonsubid'
|
|
|
+ title: Return subscription as a JSON array of proxy configs (one per enabled
|
|
|
+ client). Only when JSON subscription is enabled in settings. The path
|
|
|
+ prefix is configured by subJsonPath.
|
|
|
+ url: '#return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-the-path-prefix-is-configured-by-subjsonpath'
|
|
|
- depth: 2
|
|
|
- title: 'Return subscription as a Clash/Mihomo-compatible YAML config, including
|
|
|
+ title: Return subscription as a Clash/Mihomo-compatible YAML config, including
|
|
|
configured global Clash routing rules. Only when Clash subscription is
|
|
|
- enabled in settings. Default path: /clash/:subid.'
|
|
|
- url: '#return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-default-path-clashsubid'
|
|
|
+ enabled in settings. The path prefix is configured by subClashPath.
|
|
|
+ url: '#return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-the-path-prefix-is-configured-by-subclashpath'
|
|
|
structuredData:
|
|
|
headings:
|
|
|
- content: 'Return base64-encoded subscription links for all enabled clients
|
|
|
matching the subscription ID. When the request has an Accept:
|
|
|
text/html header or ?html=1, renders a styled info page instead. With
|
|
|
?format=info, returns the page view-model as JSON (traffic, expiry,
|
|
|
- online status; no links) for live polling. Default path: /sub/:subid.'
|
|
|
- id: return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-with-formatinfo-returns-the-page-view-model-as-json-traffic-expiry-online-status-no-links-for-live-polling-default-path-subsubid
|
|
|
- - content: 'Return subscription as a JSON array of proxy configs (one per enabled
|
|
|
- client). Only when JSON subscription is enabled in settings. Default
|
|
|
- path: /json/:subid.'
|
|
|
- id: return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-default-path-jsonsubid
|
|
|
- - content: 'Return subscription as a Clash/Mihomo-compatible YAML config,
|
|
|
- including configured global Clash routing rules. Only when Clash
|
|
|
- subscription is enabled in settings. Default path: /clash/:subid.'
|
|
|
- id: return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-default-path-clashsubid
|
|
|
+ online status; no links) for live polling. The path prefix is
|
|
|
+ configured by subPath.'
|
|
|
+ id: return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-with-formatinfo-returns-the-page-view-model-as-json-traffic-expiry-online-status-no-links-for-live-polling-the-path-prefix-is-configured-by-subpath
|
|
|
+ - content: Return subscription as a JSON array of proxy configs (one per enabled
|
|
|
+ client). Only when JSON subscription is enabled in settings. The path
|
|
|
+ prefix is configured by subJsonPath.
|
|
|
+ id: return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-the-path-prefix-is-configured-by-subjsonpath
|
|
|
+ - content: Return subscription as a Clash/Mihomo-compatible YAML config, including
|
|
|
+ configured global Clash routing rules. Only when Clash subscription is
|
|
|
+ enabled in settings. The path prefix is configured by subClashPath.
|
|
|
+ id: return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-the-path-prefix-is-configured-by-subclashpath
|
|
|
contents: []
|
|
|
---
|
|
|
|