Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Finb committed Dec 17, 2024
1 parent ea776ed commit 94cae17
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ APP在维持期间,不会有任何形式的收费与广告,各位彦祖放
- **服务端**
- [部署服务](/deploy)
- [直接推送](/apns)
- [批量推送](/batch)
- [编译代码](/build)
- [推送证书](/cert)
- [隐私安全](/privacy)
3 changes: 2 additions & 1 deletion docs/batch.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ bark-server 对配置要求很低,以下是美西 VPS 各配置下的 QPS 测

如果服务的 QPS 不高于 200,可继续使用公共服务(https://api.day.app)。

若 QPS 超过 200,未来在公共服务器负载过高时,可能会引入流量限制(目前尚未限制)。
若 QPS 超过 200,推荐自建服务端,未来在公共服务器负载过高时,可能会引入流量限制(目前尚未限制)。
若 QPS 超过3000,尽量自建服务端,部署时添加 --max-apns-client-count 参数,详情请查看[部署文档](/deploy)
36 changes: 36 additions & 0 deletions docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ chmod +x bark-server_linux_amd64
```
请注意 bark-server 默认使用 /data 目录保存数据,请确保 bark-server 有权限读写 /data 目录,或者你可以使用 `-data` 选项指定一个目录


## Cloudflare Worker
[https://github.com/cwxiaos/bark-worker](https://github.com/cwxiaos/bark-worker)


## Serverless


Expand Down Expand Up @@ -93,6 +98,37 @@ curl http://0.0.0.0:8080/ping
```
返回 pong 就证明部署成功了

## 大批量推送(普通用户忽略,QPS超过 3000 再使用)
如果你需要短时间大批量推送,可以配置 bark-server 使用多个 APNS Clients 推送,
每一个 Client 代表一个新的连接(可能连接到不同的APNs服务器),请根据 CPU 核心数设置这个参数,Client 数量不能超过CPU核心数(超过会自动设置为当前 CPU 核心数)。

配置方法:
#### Docker
```
docker run -dt --name bark -p 8080:8080 -v `pwd`/bark-data:/data finab/bark-server bark-server --max-apns-client-count 4
```

#### Docker-Compose
```yaml
version: '3.8'
services:
bark-server:
image: finab/bark-server
container_name: bark-server
restart: always
volumes:
- ./data:/data
ports:
- "8080:8080"
command: bark-server --max-apns-client-count 4
```
#### 手动部署
```
./bark-server --addr 0.0.0.0:8080 --data ./bark-data --max-apns-client-count 4
```


## 其他

1. APP端负责将<a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622958-application">DeviceToken</a>发送到服务端。 <br>服务端收到一个推送请求后,将发送推送给Apple服务器。然后手机收到推送
Expand Down

0 comments on commit 94cae17

Please sign in to comment.