Sunbird UCI

Pre-requisites, Installation Setup, Post Setup

Pre-requisites, Installation Setup, Post Setup


  1. 1.
    Install Docker if not already installed. Click Here
  2. 2.
    Infra :
    • 8 CPU Cores
    • 16 GB RAM
    • 20 GB Storage
    • Server Fixed/Static IP
    • Preferred OS - Linux
  3. 3.
    Basic familiarity is required with:
    • Terminal & its commands
    • Docker
    • Server
    • Rest apis
  4. 4.
    Please make sure all of the ports mentioned used in the file are open & are not being used by any other service on the server.

Installation Setup

  1. 1.
    Take clone of this repository.
    git clone
  2. 2.
    Go to folder
    cd docker-deploy
  3. 3.
    Install the requirements
    pip3 install -r requirements.txt
  4. 4.
    Fill in the environment variables in the .env file. Find out more about the .env here.
  5. 5.
    Run below command to download & start the services using docker.
    The encryption key should be a strong string consisting uppercase, lowercase, numeric and special characters. For setting up a local demo, it can be anything. For example: 1234. The rest of the parameteres are optional, they are only required for the whatsapp flow. If you don't want to test it out, then you are good to go only with the encryption key. In that case, the final command comes out to be:
    python3 1234
    • If script fails on runtime ,run the following commands and re-run the script
      • Stop the all services and volumes
        docker-compose down -v
      • Remove the data directory
        sudo rm -rf data
      • Run the script again
  6. 6.
    Follow the instructions in the script. At one point, the script will ask you to run some queries in the hasura console to fill in adapters. Follow the instructions there to do so.
  7. 7.
    Once the setup is completed, go to the web channel (http://localhost:9098/) to test out the conversation with the bot.
Note: Please note this installation is based on a very standard and generalized use case. If your needs are not fulfilled with the current installation, please start scaling the individual services by using them in docker stack.

After a Successful Docker Setup Completion

  1. 1.
    Script execution time - Around 30 minutes (depends on your server)
  2. 2.
    On a successful run of the script you will get below services:
    • Inbound Service: http://localhost:9080/health
    • Orchestrator Service: http://localhost:8686/health
    • Transformer Service: http://localhost:9091/health
    • Outbound Service: http://localhost:9090/health
    • Broadcast Transformer Service: http://localhost:9093/health
    • Campaign Service: http://localhost:9999
    • Kafka UI: http://localhost:18080/ui/docker-kafka-server/topic
    • Bot DB Hasura UI: http://localhost:15003/console/login
    • Fusion Auth: http://localhost:9011
    • ODK: http://localhost:8080/Aggregate.html#management/forms
    • Chat Frontend: http://localhost:9098
    • Admin Console: http://localhost:9097
    Note: If above mentioned url's are not working then restart the all docker services or check the docker container logs.
  3. 3.
    If you want to check logs for a specific service, follow below flow.
    • Show all docker containers
      docker-compose logs {service_name} --follow
Note: If the services are updated on any server, use server's ip instead of localhost. Eg. http://143.112.x.x:9080

Post Setup

  1. 1.
    You can start using FusionAuth Console using http://localhost:9011/ and create an Account, for managing users and what resources they are authorized to access.
  2. 2.
    For managing all the assesment data go on URL : http://localhost:8080/ to view all the submissions
Note: If you face any difficulty in setting up UCI, please raise an issue here. All the issues that you raise will help us make UCI make better for adopters.