Advanced Management and Configuration

Frogbot offers two layers of configuration, listed from highest to lowest priority:

  1. Environment variables
  2. Frogbot Configuration under Administration > Xray Settings > Indexed Resources > Git Repositories tab.

Frogbot Configuration

Frogbot Configuration allows you to manage Frogbot settings for all your Git repositories from the JFrog Platform UI, without modifying repository files or CI pipelines.

Accessing Frogbot Configuration

  1. Navigate to Administration > Xray Settings > Indexed Resources > Git Repositories.
  2. The table displays your connected git servers, folders, and repositories.
  3. Click on any entry to open the Frogbot Configuration drawer.

On a Git repository, the drawer includes a Workspace list. Select a workspace before you apply scan, auto-fix, or pull request settings. Click Manage Workspaces in that list, or use Manage Workspaces in the repository row actions, to add, rename, or delete workspaces. You can't rename or delete the default workspace. For the full procedure, see Manage Frogbot Workspaces.

Configuration Hierarchy

Settings follow your SCM structure and are inherited downward:

Git Server (e.g., github.com/my-org)
  └── Folder (e.g., my-org/backend)
       └── Repository (e.g., my-org/backend/api-service)
  • Server-level settings apply to all folders and repositories on that server.
  • Folder-level settings override server settings and apply to all contents within.
  • Repository-level settings override folder and server settings.

Each entity shows a configuration status:

StatusMeaning
DefaultUsing system default configuration
CustomHas a directly assigned configuration
InheritedUsing a parent entity's configuration

Batch Configuration

To apply the same configuration to multiple entities at once:

  1. Select multiple servers, folders, or repositories in the table.
  2. Click Batch Configure.
  3. Configure settings in the drawer — they will be applied to all selected entities.

Configuration Tabs

The configuration drawer has three tabs:

Scans Configuration

Controls which scanners are enabled and their settings:

ScannerSettings
SCAEnable/disable, exclude paths
Contextual AnalysisEnable/disable, exclude paths
IaCEnable/disable, exclude paths
SecretsEnable/disable, exclude paths, show findings in PR decoration, dynamic token validation, custom secrets
SASTEnable/disable, exclude paths, exclude rules, differential scan

Additional settings:

  • Differential Scan (repository-level only, SAST) — When enabled, scans only the changes introduced in commits or pull requests rather than the entire codebase. This reduces scan time and noise by focusing results on newly introduced code.
  • Snippet Detection (repository-level only) — detect copied open-source code snippets
  • Global Exclude Paths — patterns to exclude across all scanners
  • Global Include Paths — limit scanning to specific paths
  • Advanced Settings:
    • Fail on scan error — fail the CI job if any scanner errors
    • Scanner download source — JFrog Releases (default) or air-gapped Artifactory repository

Auto-PR

Frogbot Auto-PR opens fix pull requests automatically during commit scans. To open a fix pull request on demand from an Xray scan result instead, see Create Fix Pull Requests with Auto-PR.

The following settings control automatic fix pull request behavior:

SettingDescriptionDefault
Create automated fixesEnable/disable Auto-PREnabled
Group all fixes into one PRAggregate all dependency fixes into a single PRDisabled
Branch name templateTemplate for fix branch namesfrogbot-${IMPACTED_PACKAGE}-${BRANCH_NAME_HASH}
Commit message templateTemplate for fix commit messagesUpgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}
PR title templateTemplate for fix PR titles[🐸 Frogbot] Upgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}

Available template variables:

VariableDescription
${IMPACTED_PACKAGE}Name of the vulnerable package being upgraded
${FIX_VERSION}The version that resolves the vulnerability
${BRANCH_NAME_HASH}A unique hash for branch name uniqueness (required in branch name templates)

PR Decorations

Controls how Frogbot comments on pull requests:

SettingDescriptionDefault
Show all security finding typesInclude both vulnerabilities and policy violationsDisabled
Skip comments when no issues foundSuppress the success comment on clean PRsDisabled

Environment Variables Reference

Connection

VariableDescriptionRequired
JF_URLJFrog Platform URLYes
JF_ACCESS_TOKENJFrog access tokenYes (or JF_USER + JF_PASSWORD)
JF_USERJFrog usernameAlternative to JF_ACCESS_TOKEN
JF_PASSWORDJFrog passwordAlternative to JF_ACCESS_TOKEN
JF_GIT_TOKENGit provider personal access tokenYes
JF_GIT_API_ENDPOINTAPI endpoint for GitHub Enterprisehttps://api.github.com
JF_GIT_PROVIDERGit provider: github, gitlab, bitbucketServer, azureRepos
JF_GIT_WORKSPACEFrogbot V3 workspace name. When omitted, Frogbot uses default. This is not the Bitbucket workspace used by JF_GIT_OWNER.

Policy Enforcement

VariableDescriptionDefaultCommit ScanPR Scan
JF_PROJECT_KEYJFrog project key for Xray policiesYesYes

Results Upload

VariableDescriptionDefaultCommit ScanPR Scan
JF_UPLOAD_SBOM_TO_VCSPublish SBOM to GitHub Dependency GraphtrueYes
JF_UPLOAD_PR_SECURITY_RESULTS_TO_VCSUpload PR scan results to GitHub Code Scanning. Available from Frogbot v3.4.falseYes

SAST

VariableDescriptionDefaultCommit ScanPR Scan
JF_SAST_DEFAULT_SCAN_MODESets the SAST scanning mode. Possible values: codebase (full cross-file and data-flow analysis), directory (directory-level analysis, recommended for improving performance on large repositories), and file (file-level analysis for the fastest scans).codebaseYesYes

Debugging

VariableDescription
JFROG_CLI_LOG_LEVELSet to DEBUG for verbose logging

Air-Gapped Environments

By default, Frogbot downloads scanner executables from https://releases.jfrog.io. For air-gapped environments:

  1. Create a Remote Repository in Artifactory:

    • Type: Generic
    • URL: https://releases.jfrog.io
    • Uncheck Store Artifacts Locally
  2. Under Administration > Xray Settings > Indexed Resources, select the Git Repositories tab.

  3. From the three-dot menu, select Configure and set the Scanner download source to Air-gapped repository in the Advanced Settings section and provide the repository name.


Did this page help you?