coopgo-platform
/
gorush
7
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

docs: update readme.

This commit is contained in:
Bo-Yi Wu 2017-01-21 16:08:30 +08:00
parent 2a00ed77ad
commit a34e92ba4e
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -50,6 +50,7 @@ A push notification micro server using [Gin](https://github.com/gin-gonic/gin) f
* Support `/sys/stats` show response time, status code count, etc. * Support `/sys/stats` show response time, status code count, etc.
* Support for HTTP proxy to Google server (GCM). * Support for HTTP proxy to Google server (GCM).
* Support retry send notification if server response is fail. * Support retry send notification if server response is fail.
* Support expose [prometheus](https://prometheus.io/) metrics.
See the [YAML config example](config/config.yml): See the [YAML config example](config/config.yml):
@ -75,6 +76,7 @@ api:
stat_app_uri: "/api/stat/app" stat_app_uri: "/api/stat/app"
config_uri: "/api/config" config_uri: "/api/config"
sys_stat_uri: "/sys/stats" sys_stat_uri: "/sys/stats"
metric_uri: "/metrics"
android: android:
enabled: true enabled: true
@ -160,6 +162,7 @@ Server Options:
-c, --config <file> Configuration file -c, --config <file> Configuration file
-m, --message <message> Notification message -m, --message <message> Notification message
-t, --token <token> Notification token -t, --token <token> Notification token
--title <title> Notification title
--proxy <proxy> Proxy URL (only for GCM) --proxy <proxy> Proxy URL (only for GCM)
--pid <pid path> Process identifier path --pid <pid path> Process identifier path
iOS Options: iOS Options:
@ -187,6 +190,7 @@ $ gorush -android -m="your message" -k="API Key" -t="Device token"
* `-m`: Notification message. * `-m`: Notification message.
* `-k`: [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) api key * `-k`: [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) api key
* `-t`: Device token. * `-t`: Device token.
* `--title`: Notification title.
* `--proxy`: Set http proxy url. (only working for GCM) * `--proxy`: Set http proxy url. (only working for GCM)
### Send iOS notification ### Send iOS notification
@ -200,8 +204,9 @@ $ gorush -ios -m="your message" -i="your certificate path" -t="device token" -to
* `-m`: Notification message. * `-m`: Notification message.
* `-i`: Apple Push Notification Certificate path (`pem` or `p12` file). * `-i`: Apple Push Notification Certificate path (`pem` or `p12` file).
* `-t`: Device token. * `-t`: Device token.
* `-topic`: The topic of the remote notification. * `--title`: Notification title.
* `-password`: The certificate password. * `--topic`: The topic of the remote notification.
* `--password`: The certificate password.
The default endpoint is APNs development. Please add `-production` flag for APNs production push endpoint. The default endpoint is APNs development. Please add `-production` flag for APNs production push endpoint.
@ -316,6 +321,12 @@ Show response time, status code count, etc.
} }
``` ```
### GET /metrics
Support expose [prometheus](https://prometheus.io/) metrics.
![metrics screenshot](screenshot/metrics.png)
### POST /api/push ### POST /api/push
Simple send iOS notification example, the `platform` value is `1`: Simple send iOS notification example, the `platform` value is `1`:

BIN
screenshot/metrics.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 144 KiB