For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jira settings (jira: )

jira: is a list, so you can configure one or more Jira instances (Cloud, Server, or Data Center) in the same config.yml. The settings below are grouped by concern: connection details, how far back and how often to sync, which projects to include or exclude, custom field mapping, optional data types, download tuning, and user filtering.

Key

Required

Description

url

Yes

Your Jira instance URL

instance_slug

yes

Unique name for this instance (e.g. jira)

email

Cloud only

Atlassian account email. Omit for Hivel-managed credentials

token

Yes (self-hosted)

API token (Cloud) or PAT (Server/DC). Omit for Hivel-managed credentials - see Hivel-managed credentials below

username

Server legacy

Basic auth username (legacy)

password

Server legacy

Basic auth password (legacy)

no_verify_ssl

No

Skip TLS verification (self-signed certs)

gdpr_active

No

Force Cloud GDPR mode (auto-detected for *.atlassian.net)

Incremental sync

Key

Required

Default

Description

earliest_issue_date

First run

-

YYYY-MM-DD. Issues updated before this are skipped.

issue_created_after_buffer_days

No

180

Buffer days before earliest_issue_date

Project filtering

Key

Description

include_projects

Only sync these project keys

exclude_projects

Always skip these project keys

include_project_categories

Only sync projects in these Jira categories

exclude_project_categories

Skip projects in these categories

Custom fields

Key

Description

required_hivel_types

Mandatory Hivel semantic types

extra_fields

Custom field IDs to fetch and their semantic mappings

exclude_fields

Field IDs to omit from payload

extra_changelog_fields

Force-include additional changelog fields

Optional data types

Key

Default

Description

download_sprints

false

Fetch board and sprint data

download_worklogs

false

Fetch worklogs per issue (expensive)

download_changelogs

true

Issue status transition history (needed for cycle time)

Issue download tuning

Key

Default

Description

issue_batch_size

100

Page size. Cloud max: 100. Server: up to 250.

issue_download_concurrent_threads

10

Goroutines for concurrent fetching

issue_jql_filter

-

Extra JQL appended to every query

recursively_download_parents

false

Follow parent links to download ancestors

User filtering

Key

Default

Description

required_email_domains

-

Only sync users whose email domain is in this list; users with no matching domain are dropped

is_email_required

false

Drop users with no email address at all

skip_downloading_users

false

Skip the user list fetch entirely - use if your token lacks Browse Users permission, or you don't need user data

Last updated