black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-25 10:01:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update client documentation

Browse source
This commit is contained in:
世界 2023-04-06 12:42:57 +08:00
parent afd3464216
commit 9b12e3e389
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
5 changed files with 42 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/installation/clients/sfa.md Normal file
View file

@ -0,0 +1,16 @@
# SFA
Experimental Android client for sing-box.
#### Requirements
* Android 5.0+
#### Download
* [AppCenter](https://install.appcenter.ms/users/nekohasekai/apps/sfa/distribution_groups/publictest)
#### Note
* Working directory is at `/sdcard/Android/data/io.nekohasekai.sfa/files` (External files directory)
* User Agent is `SFA/$version ($version_code; sing-box $sing_box_version)` in the remote profile request

16
docs/installation/clients/sfa.zh.md Normal file
View file

@ -0,0 +1,16 @@
# SFA
实验性的 Android sing-box 客户端。
#### 要求
* Android 5.0+
#### 下载
* [AppCenter](https://install.appcenter.ms/users/nekohasekai/apps/sfa/distribution_groups/publictest)
#### 注意事项
* 工作目录位于 `/sdcard/Android/data/io.nekohasekai.sfa/files` (外部文件目录)
* 远程配置文件请求中的 User Agent 为 `SFA/$version ($version_code; sing-box $sing_box_version)`

7
docs/installation/clients/sfi/index.md → docs/installation/clients/sfi.md
View file

@ -1,6 +1,6 @@
# SFI
Experimental official iOS client for sing-box.
Experimental iOS client for sing-box.
#### Requirements
@ -11,9 +11,10 @@ Experimental official iOS client for sing-box.
* [TestFlight](https://testflight.apple.com/join/c6ylui2j)
#### Limit
#### Note
* `system` tun stack not working
* `system` tun stack not working on iOS
* User Agent is `SFI/$version ($version_code; sing-box $sing_box_version)` in the remote profile request
#### Privacy policy

7
docs/installation/clients/sfi/index.zh.md → docs/installation/clients/sfi.zh.md
View file

@ -1,6 +1,6 @@
# SFI
实验性的官方 iOS sing-box 客户端。
实验性的 iOS sing-box 客户端。
#### 要求
@ -11,9 +11,10 @@
* [TestFlight](https://testflight.apple.com/join/c6ylui2j)
#### 限制
#### 注意事项
* `system` tun stack 不工作
* `system` tun stack 在 iOS 不工作
* 远程配置文件请求中的 User Agent 为 `SFI/$version ($version_code; sing-box $sing_box_version)`
#### 隐私政策

4
mkdocs.yml
View file

@ -38,8 +38,8 @@ nav:
- Installation:
- From source: installation/from-source.md
- Clients:
- SFI:
- installation/clients/sfi/index.md
- iOS: installation/clients/sfi.md
- Android: installation/clients/sfa.md
- Configuration:
- configuration/index.md
- Log: