Configure preferences
In order to configure preferences to fine tune your GitGuardian instance, navigate to Settings > General > Preferences.
Please be careful some preferences allow you to activate features in beta mode. If in doubt, please seek advice from GitGuardian team.
Table of Preferences
General
| Preference | Default Value | Description |
|---|
token_expire_in_days | 7 | Lifespan, in days, of invitations and password reset links |
presence_check_enabled | true | Enable secret presence check. For more info, please refer to Investigate incidents page |
presence_check_display_enabled | true | Enable display of secret presence checks |
background_presence_check_enabled | true | Enable automatic secret presence check in background tasks |
validity_check_enabled | true | Enable secret validity check |
background_validity_check_enabled | true | Enable automatic secret validity check in background tasks |
SAML SSO
For more info, please refer to the SAML SSO page.
| Preference | Default Value | Description |
|---|
use_model_signature_settings | true | Enable the manual configurations of the SAML signatures requirements |
is_custom_nameid_format_enabled | false | Enable the choice of NameID format |
Bitbucket
For more info, please refer to the Bitbucket integration documentation.
| Preference | Default Value | Description |
|---|
min_delay_between_syncs | 60 | Minimum delay, in minutes, between two consecutive synchronizations of a Bitbucket installation |
auth_error_grace_period | 0 | Minimum period, in minutes, of repeated authentication errors after which a token should be revoked |
On Premise
| Preference | Default Value | Description |
|---|
bitbucket_disable_admin_check | false | Disable Bitbucket integration Admin Check when creating integration |
prometheus_metrics_active | false | Activate Prometheus Metrics Exporter on /metrics. For more info, please refer to Applicative metrics page |
custom_telemetry_active | true | Enable sending telemetry metrics to GitGuardian |
openai_api_key | - | OpenAI API key |
Notifier
For more info, please refer to the Custom webhook page.
| Preference | Default Value | Description |
|---|
max_webhooks_per_integration_type | 1000 | Maximum number of configured webhooks per integration type |
Source Scanner (VCS)
For more info, please refer to the Historical scanning page.
| Preference | Default Value | Description |
|---|
minutes_between_scans_per_source | 0 | Minimum minutes between two scans on the same source. (0 = disabled) |
Policy
| Preference | Default Value | Description |
|---|
is_repo_size_controlled | false | Limit size of repositories for historical scan. (removed in 2024.9.0) |
repo_scan_size_limit | 1073741824 | Maximum repository size for historical scan, in Byte. For more info, please refer to the following page. |
repo_scan_pending_limit_in_hours | 168 | Timeout, in hours, of the queue time of a repository's historical scan. For more info, please refer to the following page. |
repo_scan_time_limit_in_sec | 7200 | Timeout, in seconds, for historical scan of repository. For more info, please refer to the following page. |
maximum_scan_size | 1048576 | Maximum document size for secrets detection scan via API, in bytes. |
displayed_content_max_size | 1048576 | Maximum displayed content size, in Byte. Introduced in 2023.11. |
displayed_content_max_lines | 1000 | Maximum displayed content lines. Introduced in 2023.11. |
skip_unchanged_scans | True | This setting allows skipping the historical scan of a repository if it has not changed since the last scan. |
Public API
For more info, please refer to our API documentation.
| Preference | Default Value | Description |
|---|
maximum_multifile_documents | 20 | Maximum number of files in a multi-file document for scanning via API |
maximum_token_per_account | 150 | Maximum number of API keys allowed per workspace |
maximum_token_per_member | 5 | Maximum number of personal access tokens allowed per member |
quotas | 10000000 | Monthly sliding quotas for API calls (removed in 2024.7.0) |
GitHub
For more info, please refer to the GitHub integration documentation.
| Preference | Default Value | Description |
|---|
is_actionable_checkrun_enabled | false | Enables action buttons on checkruns (removed in 2024.2.0) |
check_runs_overrides_labels_ghe | false | Enable overriding the check run settings with repository labels on GitHub Entreprise |
commit_collector_max_workers | 4 | Maximum number of calls per worker for the commit collector. Higher number will make the commit collection faster, but is more prone to reach GitHub rate limits. Expected value between 1 and 4. |
Filters
| Preference | Default Value | Description |
|---|
ai_filters_enabled | false | Enable AI filters on the compatible pages, it requires an OpenAI API key to be setup. |
Health Checks
For more info, please refer to the Checking environment health page.
| Preference | Default Value | Description |
|---|
periodic_enabled | true | Enable periodic health checks. |
periodic_interval | 1h | Removed in 2024.7.0, now configurable with spread_periodic_range_minutes. |
spread_periodic_range_minutes | 60 | Interval between two runs of periodic health checks (in minutes). |
Teams
For more info, please refer to the teams page.
| Preference | Default Value | Description |
|---|
max_teams | 500 | Maximum of team allowed on an account. ⚠️ Exceeding this limit may impact performance. |
Background Presence Check Frequencies
For more info, please refer to the Investigate incidents page.
| Preference | Default Value | Description |
|---|
ignored_old | 0 | Frequency, in days, of automated checks for presence in git history for ignored secret incidents more than 1 year old |
ignored_recent | 178 | Frequency, in days, of automated checks for presence in git history for ignored secret incidents less than 1 year old |
open_old | 7 | Frequency, in days, of automated checks for presence in git history for open secret incidents more than 1 year old |
open_recent | 1 | Frequency, in days, of automated checks for presence in git history for open secret incidents less than 1 year old |
resolved_old | 178 | Frequency, in days, of automated checks for presence in git history for resolved secret incidents more than 1 year old |
resolved_recent | 30 | Frequency, in days, of automated checks for presence in git history for resolved secret incidents less than 1 year old |
Background Validity Check Frequencies
For more info, please refer to the Investigate incidents page.
| Preference | Default Value | Description |
|---|
ignored_old | 0 | Frequency, in days, of automated secret validity checks for ignored secret incidents more than 1 year old |
ignored_recent | 178 | Frequency, in days, of automated secret validity checks for ignored secret incidents less than 1 year old |
open_old | 7 | Frequency, in days, of automated secret validity checks for open secret incidents more than 1 year old |
open_recent | 1 | Frequency, in days, of automated secret validity checks for open secret incidents less than 1 year old |
resolved_old | 178 | Frequency, in days, of automated secret validity checks for resolved secret incidents more than 1 year old |
resolved_recent | 30 | Frequency, in days, of automated secret validity checks for resolved secret incidents less than 1 year old |
