Sunbird cQube
  • 📖KNOW ABOUT CQUBE
    • What is cQube & what does it solve
      • Business case
      • cQube ed
      • Design Principles
    • cQube adoptions
    • Discuss more about cQube
  • 👍TRY CQUBE
    • cQube on Gitpod
  • 🌅WHAT IS NEXT IN CQUBE
    • cQube Roadmap
  • 💻TECHANICAL OVERVIEW
    • Architecture
    • Design Principles
    • Key Components
    • Details of microservices
  • 👩‍💻Get started on cQube
    • Suggested Team Structure
    • Hardware Requirements
    • Prerequisites Checklist
    • Checking pre existing ports
    • Instance Creation
    • Copying SSL Certificate
  • 🛃USE CQUBE
    • How can I install cQube?
      • High level understanding of deployment
      • Oracle Installation
      • AWS Installation
      • SDC Installation
      • Azure Installation
    • How to prepare the data
      • Schema
      • How to prepare schemas for dimension files
      • How to prepare schemas for event files
      • Examples of dimension & event files
      • All cQube schemas used for VSK
    • Ingesting the data
      • High-level understanding of ingestion
      • Steps to ingest schema
      • Steps to ingest data files
        • Upload the .csv data file for state specific programs using ingestion API
        • API to upload starter pack data files for NVSK programs
        • Get file status API
        • Scheduled API
      • Error during ingestion
        • Error Monitoring
        • Common errors in data files during ingestion
      • Processor group name
    • Adapter details
    • Postman details
    • Processing of data
      • Data Processing using CLI command
      • API Details for Nifi-Rest
      • Nifi section
    • Visualizing the data
      • High level understanding of how visualizations work in cQube
      • Programs and reports out-of-the-box
      • Enhance /Customize cQube
        • Available customizations
          • Changing Dashboard Logos and Headers
          • Changing Program Name, Icon and Side Menu Sequence
          • Adding a new KPI
          • Adding a Map KPI into dashboard ms
          • Table Drill Down Customization
          • Adding a Scatter Plot KPI into dashboard ms
          • Configure default date range across app/specific report
        • How to add a New Indicator
        • How to add a new report in an existing program
        • How to add a new program (end to end)
    • Additional Features
      • Public/Private dashboards
      • Role based access control
      • Saving geographical preferences
      • Admin Panel
        • Data Debugger
        • Schema Generator
        • System Monitoring
    • Adding Users
      • Adding an individual user
      • Adding bulk users
  • 🖥️MONITOR cQUBE
    • Infra health monitoring
    • Usage monitoring
  • 🔎QA testing
    • Testing approaches & activities
    • Manual & Automated testing
    • Functional Testing
      • Smoke Testing
      • Functional tests
      • Regression Testing
      • System Testing
    • Non Functional Testing
      • Performance Testing
        • Load Testing
        • Volume Testing
        • Performance testing results
    • Test for One-Step Installation
    • Test for Ingestion
    • Test for nifi processing
    • Test for UI Application
    • Test for KPIs
  • ☀️DEPLOYMENT PROCESS
    • State List
    • AWS Deployment
    • SDC Deployment
    • Adapter Details During the Processing
  • 🈴UPGRADING TO LATEST VERSION
    • How can I upgrade cQube to the latest release
  • 🆘Common issues and their solutions
    • Deployment & ingestion related issues & their solutions
  • ⏱️Standard Operating Procedure
    • Reporting a Bug
    • Protocol for issue reporting & resolution
    • Suggesting Enhancements
    • Raising a PR
  • ❓Frequently Asked Questions
    • Running List
  • 🧑‍🏫🧑🏫 Recording of trainings
    • Link to the training videos
  • 🧠Key Terms & Concepts
    • Definitions
  • 🚀cQube Release Notes
    • cQube - Release V 5.0.5
    • cQube - Release V 5.0.3
    • cQube - Release V 5.0.2
    • cQube - Release V 5.0.1
    • cQube - Release V 5.0
    • cQube - Release V 4.1-beta
    • cQube - Release V 4.0-beta
    • cQube - Release V 4.0-alpha
    • cQube - Release V 3.7
    • cQube - Release V 3.6
    • cQube - Release V 3.5
    • cQube - Release V 3.4
    • cQube - Release V 3.3
    • cQube - Release V 3.2
    • cQube - Release V 3.1
    • cQube - Release V 3
    • cQube - Release V 2
    • cQube - Release V 1.13 and V 1.13.1
    • cQube - Release V 1.12 and V 1.12.1
    • cQube - Release V 1.11
    • cQube - Release V 10 and V 10.1
    • cQube - Release V 1.9
    • cQube - Release V 1.8 and V 1.8.1
    • cQube - Release Notes V 1.7
    • cQube - Release Notes V 1.6 and V 1.6.1
    • cQube - Release Notes V 1.5
    • cQube - Release Notes V 1.4
    • cQube - Release Notes V 1.3
    • cQube - Release Notes V 1.2 and V 1.2.1
    • cQube - Release Notes V 1.1
    • cQube - Release Notes V 1.0
  • 📂cQube V 4.1 - Beta
    • Sunbird cQube Overview
    • cQube Product Description
    • Listen to Experts (Youtube)
    • Software Requirements
    • Acronyms
    • cQube Software Architecture
    • AWS - Network Architecture
      • Hardware requirements
      • Data Storage Locations
    • Security Implementations
    • Prerequisites for Installation process
    • New Use-Case Creation
    • cQube Setup & configuration
    • Base Installation steps
    • Base Upgradation steps
    • Workflow Installation steps
    • Workflow Upgradation steps
    • Laptop/Desktop Installation
      • Base Installation
      • Workflow Installation
      • Mock Data Processing
    • Ad-hoc analysis
    • Workflow process
    • Emission Process
    • cQube ER Diagrams
    • Data Validation after Ingestion
    • User Authentication Process
    • Admin Login Process
    • Admin Features
    • cQube Datasource Configuration
    • cQube data replay process
    • S3 Partitioning
    • Reports
    • Troubleshooting Issues
      • Data Processing-NIFI Issues
      • Data Processing-PostgreSQL Issues
      • Data Emission Issues
      • Angular & Node Issues
    • FAQs
    • Discuss
    • Report
    • Source Code
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. cQube V 4.1 - Beta
  2. Laptop/Desktop Installation

Base Installation

  • Open Terminal

  • Navigate to the directory where cQube_Base has been downloaded or cloned

  - cd cQube_Base/
  - git checkout release-3.3
  • Copy the config.yml.template to config.yml

  - cp config.yml.template config.yml
  • Edit using the command

  - nano config.yml
  • Fill the below details in the config.yml file

# cQube Installation configuration parameters
# ALL VARIABLES ARE MANDATORY.
# PLEASE FILL THOSE BEFORE RUNNING CORRESPONDING STEPS.
#NOTE: Please fill the value with a space between ":" and the value. 
#Example-   `system_user_name: ubuntu`
system_user_name:          # Non-root username with sudo privileges. To find the username run `whoami` in the same server terminal.
base_dir: /opt             # provide the absolute path where cqube needs to be installed and served. Eg. /opt  ( in this case cqube will be installed under /opt/cqube)
#Database variables naming convention, the variable length should be between [3-63] characters and should contain upper/lower characters, it should start with _ or lower or upper characters.
# Database Parameters
db_user: cqube_db_user   # Create your own username for the cQube database
db_name: cqube_db     # Enter your own database name for the cQube database
db_password:         # Create your own password for the cQube database, password should contain at least 1 lower,upper,number,special character (only @!%^*? allowed) and minimum 8 characters
read_only_db_user:      # Create your own username for the read only access of cQube database
read_only_db_password:     # Create your own password for the read only user, password should contain at least 1 lower,upper,number,special character (only @!%^*? allowed) and minimum 8 characters
storage_type: local              # enter `s3` or `local`
# Please fill api_endpoint where the node server will be accessible.
# Node server will be running on 3000 ports using local ip.
# If you are using a reverse proxy and using an SSL certificate, please enter the right api endpoint url.
mode_of_installation: localhost         # enter `localhost` for demo installation in a single local machine, or `public` for installation in a server
api_endpoint: localhost          # enter domain name if mode_of_installation is `public` ( Example: cqubeprojects.com ), if mode_of_installation is `localhost` then api_endpoint should be `localhost`
local_ipv4_address:         # enter the private ip of this server. To find the ip address. Use `ip addr` or `ifconfig`
vpn_local_ipv4_address:      # enter the private ip of the vpn server. To find the ip address. Use `ip addr` or `ifconfig`
keycloak_adm_user:      # enter the keycloak admin user to be created 
keycloak_adm_passwd:      # enter the keycloak admin password. password should contain at least 1 lower,upper,number,special character (only @!%^*? allowed)  and minimum 8 characters
report_viewer_config_otp:  # enter true or false to enable OTP authentication for all users 
  • Copy the local_storage_config.yml.template to local_storage_config.yml

  - cp local_storage_config.yml template local_storage_config.yml
  • Edit the local_storage_config.yml file using the below command

  - nano local_storage_config.yml
  • Fill the below details in the nano local_storage_config.yml file

# cQube Installation configuration parameters
# ALL VARIABLES ARE MANDATORY.
# PLEASE FILL THOSE BEFORE RUNNING CORRESPONDING STEPS.
#NOTE: Please fill the value with a space between ":" and the value. 
# local_storage_directories
# User need to create three directory for input, output and emission
input_directory: /tmp/           # Enter the input directory path followed by "/". Example: /home/ubuntu/input/
output_directory: /tmp/           #Enter the output directory path followed by "/". Example: /home/ubuntu/output/
emission_directory: /tmp/       #Enter the emission directory path followed by "/". Example: /home/ubuntu/emission/
  • Give the following permission to the install.sh file

  - sudo chmod u+x install.sh
  • Start the cQube base installation

  - sudo ./install.sh
PreviousLaptop/Desktop InstallationNextWorkflow Installation

Last updated 3 years ago

Was this helpful?

📂