Steps to Setup CLIx_Dashboard - Pardhu448/CLIx_Dashboard GitHub Wiki

In this part of the wiki, we will give detailed steps involved in setting up CLIx_dashboard on a server or on a local machine.

Get Source Code
  1. create a folder for CLIxDashboard - 'mkdir CLIxDashboard' and move into it
  2. 'git clone' following repos - CLIxDashboard, clix_dashboard_backend, clix_dashboard_ui
Update machine specific variables
  1. check which ports are available for postgres using this command - sudo lsof -i -P -n | grep LISTEN
  2. Following are usual ports used for potgresql - 5432, 5433, 5434. Use whichever is available at two places:
    • in docker-compose.yml file of CLIxDashboard
    • in config.py file of clix_dashboard_backend
  3. Now update local machine/server ip address in docker-compose.yml file of CLIxDashboard
  4. Update POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD in docker-compose.yml file of CLIxDashboard
  5. Get uid of user in host machine where the above mentioned folders are present. Then update 'DOCKER_UID' in with this uid in docker-compose.yml file of CLIxDashboard
Setup clix_dashboard_backend
  1. Follow the steps described here to setup CLIx_dashboard backend
orchestrate constituent containers
  1. run 'docker-compose up -d' command in the CLIx_dashboard directory

  2. Open CLIx_dashboard website at port 3000