github.com/sagernet/sing-box@v1.9.0-rc.20/docs/clients/general.md (about)

     1  ---
     2  icon: material/pencil-ruler
     3  ---
     4  
     5  # General
     6  
     7  Describes and explains the functions implemented uniformly by sing-box graphical clients.
     8  
     9  ### Profile
    10  
    11  Profile describes a sing-box configuration file and its state.
    12  
    13  #### Local
    14  
    15  * Local Profile represents a local sing-box configuration with minimal state
    16  * The graphical client must provide an editor to modify configuration content
    17  
    18  #### iCloud (on iOS and macOS)
    19  
    20  * iCloud Profile represents a remote sing-box configuration with iCloud as the update source
    21  * The configuration file is stored in the sing-box folder under iCloud
    22  * The graphical client must provide an editor to modify configuration content
    23  
    24  #### Remote
    25  
    26  * Remote Profile represents a remote sing-box configuration with a URL as the update source.
    27  * The graphical client should provide a configuration content viewer
    28  * The graphical client must implement automatic profile update (default interval is 60 minutes) and HTTP Basic
    29    authorization.
    30  
    31  At the same time, the graphical client must provide support for importing remote profiles
    32  through a specific URL Scheme. The URL is defined as follows:
    33  
    34  ```
    35  sing-box://import-remote-profile?url=urlEncodedURL#urlEncodedName
    36  ```
    37  
    38  ### Dashboard
    39  
    40  While the sing-box service is running, the graphical client should provide a Dashboard interface to manage the service.
    41  
    42  #### Status
    43  
    44  Dashboard should display status information such as memory, connection, and traffic.
    45  
    46  #### Mode
    47  
    48  Dashboard should provide a Mode selector for switching when the configuration uses at least two `clash_mode` values.
    49  
    50  #### Groups
    51  
    52  When the configuration includes group outbounds (specifically, Selector or URLTest),
    53  the dashboard should provide a Group selector for status display or switching.
    54  
    55  ### Chore
    56  
    57  #### Core
    58  
    59  Graphical clients should provide a Core region:
    60  
    61  * Display the current sing-box version
    62  * Provides a button to clean the working directory
    63  * Provides a memory limiter switch