update docs

This commit is contained in:
Fin 2023-02-15 12:20:23 +08:00
parent d1a2292694
commit 9a53ed3dcb
No known key found for this signature in database
GPG Key ID: CFB59B99D87A7B93
2 changed files with 29 additions and 22 deletions

BIN
docs/_media/environment.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 151 KiB

View File

@ -26,26 +26,6 @@ chmod +x bark-server_linux_amd64
```
请注意 bark-server 默认使用 /data 目录保存数据,请确保 bark-server 有权限读写 /data 目录,或者你可以使用 `-data` 选项指定一个目录
## Render
Render 能非常简单的创建免费的 bark-server
1. [注册](https://dashboard.render.com/register/)一个Render账号
2. 创建一个 [New Web Service](https://dashboard.render.com/select-repo?type=web)
3. 在底部的 **Public Git repository** 输入框输入下面的URL
```
https://github.com/Finb/bark-server
```
4. 点击 **Continue** 输入表单
* Name - 名称,随便取个名字,例如 bark-server
* Region - 服务器地区,选择离你近的
* Start Command - 程序执行命令,填`./app -addr 0.0.0.0:8080 -data ./bark-data`。(注意不要漏了 ./app 前面的点)
* Instance Type - 选 Free ,免费的足够用了。
* 其他的默认不动
5. 点击底部的 Create Web Service 按钮,等待几分钟,状态从 In progress 变成 Live
6. 页面顶部找到你的服务器URL这个就是bark-server服务器URL在Bark App 中添加即可
```
https://[your-server-name].onrender.com
```
7. 如果添加失败,可以等待一段时间再试,有可能服务还没准备好。
## Serverless
@ -63,11 +43,38 @@ https://[your-server-name].onrender.com
请注意 Serverless 模式只允许一台设备使用
## 使用
## Render
Render 能非常简单的创建免费的 bark-server
1. [注册](https://dashboard.render.com/register/)一个 Render 账号
2. 创建一个 [New Web Service](https://dashboard.render.com/select-repo?type=web)
3. 在底部的 **Public Git repository** 输入框输入下面的URL
```
https://github.com/Finb/bark-server
```
4. 点击 **Continue** 输入表单
* Name - 名称,随便取个名字,例如 bark-server
* Region - 服务器地区,选择离你近的
* Start Command - 程序执行命令,填`./app -serverless true`。(注意不要漏了 ./app 前面的点)
* Instance Type - 选 Free ,免费的足够用了。
* 点击 Advanced 展开更多选项
* 点击 Add Environment Variable 添加 Serverless 模式需要的 BARK_KEY 和 BARK_DEVICE_TOKEN 字段。 (填写要求参考 [Serverless](#Serverless)) <br><img src="../_media/environment.png" />
* 其他的默认不动
5. 点击底部的 Create Web Service 按钮,然后等待状态从 In progress 变成 Live可能需要几分钟到十几分钟。
6. 页面顶部找到你的服务器URL这个就是bark-server服务器URL在 Bark App 中添加即可
```
https://[your-server-name].onrender.com
```
7. 如果添加失败,可以等待一段时间再试,有可能服务还没准备好。
8. 不添加到 Bark App 中也可以直接调用就能发推送。BARK_KEY 就是上面环境变量中你填写的。
```
https://[your-server-name].onrender.com/BARK_KEY/推送内容
```
## 测试
```
curl http://0.0.0.0:8080/ping
```
Ping成功后在APP端填入你的服务器IP或域名
返回 pong 就证明部署成功了
## 其他