> For the complete documentation index, see [llms.txt](https://docs.threatrix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.threatrix.io/integrations/build-integrations/jenkins-pipeline.md).

# Jenkins Pipeline

### Install Docker and Docker Pipeline plugins(if not already installed)

* Navigate to Manage Jenkins
* Manage Plugins
* Select the "Installed" tab and enter "docker" in the filter box
* From the results, you should find Docker Plugin and Docker Pipeline as shown below

![](/files/AF8clDyMkuY88MkqpuYE)

### Install Environment Variables

* Grab your orgId and entityId credentials from your profile
* Create and copy an API Key from your profile or Service Key from your admin dashboard (Admin -> Integration -> Service Keys)
* Go to "Manage Jenkins" > "Manage Credentials"
* Choose a Store
* Choose a Domain
* Go to "Add Credentials"
* Select "SecretToken"
* Configure the following Credentials
  * THREATRIX\_OID (orgId from profile)
  * THREATRIX\_EID (one entityID from your list of Entities)
  * THREATRIX\_API\_KEY(your personal API Key from profile or Service Key from Admin)

![](/files/YIadY2JwcN3zmYDBKHN9)

### Install Threat Agent in Pipeline

* Navigate to the pipeline into which you wish to install Threatrix scan agent
* Click configure and navigate to the bottom of page to edit "Pipeline" script
* After the stage(s) where you pull your project(s) into the workspace on the build server, add the following stage snippet to your Pipeline script

```
stage('Threatrix Scan') {
	environment {
		THREATRIX_OID = credentials('THREATRIX_OID')
		THREATRIX_EID = credentials('THREATRIX_EID')
		THREATRIX_API_KEY = credentials('THREATRIX_API_KEY')
	}
	steps {
		script {
				sh 'curl -LJO https://github.com/threatrix/threat-matrix/releases/download/agent-release-latest/threat-agent-latest.jar > /tmp/threatagent.jar'
				sh 'java -jar threatagent.jar --oid=${THREATRIX_OID} --eid=${THREATRIX_EID} --api-key=${THREATRIX_API_KEY} ./'
			}
		}
	}        
}
```

### Install Threatrix Docker in Pipeline

* Navigate to the pipeline into which you wish to install Threatrix scan agent
* Click configure and navigate to the bottom of page to edit "Pipeline" script
* After the stage(s) where you pull your project(s) into the workspace on the build server, add the following stage snippet to your Pipeline script

```
        stage('Threatrix Scan') {
            environment {
                THREATRIX_OID = credentials('THREATRIX_OID')
                THREATRIX_EID = credentials('THREATRIX_EID')
                THREATRIX_API_KEY = credentials('THREATRIX_API_KEY')
            }
            steps {
                script {
                        sh 'sudo docker pull threatrix/threat-agent'
                        sh 'sudo docker run --rm --name threatrix-threat-agent -v $(pwd):/app threatrix/threat-agent --oid=${THREATRIX_OID} --eid=${THREATRIX_EID} --api-key=${THREATRIX_API_KEY} ./'
                    }
                }
            }        
        }
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.threatrix.io/integrations/build-integrations/jenkins-pipeline.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.