Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Commit

Permalink
describe configuration vars in README
Browse files Browse the repository at this point in the history
  • Loading branch information
pb82 committed May 2, 2018
1 parent 5e15a63 commit c28791e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ mvn clean install

and start the latest build, locally, like `docker run -p 18081:8080 -it aerogear/ups:plain`

## Configuration

The Unified Push Server can be configured with either System Properties (passed to the Java commandline) or Environment Variables. The two options have different formats and the following list describes them using `System Property Name`/`Env Var Name`: `Purpose`.

* _custom.aerogear.apns.push.host/CUSTOM_AEROGEAR_APNS_PUSH_HOST_: Custom host for sending Apple push notifications. Can be used for testing
* _custom.aerogear.apns.push.port/CUSTOM_AEROGEAR_APNS_PUSH_PORT_: Custom port for the Apple Push Network host
* _custom.aerogear.fcm.push.host/CUSTOM_AEROGEAR_FCM_PUSH_HOST_: Custom host for sending Google Firebase push notifications. Can be used for testing
* _ups.realm.name/UPS_REALM_NAME_: Override Keycloak Realm
* _ups.auth.server.url/UPS_AUTH_SERVER_URL_: Override Keycloak authentication redirect
* _aerogear.metrics.storage.days/AEROGEAR_METRICS_STORAGE_DAYS_: Override the number of days the metrics are stored (default is 30 days)

## Releasing the UnifiedPush Server

The content of the [Release Process](https://github.com/aerogear/collateral/wiki/Release-Process-(Java)) is valid for this project as well. However, to build the full `distribution` bundle, you need to fire off the release like:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,10 @@ public void testEnvVarLookup() {
assertThat(ConfigurationUtils.tryGetGlobalProperty("test.env.var"))
.isEqualTo("Ok");
}

@Test
public void testEnvVarUppercaseLookup() {
assertThat(ConfigurationUtils.tryGetGlobalProperty("TEST_ENV_VAR"))
.isEqualTo("Ok");
}
}

0 comments on commit c28791e

Please sign in to comment.