install_guide.md

Diagram Overview

• Image click to Youtube:
  • 

Kick-start

0. Ready: Token is required for GitHub information crawling

• Create Token before the App runs as below.
  • https://github.com/settings/tokens/new

※ Github env settings below must be done under organization account settings, not in personal.

1. Create organization

• This must be done before authorizing and managing admins.
• Github link:
  • https://github.com/settings/organizations

2. Fork NexClipper/exporterhub.io to organization, not to personal account.

3. Create and register an OAuth app under your organization.

• 1) Click developer settings tab of organization. While you create OAuth Apps, please take note of redirect url of authentication.

• 2) Client ID, Client Secrets, and callback url(Service URL) are required for authentication.

4. Write docker-compose.yml accordingly.

• "NEED_TO_SET_UP" parts are to be revised in ./.envfile, with the reference .env.SAMPLE file at /exporterhub.io:

## Variables for Frontend(ReactJS) server
SERVICE_URL="http://[YOUR SERVICE URL HERE WITH PORT NUMBER, IF YOU HAVE THE SPECIPIC PORT]"

### Port number check by docker-compose
SERVICE_PORT="80"
API_SERVER="http://[YOUR API SERVER URL HERE]:8000"
CLIENT_ID="[NEED_TO_SET_UP]"
CLIENT_SECRETS="[NEED_TO_SET_UP]"


## Variables for API(Python) Server
ORGANIZATION="Exporterhubv3"
SECRET_KEY="[NEED_TO_SET_UP]"
ALGORITHM="HS256"

## Docker image name tag(It would be replaced automatically by Makefile)
front_tag="release-fe0.3.14"
api_tag="release-api0.3.4"

• "NEED_TO_SET_UP" parts are to be linked to docker-compose.yml as below:

5. build image before running

• run the command make build at ./exporterhub.io

6. Run by default(in localhost)

• run the command make run at ./exporterhub.io

7. Or, Run for external network

• If you want to run the server in external server or instance, please make sure to input SERVICE_URL as same as below

version: "3.1"
services:
  expoterhub:
    image: nexclipper/exporterhub:${front_tag}
    ports:
      - "${SERVICE_PORT}:3000"
    environment:
      # You can add and modify below setup to './.env' file for externel configuration without security issue.
      # and you can check src/config.js .env.production entrypoint.sh
      SERVICE_URL: ${SERVICE_URL}
      API_SERVER: ${API_SERVER}
      SERVICE_PUBLIC: "n"
      CLIENT_ID: ${CLIENT_ID}
      CLIENT_SECRETS: ${CLIENT_SECRETS}

• then, run the command make run at ./exporterhub.io

8. Initial Check & Set

• At the beginning, input the generated Token to landing page as below. (http://localhost:8080)

• Initial settings are done if you get landing page with exporter cards as below.

Maintenance

Easy to Update a list of exporters by Pull Request as below

• https://github.com/NexClipper/exporterhub.io/blob/main/api/exporter_list.csv

Tag rule for Build in the hub.docker.com

exporterhub Frontend build tag

• Source pattern of Tag: /^fe([0-9.]+)$/
  • ex) fe0.2.0 -> nexclipper/exporterhub:release-fe0.2.0

exporterhub API server build tag

• Source pattern of Tag: /^api([0-9.]+)$/
  • ex) api0.3 -> nexclipper/exporterhub-api:release-api0.3

Docker image registry

• nexclipper/exporterhub: https://hub.docker.com/repository/docker/nexclipper/exporterhub
• nexclipper/exporterhub-api: https://hub.docker.com/repository/docker/nexclipper/exporterhub-api