Skip to content
master
Go to file
Code

Latest commit

* Add description of config changes. Additionally, there are changes to the relative links to the other parts of the documentation as they were not working properly

* [skip CI] apply review commnents

Co-authored-by: Jan Ciesla <jan.ciesla@erlang-solutions.com>
6c8c532

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

MongoosePush

Build Status Coverage Status Ebert

MongoosePush is a simple, RESTful service written in Elixir, providing the ability to send push notifications to FCM (Firebase Cloud Messaging) and/or APNS (Apple Push Notification Service) via their HTTP/2 API.

Documentation

Documentation is available at: https://esl.github.io/MongoosePush

Quick start

Running from DockerHub

We provide prebuilt MongoosePush images. Configuration requires either an FCM token, APNS certificates or an APNS token. Depending on your usecase, you can have some or all of them in a standalone MongoosePush instance or using a docker container. For the full configuration you need to set the following directory structure up:

  • priv/
    • ssl/
      • rest_cert.pem - The HTTP endpoint certificate
      • rest_key.pem - private key for the HTTP endpoint certificate (has to be unencrypted)
    • apns/
      • prod_cert.pem - Production APNS app certificate
      • prod_key.pem - Production APNS app certificate's private key (has to be unencrypted)
      • dev_cert.pem - Development APNS app certificate
      • dev_key.pem - Development APNS app certificate's private key (has to be unencrypted)
      • token.p8 - APNS authentication token
    • fcm/
      • token.json - FCM service account JSON file

If you want to use APNS token authentication you need to provide token and set key_id and team_id environment variables. To see how to obtain token and key_id read this. To see how to obtain team_id read this.

FCM JSON file can be generated by Firebase console (https://console.firebase.google.com). Go to your project -> Project Settings -> Service accounts -> Generate new private key Assuming that you have the priv directory with all certificates and fcm token in current directory, then you may start MongoosePush with the following command:

docker run -v `pwd`/priv:/opt/app/priv \
  -e PUSH_HTTPS_CERTFILE="/opt/app/priv/ssl/rest_cert.pem" \
  -e PUSH_HTTPS_KEYFILE="/opt/app/priv/ssl/rest_key.pem" \
  -it --rm mongooseim/mongoose-push:latest

Local build prerequisites

  • Elixir 1.5+ (http://elixir-lang.org/install.html)
  • Erlang/OTP 19.3+

    NOTE: Some Erlang/OTP 20.x releases / builds contain TLS bug that prevents connecting to APNS servers. When building with this Erlang version, please make sure that MongoosePushRuntimeTest test suite passes. It is however highly recommended to build MongoosePush with Erlang/OTP 21.x.

  • Rebar3 (just enter mix local.rebar)
You can’t perform that action at this time.