-1
日增长
8,799
stars
884
forks
183
watchers
518
prs
360
issues
58
releases
README
gorush
A push notification micro server using Gin framework written in Go (Golang) and see the demo app.
Quick Start
Get started with gorush in 3 simple steps:
bash
1. Download the latest binary
wget https://github.com/appleboy/gorush/releases/download/v1.18.9/gorush-1.18.9-linux-amd64 -O gorush
chmod +x gorush
2. Start the server (default port 8088)
./gorush
3. Send your first notification
curl -X POST http://localhost:8088/api/push \
-H "Content-Type: application/json" \
-d '{
"notifications": [{
"tokens": ["your_device_token"],
"platform": 2,
"title": "Hello World",
"message": "Your first notification!"
}]
}'
Contents
- Quick Start - Get up and running in 3 steps
- Support Platform - iOS, Android, Huawei
- Features - What gorush can do
- Configuration - YAML config and options
- Basic Configuration
- Advanced Configuration
- Installation - Binary, package managers, Docker, source
- Recommended: Install Script
- Manual Download
- Package Managers
- Build from Source
- Docker
- Usage - CLI commands and REST API examples
- Starting the Server
- Command Line Notifications
- REST API Usage
- CLI Options Reference
- Web API - Complete API reference
- Overview
- Send Notifications
- Statistics APIs
- Request Parameters
- Deployment - Docker, Kubernetes, AWS Lambda, gRPC
- Docker Deployment
- Kubernetes
- AWS Lambda
- Netlify Functions
- gRPC Service
- FAQ - Common issues and best practices
- Common Issues
- Performance Tips
- Security Best Practices
- Stargazers over time
- License
Support Platform
📱 Platform codes: 1 = iOS (APNS), 2 = Android (FCM), 3 = Huawei (HMS)
- APNS
- FCM
- HMS
A live server on Netlify and get notification token on Firebase Cloud Messaging web. You can use the token to send a notification to the device.
bash
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"notifications": [
{
"tokens": [
"your_device_token"
],
"platform": 2,
"title": "Test Title",
"message": "Test Message"
}
]
}' \
https://gorush.netlify.app/api/push
Features
- Support Firebase Cloud Messaging using go-fcm library for Android.
- Support HTTP/2 Apple Push Notification Service using apns2 library.
- Support HMS Push Service using go-hms-push library for Huawei Devices.
- Support YAML configuration.
- Support command line to send single Android or iOS notification.
- Support Web API to send push notification.
- Support HTTP/2 or HTTP/1.1 protocol.
- Support notification queue and multiple workers.
- Support /api/stat/app show notification success and failure counts.
- Support /api/config show your YAML config.
- Support store app stat to memory, Redis, BoltDB, BuntDB, LevelDB or BadgerDB.
- Support p8, p12 or pem format of iOS certificate file.
- Support /sys/stats show response time, status code count, etc.
- Support for HTTP, HTTPS or SOCKS5 proxy.
- Support retry send notiTop issues
#248webpush support ?16 comments · 2017-07-14#547voip push12 comments · 2020-11-18#348Error logs for grpc push notification10 comments · 2018-04-10#102Support upload ios certificate file.10 comments · 2016-06-14#267Support compatible send to GCM?9 comments · 2017-08-08#512Question: TooManyProviderTokenUpdates from APNS 8 comments · 2020-05-20#269About error message from fail push notification in API response.6 comments · 2017-08-12#194Question: Support for standard websocket connections?7 comments · 2017-03-02
Discussions
#787Can we base64 encode the service account json for the new HTTP v1?0 comments · 2024-06-18#766Planning to add AppDynamics integration0 comments · 2024-05-21
Latest release
v1.22.0 v1.22.0 2026-07-25Changelog Features db13af35ffde7860e532af8f6c98fab6689043c1: feat(iOS): add support for iOS Live Activity push-to-start payloads (879) (@johnsharp97)