mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-26 09:12:10 +03:00
feat(panel): add sponsor slots fed from sponsors.sanaei.dev
Monthly sponsor placements need to change without cutting a panel release. Panels now read 3X/sponsors.json from the MHSanaei/sponsors repo (GitHub Pages on sponsors.sanaei.dev) and show active sponsors in four slots: an overview banner, a rotating sidebar card (max three), the login page and a new Sponsors page that also lists open placements. An entry shows only while enable is not false and until is in the future; links must be https and logos are png/webp/jpg by name only. The list is cached for an hour and the last good copy survives upstream failures; logos are proxied through /sponsors/logo/:name with failures cached, so CSP stays 'self' and admin browsers never reach a third party. Admins can hide a slot for 24h. Under XUI_DEBUG the panel reads a sibling ../sponsors/3X checkout so edits can be previewed before push.
This commit is contained in:
MHSanaei
@@ -22,6 +22,12 @@ _openapi:
|
||||
this — the middleware short-circuits CSRF for authenticated API
|
||||
requests.
|
||||
url: '#mint-a-csrf-token-for-the-current-session-the-spa-replays-it-in-the-x-csrf-token-header-on-unsafe-requests-bearer-token-callers-can-skip-this--the-middleware-short-circuits-csrf-for-authenticated-api-requests'
|
||||
- depth: 2
|
||||
title: Public. Active paid sponsor placements read from the project
|
||||
sponsors.json (cached for 1h); expired entries are dropped. Logos are
|
||||
proxied by the panel at /sponsors/logo/{name}. Used by the login page
|
||||
and panel sponsor slots.
|
||||
url: '#public-active-paid-sponsor-placements-read-from-the-project-sponsorsjson-cached-for-1h-expired-entries-are-dropped-logos-are-proxied-by-the-panel-at-sponsorslogoname-used-by-the-login-page-and-panel-sponsor-slots'
|
||||
- depth: 2
|
||||
title: Returns whether 2FA is enabled on the panel — used by the login page to
|
||||
decide whether to show the OTP field.
|
||||
@@ -39,6 +45,11 @@ _openapi:
|
||||
this — the middleware short-circuits CSRF for authenticated API
|
||||
requests.
|
||||
id: mint-a-csrf-token-for-the-current-session-the-spa-replays-it-in-the-x-csrf-token-header-on-unsafe-requests-bearer-token-callers-can-skip-this--the-middleware-short-circuits-csrf-for-authenticated-api-requests
|
||||
- content: Public. Active paid sponsor placements read from the project
|
||||
sponsors.json (cached for 1h); expired entries are dropped. Logos are
|
||||
proxied by the panel at /sponsors/logo/{name}. Used by the login page
|
||||
and panel sponsor slots.
|
||||
id: public-active-paid-sponsor-placements-read-from-the-project-sponsorsjson-cached-for-1h-expired-entries-are-dropped-logos-are-proxied-by-the-panel-at-sponsorslogoname-used-by-the-login-page-and-panel-sponsor-slots
|
||||
- content: Returns whether 2FA is enabled on the panel — used by the login page to
|
||||
decide whether to show the OTP field.
|
||||
id: returns-whether-2fa-is-enabled-on-the-panel--used-by-the-login-page-to-decide-whether-to-show-the-otp-field
|
||||
@@ -54,7 +65,7 @@ export default function Layout(props) {
|
||||
return (
|
||||
<>
|
||||
{props.children}
|
||||
<Comp document="./public/openapi.json" webhooks={[]} operations={[{"path":"/login","method":"post"},{"path":"/logout","method":"post"},{"path":"/csrf-token","method":"get"},{"path":"/getTwoFactorEnable","method":"post"}]} showTitle />
|
||||
<Comp document="./public/openapi.json" webhooks={[]} operations={[{"path":"/login","method":"post"},{"path":"/logout","method":"post"},{"path":"/csrf-token","method":"get"},{"path":"/sponsors","method":"get"},{"path":"/getTwoFactorEnable","method":"post"}]} showTitle />
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -4135,6 +4135,84 @@
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"Sponsor": {
|
||||
"description": "Sponsor is one paid placement published in the repo's sponsors.json.",
|
||||
"properties": {
|
||||
"enable": {
|
||||
"example": true,
|
||||
"nullable": true,
|
||||
"type": "boolean"
|
||||
},
|
||||
"id": {
|
||||
"example": "acme-2026-10",
|
||||
"type": "string"
|
||||
},
|
||||
"link": {
|
||||
"example": "https://acme.example/?utm_source=3x-ui",
|
||||
"type": "string"
|
||||
},
|
||||
"logo": {
|
||||
"example": "/sponsors/logo/acme.png",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"example": "Acme VPS",
|
||||
"type": "string"
|
||||
},
|
||||
"slots": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"text": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"title": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"until": {
|
||||
"example": "2026-11-01T00:00:00Z",
|
||||
"format": "date-time",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"link",
|
||||
"name",
|
||||
"slots",
|
||||
"text",
|
||||
"title",
|
||||
"until"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SponsorList": {
|
||||
"description": "SponsorList is the active sponsor set plus the contact link for new sponsors.",
|
||||
"properties": {
|
||||
"contact": {
|
||||
"example": "https://t.me/example",
|
||||
"type": "string"
|
||||
},
|
||||
"sponsors": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Sponsor"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"sponsors"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SubBalancer": {
|
||||
"description": "SubBalancer is one extra JSON-subscription config document whose members are\nthe selected inbounds' proxy outbounds. SortOrder shares SubSortIndex semantics.",
|
||||
"properties": {
|
||||
@@ -4587,6 +4665,59 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/sponsors": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Authentication"
|
||||
],
|
||||
"summary": "Public. Active paid sponsor placements read from the project sponsors.json (cached for 1h); expired entries are dropped. Logos are proxied by the panel at /sponsors/logo/{name}. Used by the login page and panel sponsor slots.",
|
||||
"operationId": "get_sponsors",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"success": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"msg": {
|
||||
"type": "string"
|
||||
},
|
||||
"obj": {
|
||||
"$ref": "#/components/schemas/SponsorList"
|
||||
}
|
||||
}
|
||||
},
|
||||
"example": {
|
||||
"success": true,
|
||||
"obj": {
|
||||
"contact": "https://t.me/example",
|
||||
"sponsors": [
|
||||
{
|
||||
"enable": true,
|
||||
"id": "acme-2026-10",
|
||||
"link": "https://acme.example/?utm_source=3x-ui",
|
||||
"logo": "/sponsors/logo/acme.png",
|
||||
"name": "Acme VPS",
|
||||
"slots": [
|
||||
""
|
||||
],
|
||||
"text": {},
|
||||
"title": {},
|
||||
"until": "2026-11-01T00:00:00Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/getTwoFactorEnable": {
|
||||
"post": {
|
||||
"tags": [
|
||||
|
||||
Reference in New Issue
Block a user