capcom6/sms-gateway

Android™短信网关服务器

该服务器作为https://github.com/capcom6/android-sms-gateway%E7%9A%84%E5%90%8E%E7%AB%AF%E7%BB%84%E4%BB%B6%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87%E8%BF%9E%E6%8E%A5%E7%9A%84Android%E8%AE%BE%E5%A4%87%E5%8F%91%E9%80%81%E7%9F%AD%E4%BF%A1%E3%80%82%E5%AE%83%E5%8C%85%E5%90%AB%E7%94%A8%E4%BA%8E%E6%B6%88%E6%81%AF%E7%AE%A1%E7%90%86%E7%9A%84RESTful API、与Firebase云消息传递(FCM)的集成以及用于持久存储的数据库。

目录

• Android™短信网关服务器
  • 目录
  • 功能
  • 先决条件
  • 快速入门
  • 工作模式
  • 贡献
  • 许可证
  • ***声明

功能

• 短信发送：通过RESTful API发送短信。
• 消息状态：检索已发送消息的状态。
• 设备管理：查看有关已连接Android设备的信息。
• Web钩子：配置用于事件驱动通知的Web钩子。
• 健康监控：访问健康检查端点以确保系统完整性。
• 访问控制：可在公共模式（开放访问）或私有模式（受限访问）下运行。

先决条件

• Go（用于开发和测试）
• Docker和Docker Compose（用于基于Docker的设置）
• 已配置的MySQL/MariaDB数据库

快速入门

使用私有模式下的Docker设置是启动服务器的最简单方法。在此模式下，设备注册端点受到保护，因此不知道令牌的人无法注册新设备。

1. 设置MySQL或MariaDB数据库。
2. 基于config.example.yml创建config.yml。最重要的部分是database、http和gateway。环境变量可用于覆盖配置文件中的值。
   1. 在gateway.mode部分设置为private。
   2. 在gateway.private_token部分设置私有模式下设备注册的访问令牌。启用私有模式的设备必须设置此令牌。
3. 在Docker中启动服务器：docker run -p 3000:3000 -v ./config.yml:/app/config.yml capcom6/sms-gateway:latest。
4. 在设备上设置私有模式。
5. 使用与公共服务器api.sms-gate.app相同的API来使用已启动的私有服务器。

另请参见docker-compose.yml以获取基于Docker的设置。

工作模式

服务器有两种工作模式：公共模式和私有模式。公共模式允许***设备注册，并在api.sms-gate.app上使用。私有模式可用于发送敏感消息并在本地基础设施中运行服务器。

在大多数操作中，公共模式和私有模式是相同的。但存在一些区别：

• POST /api/mobile/v1/device端点在私有模式下受API密钥保护。因此，不知道令牌的人无法在私有服务器上注册新设备。
• 私有服务器的FCM通知通过api.sms-gate.app发送。通知不包含任何敏感数据，如电话号码或消息文本。

另请参见https://github.com/capcom6/android-sms-gateway/issues/20%E3%80%82

贡献

贡献是开源社区成为学习、启发和创造的绝佳场所的原因。您的任何贡献都将受到高度赞赏。

如果您有改进建议，请Fork仓库并创建拉取请求。您也可以简单地打开一个带有"enhancement"标签的issue。不要忘记给项目点赞！再次感谢！

1. Fork本项目
2. 创建功能分支（git checkout -b feature/AmazingFeature）
3. 提交更改（git commit -m 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 打开拉取请求

许可证

根据Apache-2.0许可证分发。有关更多信息，请参见LICENSE。

***声明

Android是Google LLC的商标。