How to host it

There are various ways to host it, it is recommended the following:

Common dependencies

All the methods described below needs some environment variables that are:

CLIENT_ID=<The uuid of your Intra application>
CLIENT_SECRET=<The secret of your Intra application>
MONGO_CLIENT_URL=<The URL to connect to your MongoDB Atlas cluster>
PORT=<The port to connect to> # Use 80

Vagrant

For this method, first you will need the following dependencies:

virtualbox
vagrant

Then, clone the repository and do the following:

vagrant up && vagrant ssh

Once inside the vagrant machine, you need to export the variables said on common dependencies. Do the following to log as root.

sudo su

And export them with double quotes.

Now just do:

make run

And it will be accessible in your localhost on port 8080.

Docker

First, you will need an env-file with the variables said in common instructions (without double quotes).

Then, just run:

docker run -p 8080:80 --env-file <path to your env file> hdeoliv/enki:latest

And it will be accessible in your localhost on port 8080.

On your machine

Clone the repo and run these commands:

apt-get update
apt-get install -y libmbedtls-dev
apt-get install -y clang llvm
apt-get install -y libmongoc-1.0-0 libmongoc-dev
cd /usr/include
sudo ln -s libmongoc-1.0/ mongoc
sudo ln -s libbson-1.0/ bson

Log as root with:

sudo su

And export the variables with double quotes.

And finally, do:

make run

Heroku

To deploy it on Heroku, first fork this repository and add the following secrets on your repo:

DOCKER_PASSWORD
DOCKER_USERNAME
HEROKU_API_KEY
HEROKU_EMAIL
RELEASE_TOKEN # A GitHub personal token

Don’t forget to customize the GitHub Action CI to your own needs. The default is triggered when a prerelease is created, with that it:

• Do unitary tests
• Publish to Docker Hub
• Deploy to Heroku
• Create an automated release

Some observations:

• You need to set the env variables said on common instruction on your Heroku app using its dashboard.