finab/bark-server

Bark

https://github.com/Finb/Bark 是一款允许向iPhone推送自定义通知的iOS应用。bark-server作为其配套后端服务，用于接收并处理推送请求，支持私有部署，适用于个人或团队搭建自定义通知推送服务。

目录

• Bark
  • 安装
    • Docker用户
    • 普通用户
    • 开发者
    • Nginx代理配置
  • API V2
  • 其他文档
  • 参与贡献
    • 开发环境
  • 更新说明

安装

Docker用户

!https://img.shields.io/docker/automated/finab/bark-server.svg !https://img.shields.io/microbadger/image-size/finab/bark-server.svg !https://img.shields.io/microbadger/layers/finab/bark-server.svg

已提供Docker镜像，可通过以下命令运行bark服务器：

sh
docker run -dt --name bark -p 8080:8080 -v `pwd`/bark-data:/data docker.xuanyuan.run/finab/bark-server

参数说明：-dt后台运行，--name指定容器名称为bark，-p映射容器8080端口到主机8080端口，-v将主机当前目录下的bark-data目录挂载到容器/data目录（用于数据持久化）。

若使用docker-compose，可将项目下的docker-compose.yaml复制到任意目录并运行：

sh
mkdir bark-server && cd bark-server
curl -sL https://git.io/JvSRl > docker-compose.yaml
docker-compose up -d

普通用户

1. 从https://github.com/Finb/bark-server/releases%E4%B8%8B%E8%BD%BD%E9%A2%84%E7%BC%96%E8%AF%91%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6
2. 为bark-server二进制文件添加可执行权限：chmod +x bark-server
3. 启动bark-server：./bark-server --addr 0.0.0.0:8080 --data ./bark-data
4. 测试服务器：curl localhost:8080/ping

注意：bark-server默认使用/data目录存储数据。确保bark-server对/data目录有写入权限，否则使用-d选项指定其他目录。

开发者

开发者可自行编译项目，编译需以下依赖：

• Golang 1.16+
• 启用Go Mod（环境变量GO111MODULE=on）
• 启用Go Mod代理（环境变量GOPROXY=https://goproxy.cn）
• 安装make工具

运行以下命令编译项目：

sh
# 跨平台编译所有版本
make

# 或安装到本地GOPATH
make install

Nginx代理配置

多数用户希望将bark服务器部署在内网，再通过Nginx反向代理。以下是简单的Nginx配置示例（假设bark服务器监听192.168.1.123:8080）：

sh
# 生成于2020-03-26，遵循Mozilla Guideline v5.4，nginx 1.17.7，OpenSSL 1.1.1d，现代配置
# https://ssl-config.mozilla.org/#server=nginx&version=1.17.7&config=modern&openssl=1.1.1d&guideline=5.4
server {
    listen 80;
    listen [::]:80;
    # 替换bark.app.dev为你的实际域名
    server_name bark.app.dev;

    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    # 替换bark.app.dev为你的实际域名
    server_name bark.app.dev;

    ssl_certificate /path/to/signed_cert_plus_intermediates;
    ssl_certificate_key /path/to/private_key;
    ssl_session_timeout 1d;
    ssl_session_cache shared:MozSSL:10m;  # 约40000个会话
    ssl_session_tickets off;

    # 现代配置
    ssl_protocols TLSv1.3;
    ssl_prefer_server_ciphers off;

    # HSTS（需启用ngx_http_headers_module）（63072000秒）
    add_header Strict-Transport-Security "max-age=63072000" always;

    # OCSP stapling
    ssl_stapling on;
    ssl_stapling_verify on;

    # 使用根CA和中间证书验证OCSP响应的信任链
    ssl_trusted_certificate /path/to/root_CA_cert_plus_intermediates;

    # 替换为你的解析器IP地址
    #resolver 127.0.0.1;

    location / {

        log_not_found on;
        # 替换http://192.168.1.123:8080为bark服务器的监听地址
        proxy_pass http://192.168.1.123:8080;

        proxy_read_timeout 300;
        proxy_connect_timeout 300;
        proxy_redirect off;

        proxy_set_header Host              $host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Real-IP         $remote_addr;

    }
}

API V2

请阅读API_V2.md。

其他文档

中文：

• https://day.app/2018/06/bark-server-document/

参与贡献

开发环境

本项目至少需要golang 1.12版本编译，并需支持Go mod。

• Golang 1.16
• GoLand 2020.3或其他Go IDE
• Docker（可选）

更新说明

程序中嵌入的推送证书永不过期。仅当证书过期导致推送失败时，才需要更新程序。