# CircleCI

CircleCI is supported by using our debricked/debricked-scan (opens new window) Docker image.

  • Configure your DEBRICKED_TOKEN variable using an access token (recommended), or alternatively your DEBRICKED_USERNAME (email) and DEBRICKED_PASSWORD variables, by heading over to your Project Settings -> Environment Variables, and add environment variables, as below. Environment variables

Tip

CircleCI masks the environment variables automatically.

  • Go to your repository and add the following to your .circleci/config.yml file (if the file doesn't exist, create one):
workflows:
  version: 2
  flow:
    jobs:
      - debricked_scan

jobs:
  debricked_scan:
    docker:
      # circleci ignores the entrypoint of debricked-scan, so start the scan manually with a step
      - image: debricked/debricked-scan

    working_directory: ~/repo

    # set debricked username and password as DEBRICKED_USERNAME and DEBRICKED_PASSWORD respectively,
    # inside project settings, to avoid storing them in config
    steps:
      - checkout
      - run: bash /circleci.sh

  • Commit your changes to and watch the CI run!

Tip

Our CircleCI integration support the same options as our Bitbucket integration, read more about the options here https://bitbucket.org/debricked/debricked-scan (opens new window)