Start your content search
2 min read

Download, deploy, and enjoy Self-managed Components

The Self-managed Components (SmC) package includes privacy-compliant search and discovery experiences based on the Empathy Platform product. SmC puts together a set of Empathy Platform essential capabilities, functionalities, and tools to facilitate you the task of creating innovative and privacy-by-desing search and discovery experiences.

You have at your disposal the SmC package ready to be downloaded, deployed, and enjoyed locally. Keep on reading to see how to do so.

Before you begin

Before you try the SmC package, make sure you've:

  • Docker (app or desktop) and Docker Compose to implement the code.
  • Git installed on your machine to access the code (optional).
  • Access permissions to the Search service docker image. To download the necessary resources to run the SmC package, you need access to the Empathy private repositories.
    Contact Empathy Platform First Line Support (opens new window) or your Empathy representative to request your access token. Use the token provided as a password for the smcempathy user to download all resources.

Deploying the SmC package

Deploy the SmC package using Docker via app or desktop. To start the deployment, perform the following steps:

warning

Make sure you have root access permissions to run the SmC package. Otherwise, contact Empathy Platform First Line Support (opens new window) or your Empathy representative.

  1. Access the SmC GitHub repository (opens new window)
  2. Download the code or clone the SmC repository to your local machine using the following command: git clone https://github.com/empathyco/empathy-self-managed-components.
  3. Execute docker-compose up -d from the root folder.

The deployment process of the SmC package is started.

What does the SmC package include?

The SmC package includes:

  • Elasticsearch
  • Indexing job to load the sample public IMDb movie dataset
  • Search API (only published as a Docker image)
  • Frontend web application

You can check that everything is up and running by executing docker ps or checking the containers' status in the Docker Desktop GUI.

When you execute the containers, a search and Elasticsearch containers start. Also, an indexing job starts to add the necessary collections to your Elasticsearch. Wait until all processes are completed (it takes 2-3 minutes) to start searching using the IMDB public catalog lite version provided.

interact

Explore a bit more the SmC ecosystem and discover the architecture of the Empathy Platform search and discovery experiences' package.

Enjoying the SmC package

Once the deployment is complete, you access the SmC in the following URLs:

  • UI: http://localhost:8080
  • Browser: http://localhost:8081/api/v1/search
  • cURL:
    curl -X GET \
    '[http://localhost:8081/api/v1/search?q=wonderland&lang=en](http://localhost:8081/api/v1/search?q=wonderland&lang=en)' \
    -H 'Content-Type: application/json'

interact

Don't miss the Download, deploy, and enjoy SmC (opens new window) tutorial, where you'll discover step-by-step download and execution instructions and dependencies explanations.

Customize SmC

Eager to know how to customize the Self-managed Components' package? Discover how far the Empathy Platform search and discovery experiences can go.

Cookie-Less