Git Keys

The playbook keys configured under git control the behavior of the git client used by Antora.

git key

The git key holds all the git-related playbook keys, such as the git credentials, automatic URL suffix, and plugins.

Example 1. antora-playbook.yml

git: (1)
  fetch_concurrency: 3 (2)
  ensure_git_suffix: false (3)
  credentials: (4)
    path: ./.git-credentials (5)
  plugins: (6)
    credential_manager: ./system-git-credential-manager.js (7)
  read_concurrency: 5 (8)

1	Optional `git` category key
2	Optional `fetch_concurrency` key to limit number of concurrent fetch operations
3	Optional `ensure_git_suffix` key
4	Optional `credentials` category key
5	`path` key to specify the location of optional credentials; mutually exclusive with the `contents` key
6	Optional `plugins` category key
7	Optional `credential_manager` key
8	Optional `read_concurrency` key to limit number of concurrent read operations (after repositories are fetched)

The git category key and the child keys it accepts are all optional. When the git key isn’t present in the playbook, Antora falls back to using the default configuration for the git client.

Available git keys

Git Keys Description Required

Git Keys	Description	Required
credentials.contents	Accepts git credentials data matching the format used by the git credential store.	No
credentials.path	Accepts a filesystem path to a git credentials file matching the format used by the git credentials store.	No
fetch_concurrency	`1` by default. Accepts any positive integer or zero. When non-zero, limits the number of concurrent fetch operations to the specified value. When zero, does not limit the number of concurrent fetch operations.	No
plugins.credential_manager	Accepts a require request that specifies the location of the code that provides a custom credential manager.	No
plugins.http	Accepts a require request that specifies the location of the code that provides a custom HTTP request handler.	No
ensure_git_suffix	`true` by default. When `true`, this key instructs the git client to automatically append .git to content sources repository URLs if absent.	No
read_concurrency	`0` by default (effectively no limit). Accepts any positive integer or zero. When non-zero, limits the number of read operations to the specified value. When zero, does not limit the number of read operations.	No

credentials.contents

Accepts git credentials data matching the format used by the git credential store.

credentials.path

Accepts a filesystem path to a git credentials file matching the format used by the git credentials store.

fetch_concurrency

1 by default. Accepts any positive integer or zero. When non-zero, limits the number of concurrent fetch operations to the specified value. When zero, does not limit the number of concurrent fetch operations.

plugins.credential_manager

Accepts a require request that specifies the location of the code that provides a custom credential manager.

plugins.http

Accepts a require request that specifies the location of the code that provides a custom HTTP request handler.

ensure_git_suffix

true by default. When true, this key instructs the git client to automatically append .git to content sources repository URLs if absent.

read_concurrency

0 by default (effectively no limit). Accepts any positive integer or zero. When non-zero, limits the number of read operations to the specified value. When zero, does not limit the number of read operations.