Skip to content

Installing the CodeLogic Java Agent (Docker)

The CodeLogicJava Agent for Docker provides an easy way to integrate CodeLogic scanning into your build process.

High-Level Overview

  1. Generate the Docker Image
  2. Run the Docker Image
  3. View Scan Results

Generate the Docker Image

  • Click Admin and then select the Installers tab.

    CodeLogic Admin Installers Page

  • Locate the Java Agent Docker Image tile and click Generate.

  • Enter your CodeLogic Server IP address or hostname.
  • Enter the directory path to be scanned in the field provided.
  • Click Next.
  • Copy your code snippet from the Success! window.

  • Docker Options Examples

    • --pull always - ensures that you will always get the newest image
    • --env CODELOGIC_HOST="https://codelogic.com" - passes an environment variable representing the IP address or hostname of the CodeLogic Server
    • --env AGENT_UUID="1f5d0bbc-0924-4c6f-828c-532627c33178" - passes an environment variable for the agent UUID
    • --env AGENT_PASSWORD="AahlDFNbb0PyU378" - passes an environment variable for the agent password
    • --env SCAN_PATH="/scan" - passes an environment variable for the agent to use when scanning
    • --volume "/tmp/mySimulatedApp:/scan" - mounts the directory /tmp/mySimulatedApp onto the directory /scan so that it is accessible by the docker container
    • codelogic.com/codelogic_java:latest - tells docker to download the java agent codelogic_java:latest from the CodeLogic Server
    • See Docker Documentation for more docker options.

Run the Docker Image

Tip

You can copy and paste the code snippet directly into your Jenkins file.

Only analyze an application

analyze -a yourApp -t ARCHIVE -p /locationToYourApp/app.jar

analyze an application with a relational database

analyze -a yourApp -d jdbc:postgresql://localhost:5432/sampledb -t ARCHIVE -p /locationToYourApp/app.jar

For more information, see Binary Scanning via Command Line (Java).

View Scan Results

  • From a web browser on your system, log in to the CodeLogic Server.

  • Select the Explorer tab.

  • Expand the application to view items and their dependencies.