Execution

WebHook

Refer to Webhhok Registration for instructions on registering for WebHooks. To launch the WebHook WebService, select the relevant jar file and run the following command:

java -jar cx-flow-<ver>.jar

The relevant configuration is determined by the application.yml file that resides in the same directory as the jar file, or if an explicit configuration is set to override as defined in the command line as follows:

java -jar cx-flow-<ver>.jar --spring.config.location=/path/to/application.yml --web

Docker

The CxFlow docker images on Docker Hub checkmarxts/cxflow contain the latest and previous versions of CxFlow.

docker pull checkmarxts/cxflow docker run --env-file=.checkmarx --name=cxflow --detach -p <host port>:8080 checkmarxts/cxflow

The env-file provides the necessary overrides during the bootstrap process - urls, credentials, etc - sample below. Alternatively on *Unix hosts, you can use --env-file <(env)` to move the entire environment from the host into the Docker container.

BITBUCKET_TOKEN=<user>:<token>

BITBUCKET_URL=http://xxxxxx:7990

BITBUCKET_API_PATH=/rest/api/1.0/

BITBUCKET_WEBHOOK_TOKEN=XXXXXXX

CHECKMARX_BASE_URL=https://xxxxxxxx

CHECKMARX_CLIENT_SECRET=XXXXXXXXXX

CHECKMARX_PASSWORD=XXXXXXXX

CHECKMARX_USERNAME=XXXXXXXX

CHECKMARX_TEAM=\CxServer\SP\Checkmarx

GITHUB_TOKEN=XXXXXXXXXXXXXX

GITHUB_WEBHOOK_TOKEN=XXXXXXXX

GITLAB_TOKEN=XXXXXXXX

GITLAB_WEBHOOK_TOKEN=XXXXXXXX

JIRA_TOKEN=XXXXXXX

JIRA_USERNAME=XXXXXX

JIRA_URL=https://XXXXXXXXX

JIRA_PROJECT=SS

Note: In order to highly customize the yaml configuration for CxFlow in a Docker environment use this docker image as a base and add custom configuration. Alternatively build from source (Dockerfiles are found in the git repository)