diff --git a/docs/README.md b/docs/README.md index 6cff59f..b324c71 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ - 免费、轻量!简单调用接口即可给自己的iPhone发送推送。 - 依赖苹果APNs,及时、稳定、可靠 - 不会消耗设备的电量, 基于系统推送服务与推送扩展,APP本体并不需要运行。 -- 信任成本很昂贵,所以 Bark 默认所有人(但包含作者本人)都有可能窃取你的隐私,以此为基础来设计隐私保护。
*点击详细了解Bark如果保障[隐私安全](/privacy)* +- 信任成本很昂贵,所以 Bark 默认所有人(包含作者本人)都有可能窃取你的隐私,以此为基础来设计隐私保护。
*点击详细了解Bark如果保障[隐私安全](/privacy)* ### 源码 - [Bark](https://github.com/Finb/Bark) 是完整开源的 iOS APP,用来接收自定义推送。 @@ -21,5 +21,13 @@ APP在维持期间,不会有任何形式的收费与广告,各位彦祖放 目前仅接收 GitHub 赞助,同时非常感谢每一位赞助者
赞助者:[https://github.com/sponsors/Finb](https://github.com/sponsors/Finb) - - +### 文档 +- **App** + - [使用教程](/tutorial) + - [常见问题](/faq) +- **服务端** + - [部署服务](/deploy) + - [直接推送](/apns) + - [编译代码](/build) + - [推送证书](/cert) +- [隐私安全](/privacy) \ No newline at end of file diff --git a/docs/build.md b/docs/build.md index bca556f..5dd0ed0 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,5 +1,7 @@ ## 下载源码 -[bark-server](https://github.com/Finb/bark-server) +从GitHub下载源码 [bark-server](https://github.com/Finb/bark-server) + +或 ```sh git clone https://github.com/Finb/bark-server.git ``` diff --git a/docs/faq.md b/docs/faq.md index 4d03d92..6218dc5 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,27 +1,27 @@ -* #### 推送使用次数限制 +#### 推送使用次数限制 正常请求(HTTP状态码为200)无任何限制。
但如果在5分钟内超过1000次错误请求(HTTP状态码为400 404 500)IP会被 BAN 24小时 -* #### 时效性通知无效 +#### 时效性通知无效 可以尝试重启设备来解决。 -* #### 无法保存通知历史,或下拉推送没有点击复制按钮无法复制 +#### 无法保存通知历史,或下拉推送没有点击复制按钮无法复制 可以尝试重启设备来解决。
因某些原因导致推送服务扩展([UNNotificationServiceExtension](https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension))未能正常运行,执行通知保存的代码未能正常执行。 -* #### 自动复制推送失效 +#### 自动复制推送失效 iOS 14.5 之后的版本因权限收紧,不能在收到推送时自动复制推送内容到剪切板。
可暂时先下拉推送或在锁屏界面左滑推送点查看即可自动复制,或点击弹出的推送复制按钮。 -* #### 默认打开通知历史列表 +#### 默认打开通知历史列表 再次开启APP时,会跳转到上次打开的页面。
只需退出APP时,停留在历史消息页面,再次打开APP时就是历史消息页面。 -* #### 推送 API 是否支持 POST 请求? +#### 推送 API 是否支持 POST 请求? Bark支持 GET POST ,支持使用Json
无论哪种请求方式,参数名都一样, 参考[使用教程](/tutorial#请求方式) -* #### 推送特殊字符导致推送失败,比如 推送内容包含链接,或推送异常 比如 + 变成空格 +#### 推送特殊字符导致推送失败,比如 推送内容包含链接,或推送异常 比如 + 变成空格 这是因为整个链接不规范导致的问题,常发生在自己手动拼接URL时。
拼接URL时,注意将参数进行URL编码 @@ -43,5 +43,5 @@ Bark支持 GET POST ,支持使用Json
如果是使用成熟的HTTP库时,参数都会被自动处理,无需自己手动编码。
但如果是自己去拼接URL时,则需要特别注意参数中的特殊字符,最好不管有没有特殊字符,无脑套一层URL编码。 -* #### 如何保障隐私安全 +#### 如何保障隐私安全 参考[隐私安全](/privacy) diff --git a/docs/privacy.md b/docs/privacy.md index 1e9a9cc..372d324 100644 --- a/docs/privacy.md +++ b/docs/privacy.md @@ -3,7 +3,7 @@ 发送端 →服务端① → 苹果APNS服务器 → 你的设备 → Bark APP②。 红色的两处地方可能泄露隐私
-* 发送端未使用HTTPS或使用公共服务器(作者会看到请求日志) +* 发送端未使用HTTPS或使用公共服务器*(作者会看到请求日志)* * Bark App 本身不安全,上传到 App Store 的版本经过修改。 #### 解决服务端隐私问题 diff --git a/docs/tutorial.md b/docs/tutorial.md index 0410f1d..a361097 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -30,7 +30,7 @@ curl -X "POST" "https://api.day.app/your_key" \ -H 'Content-Type: application/json; charset=utf-8' \ -d $'{ "body": "Test Bark Server", - "title": "bleem", + "title": "Test Title", "badge": 1, "category": "myNotificationCategory", "sound": "minuet.caf", @@ -39,6 +39,18 @@ curl -X "POST" "https://api.day.app/your_key" \ "url": "https://mritd.com" }' ``` + +JSON 请求 key 可以放进请求体中,URL 路径须为 /push,例如 +```sh +curl -X "POST" "https://api.day.app/push" \ + -H 'Content-Type: application/json; charset=utf-8' \ + -d $'{ + "body": "Test Bark Server", + "title": "Test Title", + "device_key": "your_key" +}' +``` + ## 请求参数 支持的参数列表,具体效果可在APP内预览。