Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 5.54 KB

README.md

File metadata and controls

128 lines (94 loc) · 5.54 KB
Raw

Roxie Enabled Business Intelligence (REAL BI)

Real BI is a tool used to connect to HPCC and create visualizations from the data stored in the clusters. The visualizations can be powered by the output from ROXIE queries, logical files, or custom executed ECL scripts.

Installation

Development

Running Application on Local Machine

This project is utilizing npm packages, to install project you will need Node and NPM installed on your machine. https://nodejs.org/en/ To check if you already have Node installed run command in the terminal node -v for NPM run npm -v

  1. Run git clone https://github.com/hpcc-systems/REAL-BI.git to copy the project into your computer.
  2. You will need to intall dependencies for a project. While in a root folder run command npm install, it will install npm packages in root as well as /api and /client folders.
  3. In the root folder, rename the .env.example file to .env and fill in the empty values. You can find an explanation inside .env.example .
  4. In /client rename the .env.example file to .env.development and fill in the empty values. You can find explanation inside .env.example .
  5. Create schema in your local MySQL database with same name as DB_NAME variable in .env file. By default real_bi .
  6. Go to /api and run npx sequelize db:migrate to build database tables.
  7. Add a cluster to the seed file in order to create a dashboard. The cluster should be publicly available. A sample seed file is provided api\src\seeders\cluster-example.js.
  8. Go to /api and run npx sequelize db:seed:all to populate the database with seed cluster.
  9. Navigate to the root folder and run npm start it will start the server and client application at the same time.
  10. Navigate to http://localhost:3000/ to start using an application.

Production

To run app in Docker Container -->

  1. Run git clone https://github.com/hpcc-systems/REAL-BI.git
  2. In the .env file:
    • Change the NODE_ENV value to "production".
    • Change the database information to point to your production database.
  3. Rename the .env.example file to .env and fill in the empty values.You can find explanation inside .env.example .
  4. To use SSL certificates add cert and key files to /nginx/certs.
  5. Update file /nginx/conf.d/realbi.conf.template to match cert and key file names.
  6. Run docker-compose up --build -d to create and run the containers.

SSL with Letsencrypt and Certbot container

To generate an SSL certificate we use Certbot Docker image, to learn more please visit https://eff-certbot.readthedocs.io/en/stable/install.html#running-with-docker

Learn more about Letsencrypt https://letsencrypt.org/

Good article (guide) on how to use NGINX with Certbot in Docker https://pentacent.medium.com/nginx-and-lets-encrypt-with-docker-in-less-than-5-minutes-b4b8a60d3a71

  1. Add Certbot container to your docker-compose.yml file;
    container_name: certbot
    env_file:
      - .env
    networks:
      - realbi_network
    depends_on:
      - nginx
    image: certbot/certbot:latest
    command: certonly --webroot --webroot-path=<Path to acme challenge inside container> --email <Your email> --agree-tos --no-eff-email -d <Your domain>
    volumes:
      - <Path to certs on local machine>:<Path to certs inside container>
      - <Path to acme-challenge on local machine>:<Path to acme-challenge inside container>
  1. Add a shared volume to your Nginx container (volume should be the same for Certbot container)
    volumes:
      - <Path to certs on local machine>:<Path to certs inside container>
      - <Path to acme challenge on local machine>:<Path to acme challenge inside container>
  1. Go to nginx\conf.d\realbi.conf.template and update the config to run without SSL first by commenting out SSL related settings
server {
 # listen $EXTERNAL_HTTPS_PORT ssl;
 listen $EXTERNAL_HTTP_PORT;
 server_name $HOST_HOSTNAME;

 # ssl_certificate <Path to cert>;
 # ssl_certificate_key <Path to key>;
  1. In nginx\conf.d\realbi.conf.template define new location for acme challenge
  location /.well-known/acme-challenge/ {
    root <Path to acme challenge inside container>;
  }

  1. Make sure that port 80 is open and the app is reachable over the internet.

  2. Stop and remove the old Nginx container, then run docker-compose up -d --no-deps --build nginx certbot

  • Nginx will be listening and serving acme-challenge from a shared volume with Certbot container. To ensure that certbot succeeds, check docker logs certbot .
  1. Update Nginx configuration to run with a new certificate. Go to nginx\conf.d\realbi.conf.template and update SSL path, ex.
server {
 listen $EXTERNAL_HTTPS_PORT ssl;
 server_name $HOST_HOSTNAME;
 ssl_certificate <Path to certs inside container>/live/<Your domain>/fullchain.pem;
 ssl_certificate_key <Path to certs inside container>/live/<Your domain>/privkey.pem;
  1. Rebuild Nginx container docker-compose up -d --no-deps --build nginx

Notes

  • This application relies on:
    • A running instance of Auth Service to handle user authentication and JWT generation.
    • Application can use Microsoft Active Directory for authentication and authorization
    • An HPCC cluster containing data files.
  • This application uses docker-compose to simultaneously start multiple containers:
    • MySQL Database
    • Backend Node.js API Server
    • Frontend React.js Web UI
    • Nginx Proxy Web Server