List of PWSLab CI/CD Environment Variables

List of PWSLab CI/CD Environment Variables

Introduction

This document enlists a set of pre-defined environment variables accepted by PWSLab CI/CD for the local environment of the Runner. These can be referenced directly in the .pwslab.yml file or via the Project's Settings > CI/CD > Variables section. 

Code Audit

Variables
Description
PWS_EMAIL_STATUS
Set "true" or "false" for receiving Code Audit reports as email notifications.
PWS_EMAIL_RECIPIENT
Set the Email Recipient for receiving Report email notifications if PWS_EMAIL_STATUS is set as "true". 
PWS_REPO_USER
Set Git repository username for Code Audit
PWS_REPO_PASS
Set Git repository password for Code Audit
PWS_CODE_AUDIT_DISABLED
Set this variable "true" to disable Code Audit job.

Code Quality

Variables
Description
PWS_EMAIL_STATUS
Set "true" or "false" for receiving Code Quality reports as email notifications.
PWS_EMAIL_RECIPIENT
Set the Email Recipient for receiving Report email notifications if PWS_EMAIL_STATUS is set as "true".
PWS_HUB_USER
Set PWSLab Docker Hub Username
PWS_HUB_PASS
Set PWSLab Docker Hub Password
PWS_CODE_QUALITY_DISABLED
Set this variable "true" to disable Code Quality job.

Browser Performance Test

Variables
Description
PWS_EMAIL_STATUS
Set "true" or "false" for receiving Browser Performance reports as email notifications.
PWS_EMAIL_RECIPIENT
Set the Email Recipient for receiving Report email notifications if PWS_EMAIL_STATUS is set as "true".
PWS_HUB_USER
Set PWSLab Docker Hub Username
PWS_HUB_PASS
Set PWSLab Docker Hub Password
PWS_SITE_URL
Set the Target URL for Browser Performance Testing
PWS_BP_DISABLED
Set this variable "true" to disable Browser Performance job.

Sonar SAST

Variables
Description
PWS_SONAR_TOKEN
Set SonarQube Project Key
PWS_SONAR_HOST
Set SonarQube HOST URL
PWS_SONAR_AWS_ACCESS_KEY
Set AWS Access Key in which the SonarQube Server is configured
PWS_SONAR_AWS_SECRET_KEY
Set AWS Secret Key in which the SonarQube Server is configured
PWS_SONAR_INSTANCE_ID 
Set AWS Instance ID in which the SonarQube Server is configured
PWS_SONAR_AWS_REGION
Set AWS Region in which the SonarQube Server is configured
PWS_SONAR_AWS
If SonarQube server is configured in AWS, then set this variable as "true" to automatically turn the instance ON and OFF. 
PWS_SAST_DISABLED
Set this variable "true" to disable Sonar SAST job.

ZAP DAST

Variables
Description
PWS_EMAIL_STATUS
Set "true" or "false" for receiving DevSecOps Reports as an email notification
PWS_EMAIL_RECIPIENT
Set the Email Recipient for receiving Report Email notifications if PWS_EMAIL_STATUS is set as "true"
PWS_HUB_USER
Set PWSLab Docker Hub Username
PWS_HUB_PASS
Set PWSLab Docker Hub Password
PWS_DAST_URL
Pass the Target URL for DAST testing
PWS_DAST_AUTH_URL
Set the Login URL of the Target application for DAST
PWS_DAST_USERNAME
Set the Login URL Username of the Target application for DAST
PWS_DAST_PASSWORD
Set the Login Password of the Target application for DAST
PWS_DAST_USER_FIELD
Set the Username's HTML field name of the Target application for DAST
PWS_DAST_PASS_FIELD
Set the Password's HTML field name of the Target application for DAST
PWS_DAST_DISABLED
Set this variable "true" to disable the DAST job.

Container Scanning

Variables
Description
PWS_HUB_USER
Set PWSLab Docker Hub Username
PWS_HUB_PASS
Set PWSLab Docker Hub Password
PWS_EMAIL_STATUS
Set "true" or "false" for receiving Code Audit reports as email notifications.
PWS_EMAIL_RECIPIENT
Set the Email Recipient for receiving Report email notifications if PWS_EMAIL_STATUS is set as "true". 
PWS_CONTAINER_IMAGE
Set the Target Docker image URL
PWS_CONTAINER_SCANNING_DISABLED
Set this variable "true" to disable the Container Scanning job.


Have more questions? Please email us at support@peerxp.com. 
Also, let us know if the article is helpful!