ocariot/notification repository overview

⁠OCARIoT Notification Microservice

Microservice responsible for sending notifications to user's client apps of OCARIoT platform.

Main features:

• Send cloud notification using Firebase;
• Save user's Firebase tokens;
• Save and return pending notifications;

See the documentation⁠ for more information.

⁠Prerequisites

• Java 8+⁠
• MongoDB Server 3.0.0+⁠
• RabbitMQ 3.7.0+⁠

---

⁠Generate Certificates

For development and testing environments the easiest and fastest way is to generate your own self-signed certificates. These certificates can be used to encrypt data as well as certificates signed by a CA, but users will receive a warning that the certificate is not trusted for their computer or browser. Therefore, self-signed certificates should only be used in non-production environments, that is, development and testing environments. To do this, run the create-self-signed-certs.shscript in the root of the repository.

./create-self-signed-certs.sh

The following files will be created: ca.crt, server.crt and server.key.

In production environments its highly recommended to always use valid certificates and provided by a certificate authority (CA). A good option is Let's Encrypt⁠ which is a CA that provides free certificates. The service is provided by the Internet Security Research Group (ISRG). The process to obtain the certificate is extremely simple, as it is only required to provide a valid domain and prove control over it. With Let's Encrypt, you do this by using software⁠ that uses the ACME protocol, which typically runs on your host. If you prefer, you can use the service provided by the SSL For Free⁠ website and follow the walkthrough. The service is free because the certificates are provided by Let's Encrypt, and it makes the process of obtaining the certificates less painful.

If you are not running the latest docker image available of this microservice, but instead you choose to running alone you will also need to import the certificate into the Java Keystore and Truststore using the following commands:

openssl pkcs12 -export -in server.crt -inkey server.key -out tmp_keystore.p12 -passout pass:s3cr3tp4ss -name notification

keytool -import -file server.crt -alias notification -keystore path/to/truststore/cacerts -noprompt -storepass changeit

⁠Using Docker

In the Docker Hub, you can find the image of the most recent version of this repository. With this image it is easy to create your own containers.

docker run ocariot/notification

This command will download the latest image and create a container with the default settings.

The Notification Microservice depends of the Account service to function properly, so the best way is to use the available docker-compose⁠ and run it either using the notification image or as a detached program.

If you are running this repository as a detached program you need to set the enviromental variables and expose the port for mongodb.

⁠Set the environment variable

Application settings are defined by environment variable.. The enviroment variables necessary by the notification microservice are:

Some of the environment variables are passed by another environment variables that are set in the file .env.example. Copy and paste with the file .env.example and name it .env to make the Docker Compose use the environment variables defined in this file:

If you are not running this repository using the docker image make sure you set the enviromental variables of the first table to the desired ones.