Huygens Search API

See: https://app.gitbook.com/@josuegiron/s/huygens

Quick start guide

This is a quick start guide for Huygens Search API, which will tell you how to install and config the API.

Install

At a minimum, Huygens Search API requires curl, Docker Engine 19.03.2 (or latest) versión and Docker Compose 3.1 (or latest) to be installed. This tools are needed for run the Huygens Search API .

See this guide for how install Docker Engine and Docker Compose in your computer or see the official Docker documentation.

Linux and macOS

1. Download the installation resources:

$ curl -sLf https://github.com/jhuygens/deploy

or clone this repository: https://github.com/jhuygens/deploy``

2. In deploy directory run the follows commands:

# This command will download the necessary docker images 
# to compile and put the API modules online
$ sudo docker-compose build

It will ask for the super user credentials. This may take several minutes.

Upon completion you will see something like this:

...

 ---> Using cache
 ---> ea6fbd50f6c2
Step 12/12 : CMD ["./main"]
 ---> Using cache
 ---> 8d1f437ec89f
Successfully built 8d1f437ec89f
Successfully tagged deploy_search-service:latest
$

3. Then run the following command to bring the Huygens Search API online:

# The -d flag makes the Docker daemon execute the containers in background
$ sudo docker-compose up -d

If everything works out, you will see:

Starting deploy_mongo_1          ... done
Creating deploy_search-service_1 ... done
Creating deploy_auth-service_1   ... done
Creating deploy_gateway_1        ... done
Creating deploy_redis_1          ... done
$

Test the Huygens Search API following the instructions in this document to confirm that it works correctly.

4. View the log write by the API modules with the following command:

$ sudo docker-compose logs

For further information about how view logs in Docker, see this document.

If you want to stop the API execution, run the following command:

# Stops containers and removes containers, networks, volumes, 
# and images created by up
$ sudo docker-compose down

Output:

Removing deploy_gateway_1        ... done
Removing deploy_redis_1          ... done
Removing deploy_auth-service_1   ... done
Removing deploy_search-service_1 ... done
Removing deploy_mongo_1          ... done
Removing network deploy_default
$

For further information about this, see: https://app.gitbook.com/@josuegiron/s/huygens