How to install

Hermes can be deployed easily using Docker Compose, allowing for a modular and scalable setup. Since the entire system is containerized, all dependencies and services are managed automatically, making

Docker compose

Clone the project from GitHub

$ git clone https://github.com/matteo-convertino/hermes

Adding required files to run Hermes

• hermes_notifier/firebase_credentials.json: Firebase key required for the notification system. You can generate it by going to:

  1. Firebase console

  2. Project settings

  3. Service account

  4. Generate new private key

• .env: File containing sensitive information. An example:

MARIADB_PASSWORD=
VALKEY_PASSWORD=
TELEGRAM_API_ID=
TELEGRAM_API_HASH=
GOOGLE_CLOUD_PROJECT=

GOOGLE_CLOUD_PROJECT is the Firebase project ID.

Run Hermes

$ ./docker-compose-up.sh

Stop Hermes

$ ./docker-compose-down.sh

These two custom scripts execute other instructions useful for the correct management of the Hermes deployment.