Saral Installation Guide (Non-Prod)

Saral allows quick and reliable capture of information from physical formats to structured, digital formats.

Using Saral results in extensive savings in terms of time and effort, when information from physical sources (such as paper) needs to be digitised and stored in a structured manner for analysis.

Prerequisites

1) Since, backend infra for Saral is hosted on AWS, user Must have a valid AWS account.

2) Saral is a mobile application and its APK can be generated from source code. Process for the same can be found here. Provision has been made such that adopters can create their own configurations for Saral application. Refer here and here to know about detail guide for the same.

User can publish their own configured saral app on Google play sore. Please refer here to know process to set it up.

Saral provides facility to pull varied analytical reports using Firebase Application. Please refer here to know process to set Firebase account and configure it. Once Firebase account has been setup, refer here to konw how to update it in source code. Please note, mobile APK needs to be rebuild for changes to get reflected.

3) Saral app supports pre-configured template layouts. User is advised to take print outs of the same for their use. Current application version supports Assessment and layout for the same can be found attached below.

77KB

Assesment sheet layout.pdf

PDF

Open

Saral Assessment-Sheet Layout

Latest published versions of all layouts will be available at below mentioned location.

Project-Saral/docs/layout-design/Design at v1-develop · Sunbird-Saral/Project-SaralGitHub

Along with template files, ROI Json file are available at below location.

Project-Saral/v1.0/backend/data/layout at v1-develop · Sunbird-Saral/Project-SaralGitHub

All layouts are configurable. Please refer here to configure your own layout and create corresponding ROI file for it.

4) Download and install MongoDB and Mongo Compass for your OS (Windows, mac, Linux) from below link

Download and Install Compass - Compass - MongoDB Docsmongodb

Download and Install Compass

# To Import the public key used by the package management system run 
sudo apt-get install gnupg curl

# To import the MongoDB public GPG key from https://www.mongodb.org/static/pgp/server-7.0.asc, run the following command
curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \
   sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \
   --dearmor
   
# To Create a list file for MongoDB run  
sudo touch /etc/apt/sources.list.d/mongodb-org-7.0.list

# To add Mongo Repo to package manager run 
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list

# To Reload local package database run
sudo apt-get update

#To Install the MongoDB packages run
sudo apt-get install -y mongodb-org

5) Saral user docker for containerisation and hence, to Install docker on Ubuntu Linux use below details

# To Update the package index run
sudo apt update

# To Install prerequisites for Docker run
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common

# To Add Docker GPG key run
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

# To Add Docker repository run
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# To Update the package index again (with Docker repository) run
sudo apt update

# To Install Docker run
sudo apt install -y docker-ce docker-ce-cli containerd.io

# To Add the current user to the docker group (to run Docker commands without sudo) run
sudo usermod -aG docker $USER

# To Install Docker Compose run
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

# To Print Docker and Docker Compose versions run
docker --version
docker-compose --version

6) Create a docker-compose.yml file and paste below code snippet in it. Please make sure to replace your MongoDB instance IP in the below code snippet.

version: '2.4'
services:
  sandbox:
    image: jonathanrogers/saral-backend:v1.7.0
    container_name: sandbox
    environment:
      - PROFILE=dev
      - PORT=3005
      - MONGODB_URL=mongodb://<Insert your actual Mongo DB IP here>:27017/saralv1newdb
      - JWT_SECRET=SARALDATA_NODE
      - MONGODB_POOL_SIZE=50
      - MIN_MONGODB_POOL_SIZE=30
      - WHITELIST_DOMAINS=<add your domain/subdomain name here(eg: https://your-domain-name.com)>

    ports:
      - "3005:3005"

To execute docker compose file, please execute below mention command in your VM terminal

sudo docker compose up -d

7) Use NGINX to setup Domain Name and SSL Certificate. Refer here for installation guide.

8) Postman Collections

718KB

saral-frontend.postman_collection.json

Open

Postman Collections

9) Cloud Infra provisioning requirement and costing

Please refer here for minimum infra required to be provisioned for Saral sand box and the monthly costing associated with it.

Please note, there is need to whitelist server IP/domain for application to work. Please refer here to understand steps for the whitelisting

Once all above steps are completed, Saral will be ready to use.

Refer here to know more about implementation details of Saral.

Refer here to know about user User Experience of Saral.