Skip to content

INSTALL.md

Latest commit

 

History

History
113 lines (74 loc) · 1.93 KB

INSTALL.md

File metadata and controls

113 lines (74 loc) · 1.93 KB
Raw

📝 Installation for GCP Scanner

Install basic dependencies

Linux is the preferred operating system to use while contributing to GCP Scanner. If you're using Windows, we recommend setting up Windows Subsystem for Linux.

  • Have python installed on your system. Check out this link to download.
  • have git installed on your system.

Steps to follow to setup gcp-scanner

To install the package

Install the package using pip

pip install gcp-scanner

Check if installation was done correctly

gcp-scanner --help

Build from source

  1. Open the Terminal & Clone the project using

    git clone https://github.com/google/gcp_scanner.git

  2. Then,

    cd gcp_scanner

  3. Create a Virtual Environment to install all your dependencies with

    • on linux or wsl:
    python3 -m venv venv
    • on windows:
    python -m venv venv
    • on MacOS :
    python3 -m venv venv

  4. Activate the Virtual Environment with

    • on linux or wsl:
    source venv/bin/activate
    • on windows:
    .\venv\Scripts\activate
    • on MacOS:
    source venv/bin/activate

  5. Install all dependencies using

    pip install -r requirements.txt

  6. If you want to install the visualization tool (you should have node.js already installed) then run

    cd visualization_tool
npm install
npm run build
cd ..

  7. Install the tool in your local machine

    pip install .

  8. Run to check if the tool was installed correctly

    gcp-scanner --help

Build using docker

There is a docker build file if you want to run the scanner from a container:

docker build -f Dockerfile -t sa_scanner .