Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Guilherme Souza committed Sep 27, 2017
1 parent 3ce3d43 commit f66ed6f
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ make build
#### APNS

```bash
./bin/pusher apns --certificate <path-to-unified-certificate>/unified.pem --app <app-name> -d -p
./bin/pusher apns -d -p
```

#### GCM

```bash
./bin/pusher gcm --apiKey <api-key> --senderId <sender-id> --app <app-name> -d -p
./bin/pusher gcm -d -p
```

### Automated tests
Expand Down Expand Up @@ -118,20 +118,28 @@ Note: If you want to actually send the pushes you need to set `dry_run: false` (
To send the push using the fake data you need to start `pusher` in the correct mode (apns or gcm) and then produce to the Kafka topic and broker it will be listening to:

```bash
cat test.txt | kafka-console-producer --topic com.games.test --broker-list localhost:9941
cat test.txt | kafka-console-producer --topic push-game_gcm --broker-list localhost:9941
```

### Available Environment variables

Pusher reads from Kafka the push notifications that should be sent. The container takes environment variables to specify this connection:

* `PUSHER_QUEUE_TOPICS` - List of Kafka topics;
* `PUSHER_QUEUE_TOPICS` - List of Kafka topics, ex: `^push-[^-_]+_(apns|gcm)`
* `PUSHER_QUEUE_BROKERS` - List of Kafka brokers;
* `PUSHER_QUEUE_GROUP` - Kafka consumer group;
* `PUSHER_QUEUE_SESSIONTIMEOUT` - Kafka session timeout;
* `PUSHER_QUEUE_OFFSETRESETSTRATEGY` - Kafka offset reset strategy;
* `PUSHER_QUEUE_HANDLEALLMESSAGESBEFOREEXITING` - Boolean indicating if shutdown should wait for all messages to be handled;

Pusher gets the GCM or APNS keys info from environment variables:

* `PUSHER_GCM_APPS` - Comma separated APNS app names, ex: appname1,appname2;
* `PUSHER_APNS_APPS` - Comma separated GCM app names, ex: appname1,appname2;
* `PUSHER_APNS_CERTS_APPNAME` - App APNS certificate path
* `PUSHER_GCM_CERTS_APPNAME_APIKEY` - GCM App Api Key
* `PUSHER_GCM_CERTS_APPNAME_SENDERID` - GCM App SenderID

For feedbacks you must specify a list of reporters:

* `PUSHER_FEEDBACK_REPORTERS` - List of feedbacks reporters;
Expand Down

0 comments on commit f66ed6f

Please sign in to comment.