Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mercari/gaurun
General push notification server in Go
https://github.com/mercari/gaurun
apns gcm push-notifications
Last synced: 13 days ago
JSON representation
General push notification server in Go
- Host: GitHub
- URL: https://github.com/mercari/gaurun
- Owner: mercari
- License: mit
- Archived: true
- Created: 2015-04-16T03:53:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T07:18:19.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T16:18:08.297Z (3 months ago)
- Topics: apns, gcm, push-notifications
- Language: Go
- Homepage:
- Size: 461 KB
- Stars: 930
- Watchers: 74
- Forks: 113
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gaurun [][release] 
[release]: https://github.com/mercari/gaurun/releases
Gaurun is a general push notification server written in Golang. It proxies push requests to APNs and FCM and asynchronously executes them via HTTP/2. It helps you when you need to bulkly sends push notification to your users (e.g., when you need to exec 10 million push at once!) or when some other API server which must response quickly needs to push. Since it leverages Golang's powerful concurrent feature, it gives high performance.
In addition to performance, it's important not to lost pushes over sever crashes or hardware failures. Gaurun can use its access log for kind of transaction journal and can re-push only failed notification later (We provide a special command for this. See [Usage](#usage)).
Currently we support the following platforms:
- [Apple APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html)
- [Google FCM](https://firebase.google.com/docs/cloud-messaging/)
## Status
Production ready.
## Installation
There are two way to install Gaurun; using a precompiled binary or install from source. Downloading a precompiled binary is easiest and recommended.
To install a precompiled binary, download the appropriate zip package for your OS and architecture from [here](https://github.com/mercari/gaurun/releases). Once the zip is downloaded, unzip it and place the binary where you want to use (if you want to access it from the command-line, make sure to put it on `$PATH`).
To compile from source, you need Go1.15 or later. After setup, then clone the source code by running the following command,
```bash
$ git clone https://github.com/mercari/gaurun.git
```
To fetch dependencies and build, run the following make tasks,
```bash
make
```
## Usage
To run `gaurun`, you must provide configuration path via `-c` option (See [CONFIGURATION.md](/CONFIGURATION.md) about details),
```bash
$ bin/gaurun -c conf/gaurun.toml
```
Use `-help` to see more options.
### Crash Recovery
Gaurun can recover from server crashes or hardware failures while pushing. It can use its access log for kind of transaction journal and can re-push only failed notifications later. We provide the special command for this, use it like the following (assuming that access log is generated to `/tmp/gaurun.log`),
```bash
$ bin/gaurun_recover -c conf/gaurun.toml -l /tmp/gaurun.log
```
## Configuration
See [CONFIGURATION.md](/CONFIGURATION.md) about details.
*NOTE*: The default configuration is just for development and not high performant. For production usage, tune the performance with some parameters such as `workers` and `queues` and `pusher_max` in the `core` section.
## Specification
API specification is defined on [SPEC.md](/SPEC.md).
## Contribution
Please read the CLA below carefully before submitting your contribution.
https://www.mercari.com/cla/
## License
Copyright 2014-2019 Mercari, Inc.
Licensed under the MIT License.