From 9b12e3e38919605d025e3e311d56017255fed087 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Thu, 6 Apr 2023 12:42:57 +0800 Subject: [PATCH] Update client documentation --- docs/installation/clients/sfa.md | 16 ++++++++++++++++ docs/installation/clients/sfa.zh.md | 16 ++++++++++++++++ .../clients/{sfi/index.md => sfi.md} | 7 ++++--- .../clients/{sfi/index.zh.md => sfi.zh.md} | 7 ++++--- mkdocs.yml | 4 ++-- 5 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 docs/installation/clients/sfa.md create mode 100644 docs/installation/clients/sfa.zh.md rename docs/installation/clients/{sfi/index.md => sfi.md} (59%) rename docs/installation/clients/{sfi/index.zh.md => sfi.zh.md} (55%) diff --git a/docs/installation/clients/sfa.md b/docs/installation/clients/sfa.md new file mode 100644 index 00000000..5d274846 --- /dev/null +++ b/docs/installation/clients/sfa.md @@ -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 diff --git a/docs/installation/clients/sfa.zh.md b/docs/installation/clients/sfa.zh.md new file mode 100644 index 00000000..41dcf8d9 --- /dev/null +++ b/docs/installation/clients/sfa.zh.md @@ -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)` diff --git a/docs/installation/clients/sfi/index.md b/docs/installation/clients/sfi.md similarity index 59% rename from docs/installation/clients/sfi/index.md rename to docs/installation/clients/sfi.md index e8708c8a..ada1efe7 100644 --- a/docs/installation/clients/sfi/index.md +++ b/docs/installation/clients/sfi.md @@ -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 diff --git a/docs/installation/clients/sfi/index.zh.md b/docs/installation/clients/sfi.zh.md similarity index 55% rename from docs/installation/clients/sfi/index.zh.md rename to docs/installation/clients/sfi.zh.md index 0d164e9a..61487263 100644 --- a/docs/installation/clients/sfi/index.zh.md +++ b/docs/installation/clients/sfi.zh.md @@ -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)` #### 隐私政策 diff --git a/mkdocs.yml b/mkdocs.yml index 66b2f0df..c458c47b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: