-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
documentation: Bump version & Refactor docs
- Loading branch information
1 parent
8060b30
commit e48e5a3
Showing
83 changed files
with
1,600 additions
and
1,716 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # :material-decagram: Features | ||
|
|
||
| #### UI options | ||
|
|
||
| * Display realtime network speed in the notification | ||
|
|
||
| #### Service | ||
|
|
||
| SFA allows you to run sing-box through ForegroundService or VpnService (when TUN is required). | ||
|
|
||
| #### TUN | ||
|
|
||
| SFA provides an unprivileged TUN implementation through Android VpnService. | ||
|
|
||
| | TUN inbound option | Available | Note | | ||
| |-------------------------------|-----------|--------------------| | ||
| | `interface_name` | ✖️ | Managed by Android | | ||
| | `inet4_address` | ✔️ | / | | ||
| | `inet6_address` | ✔️ | / | | ||
| | `mtu` | ✔️ | / | | ||
| | `auto_route` | ✔️ | / | | ||
| | `strict_route` | ✖️ | Not implemented | | ||
| | `inet4_route_address` | ✔️ | / | | ||
| | `inet6_route_address` | ✔️ | / | | ||
| | `inet4_route_exclude_address` | ✔️ | / | | ||
| | `inet6_route_exclude_address` | ✔️ | / | | ||
| | `endpoint_independent_nat` | ✔️ | / | | ||
| | `stack` | ✔️ | / | | ||
| | `include_interface` | ✖️ | No permission | | ||
| | `exclude_interface` | ✖️ | No permission | | ||
| | `include_uid` | ✖️ | No permission | | ||
| | `exclude_uid` | ✖️ | No permission | | ||
| | `include_android_user` | ✖️ | No permission | | ||
| | `include_package` | ✔️ | / | | ||
| | `exclude_package` | ✔️ | / | | ||
| | `platform` | ✔️ | / | | ||
|
|
||
| ### Override | ||
|
|
||
| Overrides profile configuration items with platform-specific values. | ||
|
|
||
| #### Per-app proxy | ||
|
|
||
| SFA allows you to select a list of Android apps that require proxying or bypassing in the graphical interface to | ||
| override the `include_package` and `exclude_package` configuration items. | ||
|
|
||
| In particular, the selector also provides the “China apps” scanning feature, providing Chinese users with an excellent | ||
| experience to bypass apps that do not require a proxy. Specifically, by scanning China application or SDK | ||
| characteristics through dex class path and other means, there will be almost no missed reports. | ||
|
|
||
| ### Chore | ||
|
|
||
| * The working directory is located at `/sdcard/Android/data/io.nekohasekai.sfa/files` (External files directory) | ||
| * Crash logs is located in `$working_directory/stderr.log` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # :material-android: sing-box for Android | ||
|
|
||
| SFA allows users to manage and run local or remote sing-box configuration files, and provides | ||
| platform-specific function implementation, such as TUN transparent proxy implementation. | ||
|
|
||
| ## :material-graph: Requirements | ||
|
|
||
| * Android 5.0+ | ||
|
|
||
| ## :material-download: Download | ||
|
|
||
| * [Play Store](https://play.google.com/store/apps/details?id=io.nekohasekai.sfa) | ||
| * [Play Store (Beta)](https://play.google.com/apps/testing/io.nekohasekai.sfa) | ||
| * [Github Releases](https://github.com/SagerNet/sing-box/releases) | ||
|
|
||
| ## :material-source-repository: Source code | ||
|
|
||
| * [Github](https://github.com/SagerNet/sing-box-for-android) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # :material-decagram: Features | ||
|
|
||
| #### UI options | ||
|
|
||
| * Always On | ||
| * Include All Networks (Proxy traffic for LAN and cellular services) | ||
| * (Apple tvOS) Import profile from iPhone/iPad | ||
|
|
||
| #### Service | ||
|
|
||
| SFI/SFM/SFT allows you to run sing-box through NetworkExtension with Application Extension or System Extension. | ||
|
|
||
| #### TUN | ||
|
|
||
| SFI/SFM/SFT provides an unprivileged TUN implementation through NetworkExtension. | ||
|
|
||
| | TUN inbound option | Available | Note | | ||
| |-------------------------------|-----------|-------------------| | ||
| | `interface_name` | ✖️ | Managed by Darwin | | ||
| | `inet4_address` | ✔️ | / | | ||
| | `inet6_address` | ✔️ | / | | ||
| | `mtu` | ✔️ | / | | ||
| | `auto_route` | ✔️ | / | | ||
| | `strict_route` | ✖️ | Not implemented | | ||
| | `inet4_route_address` | ✔️ | / | | ||
| | `inet6_route_address` | ✔️ | / | | ||
| | `inet4_route_exclude_address` | ✔️ | / | | ||
| | `inet6_route_exclude_address` | ✔️ | / | | ||
| | `endpoint_independent_nat` | ✔️ | / | | ||
| | `stack` | ✔️ | / | | ||
| | `include_interface` | ✖️ | Not implemented | | ||
| | `exclude_interface` | ✖️ | Not implemented | | ||
| | `include_uid` | ✖️ | Not implemented | | ||
| | `exclude_uid` | ✖️ | Not implemented | | ||
| | `include_android_user` | ✖️ | Not implemented | | ||
| | `include_package` | ✖️ | Not implemented | | ||
| | `exclude_package` | ✖️ | Not implemented | | ||
| | `platform` | ✔️ | / | | ||
|
|
||
| ### Chore | ||
|
|
||
| * Crash logs is located in `Settings` -> `View Service Log` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # :material-apple: sing-box for Apple platforms | ||
|
|
||
| SFI/SFM/SFT allows users to manage and run local or remote sing-box configuration files, and provides | ||
| platform-specific function implementation, such as TUN transparent proxy implementation. | ||
|
|
||
| ## :material-graph: Requirements | ||
|
|
||
| * iOS 15.0+ / macOS 13.0+ / Apple tvOS 17.0+ | ||
| * An Apple account outside of mainland China | ||
|
|
||
| ## :material-download: Download | ||
|
|
||
| * [AppStore](https://apps.apple.com/us/app/sing-box/id6451272673) | ||
| * [TestFlight (Beta)](https://testflight.apple.com/join/AcqO44FH) | ||
|
|
||
| ## :material-source-repository: Source code | ||
|
|
||
| * [Github](https://github.com/SagerNet/sing-box-for-apple) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # :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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # :material-cellphone-link: Graphical Clients | ||
|
|
||
| Maintained by Project S to provide a unified experience and platform-specific functionality. | ||
|
|
||
| | Platform | Client | | ||
| |---------------------------------------|-----------------------------------------| | ||
| | :material-android: Android | [sing-box for Android](./android) | | ||
| | :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | | ||
| | TODO | / | | ||
|
|
||
| Some third-party projects that claim to use sing-box or use sing-box as a selling point are not listed here. The core | ||
| motivation of the maintainers of such projects is to acquire more users, and even though they provide friendly VPN | ||
| client features, the code is usually of poor quality and contains ads. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # :material-cellphone-link: 图形界面客户端 | ||
|
|
||
| 由 Project S 维护，提供统一的体验与平台特定的功能。 | ||
|
|
||
| | 平台 | 客户端 | | ||
| |---------------------------------------|-----------------------------------------| | ||
| | :material-android: Android | [sing-box for Android](./android) | | ||
| | :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | | ||
| | TODO | / | | ||
|
|
||
| 此处没有列出一些声称使用或以 sing-box 为卖点的第三方项目。此类项目维护者的动机是获得更多用户，即使它们提供友好的商业 | ||
| VPN 客户端功能， 但代码质量很差且包含广告。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # :material-security: Privacy policy | ||
|
|
||
| sing-box and official graphics clients do not collect or share personal data, | ||
| and the data generated by the software is always on your device. |
Oops, something went wrong.