Skip to content

Commit

Permalink
Updating some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre Hahn committed Jan 17, 2018
1 parent f9e47eb commit ae66201
Showing 1 changed file with 5 additions and 22 deletions.
27 changes: 5 additions & 22 deletions docs/pusher.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,9 @@ To start the pusher service you should use one of the commands available in the

## CLI

For both APNS and GCM modes a few flags are required:
The configuration file contains the information about which apps will be enabled, as well as the required informations to actually send the pushes either to GCM or APNS. All variables in the configuration file can be overwritten by environment variables, for example, to overwrite the GCM apps the environment variable is: `PUSHER_GCM_APPS`.

```
--app: the app name for the table in the push PostgreSQL database
```

And some other are optional:
There are some optional flags for both APNS and GCM:

```
--config: path to the config file (default "./config/default.yaml")
Expand All @@ -22,39 +18,26 @@ And some other are optional:

### APNS

To start the pusher in APNS mode the following flags are required:

```
--certificate: path to the pem certificate that will be used for establishing a secure connection
```

Example for running in production with default configuration and in debug mode:

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

### GCM

To start the pusher in GCM mode the following flags are required:

```
--apiKey: GCM api key
--senderId: GCM sender id
```

Example for running in production with default configuration and in debug mode:

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

### Version

To print the current version of the lib simply run `pusher version`.

```bash
❯ pusher version
❯ pusher version
0.1.0
```

Expand Down

0 comments on commit ae66201

Please sign in to comment.