Skip to content

Latest commit

 

History

History
84 lines (49 loc) · 1.76 KB

README.md

File metadata and controls

84 lines (49 loc) · 1.76 KB

Gaurun

logo

Gaurun is the general push notification server in Go.

Status

Gaurun is production ready.

Requirements

Gaurun requires Go1.6.2 or later.

Supported Platforms

Gaurun sends notifications to these platforms by HTTP/2.

Installation

go get -u github.com/togetter/gaurun/...

Build from source code

glide is required for building Gaurun.

go get -u github.com/Masterminds/glide

Run the commands below.

make bundle
make

Configuration

See CONFIGURATION.md about details.

The configuration for gaurun is conservative by default. If you require higher performance of gaurun, you can tune the performance with some parameters such as workers and queues and pusher_max in the core section.

Specification

See SPEC.md about details.

Run

bin/gaurun -c conf/gaurun.toml

Crash Recovery

Gaurun supports re-push notifications lost by server-crash with access.log.

bin/gaurun_recover -c conf/gaurun.toml -l /tmp/gaurun.log

Committers

Contribution

Please read the CLA below carefully before submitting your contribution.

https://www.mercari.com/cla/

License

Copyright 2014-2016 Mercari, Inc.

Licensed under the MIT License.