# Settings The following table describe all the configuration options you can set for the application. All the settings can be set using env variables with the format `JIRA_TUI_`, where `` is the name of the setting in the table below. Example: these are equivalent `JIRA_TUI_JIRA_API_USERNAME=foo@bar`, `jira_api_username=foo@bar` The application uses the [XDG specification](https://specifications.freedesktop.org/basedir-spec/latest/) to locate config (and log) files. The default name of the config file is `config.yaml`. You can override the location of the config file via the env variable `JIRA_TUI_CONFIG_FILE`. The application will attempt to load the config file in the following way: 1. If the variable `JIRA_TUI_CONFIG_FILE` is set it will use the file specified by it. 2. If not, if `XDG_CONFIG_HOME` is set then it will load the file `$XDG_CONFIG_HOME/jiratui/config.yaml`. 3. If not, it will attempt to load the file from `$HOME/.config/jiratui/config.yaml`. | Name | Type | Required | Default Value | Description | |-----------------------------------------------------|------------------------|----------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `jira_api_username` | `str` | {bdg-danger}`Yes` | `None` | The username to use for connecting to the Jira API | | `jira_api_token` | `str` | {bdg-danger}`Yes` | `None` | The token to use for connecting to the Jira API | | `jira_api_base_url` | `str` | {bdg-danger}`Yes` | `None` | The base URL of the Jira API | | `jira_user_group_id` | `str` | No {bdg-warning}`DEPRECATED` | `None` | The ID of the group that contains all (or most) of the Jira users in your Jira installation. This value is used as a fall back mechanism to fetch available users | | `jira_base_url` | `str` | No | `None` | This is the base URL of your Jira application. This is used for building the URLs of different web links in the Jira TUI application. Example: `https://.atlassian.net` | | `jira_account_id` | `str` | No | `None` | The ID of the Jira user using the application. This is useful if you want the user selection dropdown widgets to automatically select your user from the options. It is also used as the default reporter of any new work item that is created in the application | | `search_results_per_page` | `int` | No | `30` | The number of results to show in the search results | | `search_issues_default_day_interval` | `int` | No | `15` | This controls how many days worth of issues to fetch when no other search criteria has been defined | | `show_issue_web_links` | `bool` | No | `True` | If `True` then the application will retrieve the remote links related to a work item | | `ignore_users_without_email` | `bool` | No | `True` | Controls whether Jira users without an email address configured should be included in the list of users and users assignable to projects and work items | | `default_project_key_or_id` | `str` | No | `None` | A case-sensitive string that identifies a Jira project. If set then the app will use is as the default selected project in the projects dropdown and will only fetch this project from your Jira instance | | `custom_field_id_sprint` | `str` | No | `None` | The name of the custom field used by your Jira application to identify the sprints. Example: `customfield_12345` | | `fetch_attachments_on_delete` | `bool` | No | `True` | When this is `True` the application will fetch the attachments of a work item after an attachment is deleted from the list of attachments. This makes the data more accurate but slower due to the extra request. When this is False the list of attachments is updated in place | | `fetch_comments_on_delete` | `bool` | No | `True` | When this is `True` the application will fetch the comments of a work item after a comment is deleted from the list of comments. This makes the data more accurate but slower due to the extra request. When this is False the list of comments is updated in place | | `pre_defined_jql_expressions` | `dict` | No | `None` | [See Configuring Pre-defined JQL Expressions](/users/configuration/configuration.md#configuring-pre-defined-jql-expressions) | | `jql_expression_id_for_work_items_search` | `int` | No | `None` | If set to one of the expression IDs defined in `pre_defined_jql_expressions` then the app will use this expression to retrieve work items when not criteria and JQL query is provided by the user. | | `search_results_truncate_work_item_summary` | `int` | No | `None` | When this is defined the summary of a work item will be truncated to the specified length when it is displayed in the search results | | `search_results_style_work_item_status` | `bool` | No | `True` | If `True` the status of a work item will be styled when it is displayed in the search results | | `search_results_style_work_item_type` | `bool` | No | `True` | If `True` the type of a work item will be styled when it is displayed in the search results | | `on_start_up_only_fetch_projects` | `bool` | No | `True` | [See Fetching Only Projects on Startup](/users/configuration/cconfiguration.md#fetching-only-projects-on-startup) | | `tui_title` | `str` | No | `None` | An optional title for the application. This is displayed in the top bar | | `tui_custom_title` | `str` | No | `None` | A custom title for the application. If set, this overrides `tui_title`. If set to empty string, no title will be rendered at all | | `tui_title_include_jira_server_title` | `bool` | No | `True` | [See Include Jira Server Title in the UI Title](/users/configuration/cconfiguration.md#include-jira-server-title-in-the-ui-title) | | `attachments_source_directory` | `str` | No | `/` | The directory to start the search of files that a user wants to attach to work items. The user will be able to navigate though the sub-directories | | `log_file` | `str` | No | `None` | The name of the log file to use | | `log_level` | `str` | No | `WARNING` | The Python's `logging` level to use | | `confirm_before_quit` | `bool` | No | `False` | If this is `True` then the app will ask for confirmation before quitting | | `theme` | `str` | No | `None` | The name of the Textual theme to use for the app. [See Choosing a Theme](/users/configuration/cconfiguration.md#choosing-a-theme) | | `search_results_page_filtering_enabled` | `bool` | No | `True` | If this is `True` users are able to refine the search in the search results. [See Enable Filtering Search Results](/users/configuration/cconfiguration.md#enable-filtering-search-results) | | `search_results_page_filtering_minimum_term_length` | `int` | No | `3` | The minimum number of characters required to refine the search results. [See Enable Filtering Search Results](/users/configuration/cconfiguration.md#enable-filtering-search-results) | | `full_text_search_minimum_term_length` | `int` | No | `3` | When performing full-text search this value controls the minimum length of the search term provided by the user. JiraTUI will always enforce a vlue >= 3; even if you set a value of 0 here. | | `enable_advanced_full_text_search` | `bool` | No | `True` | If `True` full-text search works on any text-based Jira field; otherwise it searches only on summary and description. | | `cloud` | `bool` | No | `True` | Set this to False if you are using Jira Data Center (aka. on-premises) | | `use_bearer_authentication` | `bool` | No | `False` | Set this to True if your Jira instance uses Bearer authentication instead of Basic authentication. | | `search_results_default_order` | `str` | No | `WorkItemsSearchOrderBy.CREATED_DESC` | The default order for search results. | | `ssl` | `SSLConfiguration` | No | `None` | The settings for SSL. | | `git_repositories` | `dict` | No | `None` | Configure the Git repos that are available for creating branches from the UI. [See Setting Git Repositories](/users/configuration/cconfiguration.md#setting-git-repositories) | | `search_on_startup` | `bool` | No | `False` | When `True` the application will search work items on startup. | | `enable_updating_additional_fields` | `bool` | No | `False` | When `True` the application will display (some) custom fields and other system fields in the issue's details tab and allow the user to update their values. See [Enable Updating Additional Fields](/users/configuration/cconfiguration.md#enable-updating-additional-fields) | | `update_additional_fields_ignore_ids` | `list[dict]` | No | `None` | When `enable_updating_additional_fields = True`, some custom fields and system fields with these ids or keys will be ignored and not show in the Details tab and will not be updated. | | `enable_images_support` | `bool` | No | `True` | When `enable_images_support = True` the application will try to display images attached to work items in the Attachments tab. Depending on your terminal application you may need to disable this feature. | | `styling` | `StylingConfiguration` | No | `None` | Settings for styling the dusplay of work item status and types in the search results. [See Customize the Styling of Components](/users/configuration/cconfiguration.md#customize-the-styling-of-components) | | `active_sprint_on_startup` | `bool` | No | `False` | If `True`, the Active Sprint checkbox will be enabled by default when the application starts. [See Searching Work Items in Active Sprint on Startup](/users/configuration/cconfiguration.md#searching-work-items-in-active-sprint-on-startup) | | `enable_creating_additional_fields` | `bool` | No | `False` | When `True` the application will render ALL optional fields from create-metadata when creating work items. See [Configuring Optional Fields in Create Work Item Form](/users/configuration/configuration.md#configuring-optional-fields-in-create-work-item-form) | | `create_additional_fields_ignore_ids` | `list[str]` | No | `None` | List of optional field IDs to ignore/exclude from the create work item form. Works with both default and additional fields modes. Example: `['priority', 'customfield_10001']`. See [Configuring Optional Fields in Create Work Item Form](/users/configuration/configuration.md#configuring-optional-fields-in-create-work-item-form) | | `enable_updating_rich_text` | `bool` | No | `True` | Enables/Disable editing rich-text fields using Markdown. | | `text_editor` | `str` | No | `os.getenv('EDITOR')` | If set and `enable_updating_rich_text = True` the app will use this external editor for editing rich-text fields in the Info tab. | | `fetch_single_project` | `bool` | No | `False` | When `default_project_key_or_id` is set the app will fetch a single project, the one indicated by `default_project_key_or_id`. If the variable is `false` then the app will fetch all the projects. When `default_project_key_or_id` is not set then `fetch_single_project` is ignored. |