Gorush 消息推送服务器搭建与使用教程

1. 项目目录结构及介绍

在Gorush项目的根目录中，主要的文件和目录包括:

• cmd/gorush: 主入口文件，用于启动Gorush服务器。
• config: 存放配置文件模板的例子。
• internal: 包含内部使用的函数和组件。
  • handler: 处理HTTP请求的相关代码。
  • model: 数据模型定义。
  • queue: 通知队列处理逻辑。
• rpc: gRPC相关服务定义和实现。
  • proto: 服务的protobuf协议描述文件。
• web: 提供了简单的web界面以展示统计信息。

2. 项目启动文件介绍

Gorush的启动文件是cmd/gorush/main.go。这个文件定义了服务器的主要功能，包括初始化配置、加载证书、设置日志以及启动HTTP和gRPC服务器。你可以通过以下命令启动Gorush服务：

./gorush

其中，gorush是编译后的可执行文件。如果你使用的是Docker，则可以通过Docker镜像来运行：

docker run -it --rm -p 3000:3000 appleboy/gorush

这里，-p 3000:3000映射端口，appleboy/gorush是Docker镜像名称。

3. 项目配置文件介绍

Gorush允许通过YAML配置文件定制其行为。配置文件默认位于$GOPATH/etc/gorush.yml或者$HOME/.gorush.yml。如果没有找到配置文件，它会使用默认值。

以下是一个配置文件的示例：

app:
  env: development
  host: 0.0.0.0
  port: 3000
  secret_key: "your_secret_key"

apns:
  enabled: true
  key_path: "/path/to/apns.pem"
  cert_path: "/path/to/cert.pem"
  production: true
  gateway: gateway.push.apple.com
  port: 2195
  feedback_gateway: feedback.push.apple.com
  feedback_port: 2196
  topic: "com.example.app"

fcm:
  enabled: true
  api_key: "your_firebase_api_key"

hms:
  enabled: true
  app_id: "your_hms_app_id"
  app_secret: "your_hms_app_secret"
  url: "https://api.hicloud.com/hmscore/appmsgpush/v1/send"

logging:
  level: debug
  output: stdout
  json_format: false

grpc:
  enabled: true
  listen_address: "0.0.0.0:3001"

请注意替换示例中的路径和密钥为实际值。配置项如env, host, port分别代表应用环境、主机地址和监听端口，而apns, fcm, hms则对应不同平台的通知服务配置。

在启动Gorush时，可以通过-c选项指定配置文件路径：

./gorush -c /path/to/gorush.yml

了解这些基本部分后，你可以开始设置并部署Gorush，以便为你的应用提供推送通知服务。更多详细信息和高级用法，请参考项目官方文档和源代码。