Murzaby/s-ui
1
0
Fork 0
mirror of https://github.com/alireza0/s-ui.git synced 2026-10-20 19:02:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

sub json template docs #1257

Browse source
This commit is contained in:
Alireza Ahmadi 2026-09-12 19:22:46 +02:00
parent f344f64b55
commit 2e11bd2a4c
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -44,9 +44,18 @@
[Other UI Screenshots](https://github.com/alireza0/s-ui-frontend/blob/main/screenshots.md)
## API Documentation
## Documentation
[API-Documentation Wiki](https://github.com/alireza0/s-ui/wiki/API-Documentation)
Full documentation lives in the [Wiki](https://github.com/alireza0/s-ui/wiki):
| Page | Contents |
|------|----------|
| [Subscription Service](https://github.com/alireza0/s-ui/wiki/Subscription-Service) | Subscription URLs, the three formats, response headers |
| [Subscription JSON Template](https://github.com/alireza0/s-ui/wiki/Subscription-JSON-Template) | Structure and supported keys of the sing-box subscription template |
| [Subscription Clash Template](https://github.com/alireza0/s-ui/wiki/Subscription-Clash-Template) | The Clash.Meta template, proxy groups and filters |
| [API Documentation](https://github.com/alireza0/s-ui/wiki/API-Documentation) | The token-authenticated REST API (`/apiv2`) |
| [Configuration Objects](https://github.com/alireza0/s-ui/wiki/Configuration-Objects) | Shape of the objects read and written through the API |
| [Settings Reference](https://github.com/alireza0/s-ui/wiki/Settings-Reference) | Every panel setting and its default |
## Default Installation Information
- Panel Port: 2095