Skip to content

Install_English.md

Latest commit

 

History

History
71 lines (57 loc) · 1.67 KB

Install_English.md

File metadata and controls

71 lines (57 loc) · 1.67 KB

Init Cloud IaC Scanner API (Beta)

Description

Init Cloud IaC Scanner support static code scan, visualization and report.

  • This API is except Dashboard. Only API.

Which vendors we support?

  • CSP : AWS, NCP are supported.
  • IaC : Terraform is supported.

Road Map

  • CSP : OpenStack will be supported soon.
  • IaC : Ansible will be supported.

How to install & run

  1. Install docker & docker-compose on your environment.
    install docker
    install docker-compose
  2. Cloning Init Cloud Scanner API
git clone https://github.com/init-cloud/backend-scanner.git
cd ./backend-scanner
  1. Set your Environment Variables.
touch .env
# .env
TZ= #YOUR TIMEZONE

# IF YOU USE FE DASHBOARD.
#BOARD_PORT=5555 # YOUR BOARD PORT

# Scanner
SCANNER_PORT=9090 # YOUR SCANNER PORT
JWT_SECRET= # YOUR RANDOM VALUE LONGER THAN 32

#IF YOU NEED TO MANAGE GITHUB REPOSITORY, WRITE BELOWS
#GITHUB_CLIENT_ID=  
#GITHUB_CLIENT_SECRET= 

#IF YOU NEED TO MANAGE GITHUB ORGANIZATION, WRITE BELOWS
#GITHUB_APP_CLIENT_ID=
#GITHUB_APP_CLIENT_SECRET=

# Parser
PARSER_PORT=9001 # YOUR PARSER PORT

# DB
MARIADB_DATABASE=initcloud
MARIADB_USER=__YOUR_DATABASE_USER__
MARIADB_PASSWORD=__YOUR_DATABASE_PASSWORD__
MARIADB_ROOT=__YOUR_DATABASE_ROOT__
MARIADB_ROOT_PASSWORD=__YOUR_DATABASE_ROOT_PASSWORD__
DB_PORT=9002 #__YOUR_DATABASE_PORT__
  1. Run with Docker-compose
# pwd : ./backend-scanner
docker compose up

# or
docker compose up -d