Overview
Installing
Configuration

REPO_PATH

The path to the repository is on the file system. If CLONE is true, the repository will be cloned here.

REPO_TYPE

Version control system of the repository. Possible values:

  • GITHUB
  • GITLAB
  • OTHER

REPO_URL

URL to clone or fetch the repository. It may differ from REPO_FOLLOW_URL if only ssh is used for cloning and commits are web-viewable via HTTP.

Example:

export REPO_FOLLOW_URL=https://github.com/apache/pdfbox

REPO_FOLLOW_URL

The URL that will be used to generate quick access links to commits on the web server (GitHub or GitLab).

REPO_COMMIT_URL_TEMPLATE

Template for generating quick links for REPO_FOLLOW_URL. The values are set depending on the repository type:

  • GITHUB
    %s/commit/%s
  • GITLAB
    %s/-/commit/%s

REPO_AUTH_TYPE

Authentication type to use for clone and fetch. Possible values:

REPO_AUTH_USER

User login to use for authentication to clone or fetch the repository.

REPO_AUTH_PASSWORD

Password to use for authentication to clone or fetch the repository.
Will be encrypted in the cache after initialization from config.json or environment variables.

REPO_AUTH_TOKEN

Token to use for authentication to clone or fetch the repository.
Will be encrypted in the cache after initialization from config.json or environment variables.

ISSUE_TRACKER_TYPE

Issue tracking system type. Possible values:

  • JIRA
  • REDMINE
  • OTHER

ISSUE_TRACKER_URL

URL of the issue tracking system.

Example:

export ISSUE_TRACKER_URL=https://issues.apache.org/jira

ISSUE_AUTH_TYPE

Issue tracking system authentication type. Possible values:

  • USER_AND_PASSWORD
  • TOKEN
  • TOKEN_AND_USER_AND_PASSWORD
  • NO_AUTH
Sensitive data will be encrypted in the cache after initialization from config.json or environment variables.

ISSUE_TRACKER_ACCESS_KEY

Issue tracking system access key token.
Will be encrypted in the cache after initialization from config.json or environment variables.

ISSUE_TRACKER_USERNAME

Issue tracking system username.

ISSUE_TRACKER_PASSWORD

Issue tracking system password.

ISSUE_REGEX

The RegExp that will be used to extract the issue keys from the commit description.
Default value: ((?<!([A-Za-z]{1,10})-?)[A-Z]+-\d+)
It corresponds to the keys accepted in JIRA, such as ISSUE-12345.

ISSUE_TRACKER_REDMINE_PLUGIN_ISSUE_ID

If using Redmine and the ISSUE-id plugin, this should be set to true.

FETCH

true to fetch the repository periodically, false otherwise.

CLONE

true to clone the repository into the REPO_PATH, false otherwise.

SOURCE_INDEX_THREADS

How many threads to use for indexing.

DEFAULT_BRANCH

Branch that will be treated as default.

DISABLE_ISSUES_INDEXING

true to disable index issues data, false otherwise.

IS_PUBLIC

Determines if authentication is required to browse the repository.