mirror of
https://github.com/SagerNet/sing-box.git
synced 2024-09-20 10:37:51 +00:00
63 lines
1.9 KiB
Markdown
63 lines
1.9 KiB
Markdown
|
---
|
||
|
|
icon: material/pencil-ruler
|
||
|
|
---
|
||
|
|
|
||
|
|
# General
|
||
|
|
|
||
|
|
Describes and explains the functions implemented uniformly by sing-box graphical clients.
|
||
|
|
|
||
|
|
### Profile
|
||
|
|
|
||
|
|
Profile describes a sing-box configuration file and its state.
|
||
|
|
|
||
|
|
#### Local
|
||
|
|
|
||
|
|
* Local Profile represents a local sing-box configuration with minimal state
|
||
|
|
* The graphical client must provide an editor to modify configuration content
|
||
|
|
|
||
|
|
#### iCloud (on iOS and macOS)
|
||
|
|
|
||
|
|
* iCloud Profile represents a remote sing-box configuration with iCloud as the update source
|
||
|
|
* The configuration file is stored in the sing-box folder under iCloud
|
||
|
|
* The graphical client must provide an editor to modify configuration content
|
||
|
|
|
||
|
|
#### Remote
|
||
|
|
|
||
|
|
* Remote Profile represents a remote sing-box configuration with a URL as the update source.
|
||
|
|
* The graphical client should provide a configuration content viewer
|
||
|
|
* The graphical client must implement automatic profile update (default interval is 60 minutes) and HTTP Basic
|
||
|
|
authorization.
|
||
|
|
|
||
|
|
At the same time, the graphical client must provide support for importing remote profiles
|
||
|
|
through a specific URL Scheme. The URL is defined as follows:
|
||
|
|
|
||
|
|
```
|
||
|
|
sing-box://import-remote-profile?url=urlEncodedURL#urlEncodedName
|
||
|
|
```
|
||
|
|
|
||
|
|
### Dashboard
|
||
|
|
|
||
|
|
While the sing-box service is running, the graphical client should provide a Dashboard interface to manage the service.
|
||
|
|
|
||
|
|
#### Status
|
||
|
|
|
||
|
|
Dashboard should display status information such as memory, connection, and traffic.
|
||
|
|
|
||
|
|
#### Mode
|
||
|
|
|
||
|
|
Dashboard should provide a Mode selector for switching when the configuration uses at least two `clash_mode` values.
|
||
|
|
|
||
|
|
#### Groups
|
||
|
|
|
||
|
|
When the configuration includes group outbounds (specifically, Selector or URLTest),
|
||
|
|
the dashboard should provide a Group selector for status display or switching.
|
||
|
|
|
||
|
|
### Chore
|
||
|
|
|
||
|
|
#### Core
|
||
|
|
|
||
|
|
Graphical clients should provide a Core region:
|
||
|
|
|
||
|
|
* Display the current sing-box version
|
||
|
|
* Provides a button to clean the working directory
|
||
|
|
* Provides a memory limiter switch
|