Package org.gitlab4j.api.models

Enum Setting

java.lang.Object
java.lang.Enum<Setting>
org.gitlab4j.api.models.Setting
All Implemented Interfaces:
Serializable, Comparable<Setting>, java.lang.constant.Constable
public enum Setting extends Enum<Setting>
This enum provides constants and value validation for the available GitLab application settings. See List of settings that can be accessed via API calls for more information.

  • Enum Constant Details

    • ADMIN_NOTIFICATION_EMAIL

      public static final Setting ADMIN_NOTIFICATION_EMAIL
      Abuse reports will be sent to this address if it is set. Abuse reports are always available in the admin area.

    • AFTER_SIGN_OUT_PATH

      public static final Setting AFTER_SIGN_OUT_PATH
      Where to redirect users after logout.

    • AFTER_SIGN_UP_TEXT

      public static final Setting AFTER_SIGN_UP_TEXT
      Text shown to the user after signing up

    • AKISMET_API_KEY

      public static final Setting AKISMET_API_KEY
      required by: AKISMET_ENABLED API key for Akismet spam protection.

    • AKISMET_ENABLED

      public static final Setting AKISMET_ENABLED
      (If enabled, requires: AKISMET_API_KEY) Enable or disable Akismet spam protection.

    • ALLOW_GROUP_OWNERS_TO_MANAGE_LDAP

      public static final Setting ALLOW_GROUP_OWNERS_TO_MANAGE_LDAP
      (PREMIUM | SILVER) Set to true to allow group owners to manage LDAP

    • ALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES

      @Deprecated public static final Setting ALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES
      Deprecated.
      Use allow_local_requests_from_web_hooks_and_services instead
      Allow requests to the local network from hooks and services.

    • ALLOW_LOCAL_REQUESTS_FROM_SYSTEM_HOOKS

      public static final Setting ALLOW_LOCAL_REQUESTS_FROM_SYSTEM_HOOKS
      Allow requests to the local network from system hooks.

    • ALLOW_LOCAL_REQUESTS_FROM_WEB_HOOKS_AND_SERVICES

      public static final Setting ALLOW_LOCAL_REQUESTS_FROM_WEB_HOOKS_AND_SERVICES
      Allow requests to the local network from web hooks and services.

    • ARCHIVE_BUILDS_IN_HUMAN_READABLE

      public static final Setting ARCHIVE_BUILDS_IN_HUMAN_READABLE
      Set the duration for which the jobs will be considered as old and expired. Once that time passes, the jobs will be archived and no longer able to be retried. Make it empty to never expire jobs. It has to be no less than 1 day, for example: 15 days, 1 month, 2 years.

    • ASSET_PROXY_ENABLED

      public static final Setting ASSET_PROXY_ENABLED
      (If enabled, requires: ASSET_PROXY_URL) Enable proxying of assets. GitLab restart is required to apply changes.

    • ASSET_PROXY_URL

      public static final Setting ASSET_PROXY_URL
      URL of the asset proxy server. GitLab restart is required to apply changes.

    • ASSET_PROXY_WHITELIST

      public static final Setting ASSET_PROXY_WHITELIST
      Assets that match these domain(s) will NOT be proxied. Wildcards allowed. Your GitLab installation URL is automatically whitelisted. GitLab restart is required to apply changes.

    • AUTHORIZED_KEYS_ENABLED

      public static final Setting AUTHORIZED_KEYS_ENABLED
      By default, we write to the authorized_keys file to support Git over SSH without additional configuration. GitLab can be optimized to authenticate SSH keys via the database file. Only disable this if you have configured your OpenSSH server to use the AuthorizedKeysCommand.

    • AUTO_DEVOPS_DOMAIN

      public static final Setting AUTO_DEVOPS_DOMAIN
      Specify a domain to use by default for every project’s Auto Review Apps and Auto Deploy stages.

    • AUTO_DEVOPS_ENABLED

      public static final Setting AUTO_DEVOPS_ENABLED
      Enable Auto DevOps for projects by default. It will automatically build, test, and deploy applications based on a predefined CI/CD configuration.

    • CHECK_NAMESPACE_PLAN

      public static final Setting CHECK_NAMESPACE_PLAN
      (PREMIUM | SILVER) Enabling this will make only licensed EE features available to projects if the project namespace’s plan includes the feature or if the project is public.

    • CLIENTSIDE_SENTRY_DSN

      @Deprecated public static final Setting CLIENTSIDE_SENTRY_DSN
      Deprecated.
      Will be removed in a future version of gitlab4j-api
      required by: CLIENTSIDE_SENTRY_DSN Clientside Sentry Data Source Name. removed by the following commit https://gitlab.com/gitlab-org/gitlab/commit/31c8ca6defd36bd08209ecc8c5913631c316ce37

    • CLIENTSIDE_SENTRY_ENABLED

      @Deprecated public static final Setting CLIENTSIDE_SENTRY_ENABLED
      Deprecated.
      Will be removed in a future version of gitlab4j-api
      (If enabled, requires: CLIENTSIDE_SENTRY_DSN) Enable Sentry error reporting for the client side.

    • COMMIT_EMAIL_HOSTNAME

      public static final Setting COMMIT_EMAIL_HOSTNAME
      Custom hostname (for private commit emails).

    • CONTAINER_REGISTRY_TOKEN_EXPIRE_DELAY

      public static final Setting CONTAINER_REGISTRY_TOKEN_EXPIRE_DELAY
      Container Registry token duration in minutes.

    • DEFAULT_ARTIFACTS_EXPIRE_IN

      public static final Setting DEFAULT_ARTIFACTS_EXPIRE_IN
      Set the default expiration time for each job’s artifacts.

    • DEFAULT_BRANCH_PROTECTION

      public static final Setting DEFAULT_BRANCH_PROTECTION
      Determine if developers can push to master. Can take: 0 (not protected, both developers and maintainers can push new commits, force push, or delete the branch), 1 (partially protected, developers and maintainers can push new commits, but cannot force push or delete the branch) or 2 (fully protected, developers cannot push new commits, but maintainers can; no-one can force push or delete the branch) as a parameter. Default is 2.

    • DEFAULT_CI_CONFIG_PATH

      public static final Setting DEFAULT_CI_CONFIG_PATH

    • DEFAULT_GROUP_VISIBILITY

      public static final Setting DEFAULT_GROUP_VISIBILITY
      What visibility level new groups receive. Can take private, internal and public as a parameter. Default is private.

    • DEFAULT_PROJECT_CREATION

      public static final Setting DEFAULT_PROJECT_CREATION
      Default project creation protection. Can take: 0 (No one), 1 (Maintainers) or 2 (Developers + Maintainers)

    • DEFAULT_PROJECT_VISIBILITY

      public static final Setting DEFAULT_PROJECT_VISIBILITY
      What visibility level new projects receive. Can take private, internal and public as a parameter. Default is private.

    • DEFAULT_PROJECTS_LIMIT

      public static final Setting DEFAULT_PROJECTS_LIMIT
      Project limit per user. Default is 100000.

    • DEFAULT_SNIPPET_VISIBILITY

      public static final Setting DEFAULT_SNIPPET_VISIBILITY
      What visibility level new snippets receive. Can take private, internal and public as a parameter. Default is private.

    • DIFF_MAX_PATCH_BYTES

      public static final Setting DIFF_MAX_PATCH_BYTES
      Maximum diff patch size (Bytes).

    • DISABLED_OAUTH_SIGN_IN_SOURCES

      public static final Setting DISABLED_OAUTH_SIGN_IN_SOURCES
      Disabled OAuth sign-in sources.

    • DNS_REBINDING_PROTECTION_ENABLED

      public static final Setting DNS_REBINDING_PROTECTION_ENABLED
      Enforce DNS rebinding attack protection.

    • DOMAIN_BLACKLIST

      public static final Setting DOMAIN_BLACKLIST
      required by: DOMAIN_BLACKLIST_ENABLED Users with e-mail addresses that match these domain(s) will NOT be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com.

    • DOMAIN_BLACKLIST_ENABLED

      public static final Setting DOMAIN_BLACKLIST_ENABLED
      (If enabled, requires: DOMAIN_BLACKLIST) Allows blocking sign-ups from emails from specific domains.

    • DOMAIN_BLACKLIST_RAW

      @Deprecated public static final Setting DOMAIN_BLACKLIST_RAW
      Deprecated.
      Use DOMAIN_BLACKLIST instead. Will be removed in API v5 see https://gitlab.com/gitlab-org/gitlab/commit/85776fa3ffba6f641cf981cb0107f0e4ba882f3e#40f8529fa8ed874d8e312edb04db18420bf06d31_185_185
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings

    • DOMAIN_WHITELIST

      public static final Setting DOMAIN_WHITELIST
      Force people to use only corporate emails for sign-up. Default is null, meaning there is no restriction.

    • DOMAIN_WHITELIST_RAW

      @Deprecated public static final Setting DOMAIN_WHITELIST_RAW
      Deprecated.
      Use DOMAIN_WHITELIST instead. Will be removed in API v5 see https://gitlab.com/gitlab-org/gitlab/commit/85776fa3ffba6f641cf981cb0107f0e4ba882f3e#40f8529fa8ed874d8e312edb04db18420bf06d31_185_185
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings

    • DSA_KEY_RESTRICTION

      public static final Setting DSA_KEY_RESTRICTION
      The minimum allowed bit length of an uploaded DSA key. Default is 0 (no restriction). -1 disables DSA keys.

    • ECDSA_KEY_RESTRICTION

      public static final Setting ECDSA_KEY_RESTRICTION
      The minimum allowed curve size (in bits) of an uploaded ECDSA key. Default is 0 (no restriction). -1 disables ECDSA keys.

    • ED25519_KEY_RESTRICTION

      public static final Setting ED25519_KEY_RESTRICTION
      The minimum allowed curve size (in bits) of an uploaded ED25519 key. Default is 0 (no restriction). -1 disables ED25519 keys.

    • ELASTICSEARCH_AWS

      public static final Setting ELASTICSEARCH_AWS
      (PREMIUM | SILVER) Enable the use of AWS hosted Elasticsearch

    • ELASTICSEARCH_AWS_ACCESS_KEY

      public static final Setting ELASTICSEARCH_AWS_ACCESS_KEY
      (PREMIUM | SILVER) AWS IAM access key

    • ELASTICSEARCH_AWS_REGION

      public static final Setting ELASTICSEARCH_AWS_REGION
      (PREMIUM | SILVER) The AWS region the Elasticsearch domain is configured

    • ELASTICSEARCH_AWS_SECRET_ACCESS_KEY

      public static final Setting ELASTICSEARCH_AWS_SECRET_ACCESS_KEY
      (PREMIUM | SILVER) AWS IAM secret access key

    • EKS_ACCESS_KEY_ID

      public static final Setting EKS_ACCESS_KEY_ID
      Amazon Access Key.

    • EKS_ACCOUNT_ID

      public static final Setting EKS_ACCOUNT_ID
      Amazon account ID

    • EKS_INTEGRATION_ENABLED

      public static final Setting EKS_INTEGRATION_ENABLED
      Enable integration with Amazon EKS.

    • EKS_SECRET_ACCESS_KEY

      public static final Setting EKS_SECRET_ACCESS_KEY
      AWS IAM secret access key

    • ELASTICSEARCH_EXPERIMENTAL_INDEXER

      @Deprecated public static final Setting ELASTICSEARCH_EXPERIMENTAL_INDEXER
      Deprecated.
      removed in Gitlab 12.3. see https://gitlab.com/gitlab-org/gitlab/commit/82ba4a6a5c78501413012a9f2a918aa7353917a0?view=parallel#fbf64e6b8170f05f1b940fb05902d29f9eba3633_223_223
      (PREMIUM | SILVER) Use the experimental elasticsearch indexer. More info: https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer Ruby indexer was removed and go indexer is no more experimental.

    • ELASTICSEARCH_INDEXING

      public static final Setting ELASTICSEARCH_INDEXING
      (PREMIUM | SILVER) Enable Elasticsearch indexing

    • ELASTICSEARCH_LIMIT_INDEXING

      public static final Setting ELASTICSEARCH_LIMIT_INDEXING
      (PREMIUM | SILVER) Limit Elasticsearch to index certain namespaces and projects

    • ELASTICSEARCH_NAMESPACE_IDS

      public static final Setting ELASTICSEARCH_NAMESPACE_IDS
      (PREMIUM | SILVER) The namespaces to index via Elasticsearch if ELASTICSEARCH_LIMIT_INDEXING is enabled.

    • ELASTICSEARCH_PROJECT_IDS

      public static final Setting ELASTICSEARCH_PROJECT_IDS
      (PREMIUM | SILVER) The projects to index via Elasticsearch if ELASTICSEARCH_LIMIT_INDEXING is enabled.

    • ELASTICSEARCH_URL

      public static final Setting ELASTICSEARCH_URL
      (PREMIUM | SILVER) The url to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (e.g., http://localhost:9200, http://localhost:9201"). If your Elasticsearch instance is password protected, pass the username:password in the URL (e.g., http://username:password@elastic_host:9200/).

    • EMAIL_ADDITIONAL_TEXT

      public static final Setting EMAIL_ADDITIONAL_TEXT
      (PREMIUM | SILVER) Additional text added to the bottom of every email for legal/auditing/compliance reasons

    • EMAIL_AUTHOR_IN_BODY

      public static final Setting EMAIL_AUTHOR_IN_BODY
      Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead.

    • ENABLED_GIT_ACCESS_PROTOCOL

      public static final Setting ENABLED_GIT_ACCESS_PROTOCOL
      Enabled protocols for Git access. Allowed values are: ssh, http, and nil to allow both protocols.

    • ENFORCE_TERMS

      public static final Setting ENFORCE_TERMS
      (If enabled, requires: TERMS) Enforce application ToS to all users.

    • EXTERNAL_AUTH_CLIENT_CERT

      public static final Setting EXTERNAL_AUTH_CLIENT_CERT
      (If enabled, requires: EXTERNAL_AUTH_CLIENT_KEY) The certificate to use to authenticate with the external authorization service

    • EXTERNAL_AUTH_CLIENT_KEY

      public static final Setting EXTERNAL_AUTH_CLIENT_KEY
      required by: EXTERNAL_AUTH_CLIENT_CERT Private key for the certificate when authentication is required for the external authorization service, this is encrypted when stored

    • EXTERNAL_AUTH_CLIENT_KEY_PASS

      public static final Setting EXTERNAL_AUTH_CLIENT_KEY_PASS
      Passphrase to use for the private key when authenticating with the external service this is encrypted when stored

    • EXTERNAL_AUTHORIZATION_SERVICE_DEFAULT_LABEL

      public static final Setting EXTERNAL_AUTHORIZATION_SERVICE_DEFAULT_LABEL
      required by: EXTERNAL_AUTHORIZATION_SERVICE_ENABLED The default classification label to use when requesting authorization and no classification label has been specified on the project

    • EXTERNAL_AUTHORIZATION_SERVICE_ENABLED

      public static final Setting EXTERNAL_AUTHORIZATION_SERVICE_ENABLED
      (If enabled, requires: EXTERNAL_AUTHORIZATION_SERVICE_DEFAULT_LABEL, EXTERNAL_AUTHORIZATION_SERVICE_TIMEOUT and EXTERNAL_AUTHORIZATION_SERVICE_URL) Enable using an external authorization service for accessing projects

    • EXTERNAL_AUTHORIZATION_SERVICE_TIMEOUT

      public static final Setting EXTERNAL_AUTHORIZATION_SERVICE_TIMEOUT
      required by: EXTERNAL_AUTHORIZATION_SERVICE_ENABLED The timeout after which an authorization request is aborted, in seconds. When a request times out, access is denied to the user. (min: 0.001, max: 10, step: 0.001)

    • EXTERNAL_AUTHORIZATION_SERVICE_URL

      public static final Setting EXTERNAL_AUTHORIZATION_SERVICE_URL
      required by: EXTERNAL_AUTHORIZATION_SERVICE_ENABLED URL to which authorization requests will be directed

    • FILE_TEMPLATE_PROJECT_ID

      public static final Setting FILE_TEMPLATE_PROJECT_ID
      (PREMIUM | SILVER) The ID of a project to load custom file templates from

    • FIRST_DAY_OF_WEEK

      public static final Setting FIRST_DAY_OF_WEEK
      Start day of the week for calendar views and date pickers. Valid values are 0 (default) for Sunday, 1 for Monday, and 6 for Saturday.

    • GEO_NODE_ALLOWED_IPS

      public static final Setting GEO_NODE_ALLOWED_IPS
      (PREMIUM | SILVER) Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, 1.1.1.1, 2.2.2.0/24.

    • GEO_STATUS_TIMEOUT

      public static final Setting GEO_STATUS_TIMEOUT
      (PREMIUM | SILVER) The amount of seconds after which a request to get a secondary node status will time out.

    • GITALY_TIMEOUT_DEFAULT

      public static final Setting GITALY_TIMEOUT_DEFAULT
      Default Gitaly timeout, in seconds. This timeout is not enforced for Git fetch/push operations or Sidekiq jobs. Set to 0 to disable timeouts.

    • GITALY_TIMEOUT_FAST

      public static final Setting GITALY_TIMEOUT_FAST
      Gitaly fast operation timeout, in seconds. Some Gitaly operations are expected to be fast. If they exceed this threshold, there may be a problem with a storage shard and ‘failing fast’ can help maintain the stability of the GitLab instance. Set to 0 to disable timeouts.

    • GITALY_TIMEOUT_MEDIUM

      public static final Setting GITALY_TIMEOUT_MEDIUM
      Medium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to 0 to disable timeouts.

    • GRAFANA_ENABLED

      public static final Setting GRAFANA_ENABLED
      Enable Grafana.

    • GRAFANA_URL

      public static final Setting GRAFANA_URL
      Grafana URL.

    • GRAVATAR_ENABLED

      public static final Setting GRAVATAR_ENABLED
      Enable Gravatar.

    • HASHED_STORAGE_ENABLED

      public static final Setting HASHED_STORAGE_ENABLED
      Create new projects using hashed storage paths: Enable immutable, hash-based paths and repository names to store repositories on disk. This prevents repositories from having to be moved or renamed when the Project URL changes and may improve disk I/O performance. (EXPERIMENTAL)

    • HELP_PAGE_HIDE_COMMERCIAL_CONTENT

      public static final Setting HELP_PAGE_HIDE_COMMERCIAL_CONTENT
      Hide marketing-related entries from help.

    • HELP_PAGE_SUPPORT_URL

      public static final Setting HELP_PAGE_SUPPORT_URL
      Alternate support URL for help page and help dropdown.

    • HELP_PAGE_TEXT

      public static final Setting HELP_PAGE_TEXT
      Custom text displayed on the help page.

    • HELP_TEXT

      public static final Setting HELP_TEXT
      (PREMIUM | SILVER) GitLab server administrator information

    • HIDE_THIRD_PARTY_OFFERS

      public static final Setting HIDE_THIRD_PARTY_OFFERS
      Do not display offers from third parties within GitLab.

    • HOME_PAGE_URL

      public static final Setting HOME_PAGE_URL
      Redirect to this URL when not logged in.

    • HOUSEKEEPING_BITMAPS_ENABLED

      public static final Setting HOUSEKEEPING_BITMAPS_ENABLED
      required by: HOUSEKEEPING_ENABLED Enable Git pack file bitmap creation.

    • HOUSEKEEPING_ENABLED

      public static final Setting HOUSEKEEPING_ENABLED
      (If enabled, requires: HOUSEKEEPING_BITMAPS_ENABLED, HOUSEKEEPING_FULL_REPACK_PERIOD, HOUSEKEEPING_GC_PERIOD, and HOUSEKEEPING_INCREMENTAL_REPACK_PERIOD) Enable or disable Git housekeeping.

    • HOUSEKEEPING_FULL_REPACK_PERIOD

      public static final Setting HOUSEKEEPING_FULL_REPACK_PERIOD
      required by: HOUSEKEEPING_ENABLED Number of Git pushes after which an incremental git repack is run.

    • HOUSEKEEPING_GC_PERIOD

      public static final Setting HOUSEKEEPING_GC_PERIOD
      required by: HOUSEKEEPING_ENABLED Number of Git pushes after which git gc is run.

    • HOUSEKEEPING_INCREMENTAL_REPACK_PERIOD

      public static final Setting HOUSEKEEPING_INCREMENTAL_REPACK_PERIOD
      required by: HOUSEKEEPING_ENABLED Number of Git pushes after which an incremental git repack is run.

    • HTML_EMAILS_ENABLED

      public static final Setting HTML_EMAILS_ENABLED
      Enable HTML emails.

    • IMPORT_SOURCES

      public static final Setting IMPORT_SOURCES
      Sources to allow project import from, possible values: github, bitbucket, bitbucket_server, gitlab, google_code, fogbugz, git, gitlab_project, gitea, manifest, and phabricator.

    • INSTANCE_STATISTICS_VISIBILITY_PRIVATE

      public static final Setting INSTANCE_STATISTICS_VISIBILITY_PRIVATE
      When set to true Instance statistics will only be available to admins.

    • LOCAL_MARKDOWN_VERSION

      public static final Setting LOCAL_MARKDOWN_VERSION
      Increase this value when any cached markdown should be invalidated.

    • LOGIN_RECAPTCHA_PROTECTION_ENABLED

      public static final Setting LOGIN_RECAPTCHA_PROTECTION_ENABLED
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings Was added with this commit https://gitlab.com/gitlab-org/gitlab/commit/30e7f01877fd436e21efdf0974d42d8fc83f4883
      Since:
      2019-07-18

    • MAX_ARTIFACTS_SIZE

      public static final Setting MAX_ARTIFACTS_SIZE
      Maximum artifacts size in MB

    • MAX_ATTACHMENT_SIZE

      public static final Setting MAX_ATTACHMENT_SIZE
      Limit attachment size in MB

    • MAX_IMPORT_SIZE

      public static final Setting MAX_IMPORT_SIZE
      Maximum import size in MB. 0 for unlimited. Default = 50

    • MAX_PAGES_SIZE

      public static final Setting MAX_PAGES_SIZE
      Maximum size of pages repositories in MB

    • METRICS_ENABLED

      public static final Setting METRICS_ENABLED
      (If enabled, requires: METRICS_HOST, METRICS_METHOD_CALL_THRESHOLD, METRICS_PACKET_SIZE, METRICS_POOL_SIZE, METRICS_PORT, METRICS_SAMPLE_INTERVAL and METRICS_TIMEOUT) Enable influxDB metrics.

    • METRICS_HOST

      public static final Setting METRICS_HOST
      required by: METRICS_ENABLED InfluxDB host.

    • METRICS_METHOD_CALL_THRESHOLD

      public static final Setting METRICS_METHOD_CALL_THRESHOLD
      required by: METRICS_ENABLED A method call is only tracked when it takes longer than the given amount of milliseconds.

    • METRICS_PACKET_SIZE

      public static final Setting METRICS_PACKET_SIZE
      required by: METRICS_ENABLED The amount of datapoints to send in a single UDP packet.

    • METRICS_POOL_SIZE

      public static final Setting METRICS_POOL_SIZE
      required by: METRICS_ENABLED The amount of InfluxDB connections to keep open.

    • METRICS_PORT

      public static final Setting METRICS_PORT
      required by: METRICS_ENABLED The UDP port to use for connecting to InfluxDB.

    • METRICS_SAMPLE_INTERVAL

      public static final Setting METRICS_SAMPLE_INTERVAL
      required by: METRICS_ENABLED The sampling interval in seconds.

    • METRICS_TIMEOUT

      public static final Setting METRICS_TIMEOUT
      required by: METRICS_ENABLED The amount of seconds after which InfluxDB will time out.

    • MIRROR_AVAILABLE

      public static final Setting MIRROR_AVAILABLE
      Allow repository mirroring to configured by project Maintainers. If disabled, only Admins will be able to configure repository mirroring.

    • MIRROR_CAPACITY_THRESHOLD

      public static final Setting MIRROR_CAPACITY_THRESHOLD
      (PREMIUM | SILVER) Minimum capacity to be available before scheduling more mirrors preemptively

    • MIRROR_MAX_CAPACITY

      public static final Setting MIRROR_MAX_CAPACITY
      (PREMIUM | SILVER) Maximum number of mirrors that can be synchronizing at the same time.

    • MIRROR_MAX_DELAY

      public static final Setting MIRROR_MAX_DELAY
      (PREMIUM | SILVER) Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.

    • OUTBOUND_LOCAL_REQUESTS_WHITELIST

      public static final Setting OUTBOUND_LOCAL_REQUESTS_WHITELIST
      Define a list of trusted domains or ip addresses to which local requests are allowed when local requests for hooks and services are disabled.

    • OUTBOUND_LOCAL_REQUESTS_WHITELIST_RAW

      public static final Setting OUTBOUND_LOCAL_REQUESTS_WHITELIST_RAW
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings Added with this commit https://gitlab.com/gitlab-org/gitlab/commit/336046254cfe69d795bc8ea454daaf5a35b60eac

    • PAGES_DOMAIN_VERIFICATION_ENABLED

      public static final Setting PAGES_DOMAIN_VERIFICATION_ENABLED
      Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled.

    • PASSWORD_AUTHENTICATION_ENABLED

      @Deprecated public static final Setting PASSWORD_AUTHENTICATION_ENABLED
      Deprecated.
      Use PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB instead.
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings Present for retro-compatibility purpose. See https://gitlab.com/gitlab-org/gitlab/commit/63b2082979efe182daf78e8269b252ccc73f93fc#958cb0573403da359fda7dac60baf49147a5c538_166_181

    • PASSWORD_AUTHENTICATION_ENABLED_FOR_GIT

      public static final Setting PASSWORD_AUTHENTICATION_ENABLED_FOR_GIT
      Enable authentication for Git over HTTP(S) via a GitLab account password. Default is true.

    • PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB

      public static final Setting PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB
      Enable authentication for the web interface via a GitLab account password. Default is true.

    • PERFORMANCE_BAR_ALLOWED_GROUP_ID

      @Deprecated public static final Setting PERFORMANCE_BAR_ALLOWED_GROUP_ID
      Deprecated.
      Use PERFORMANCE_BAR_ALLOWED_GROUP_PATH instead.
      ID of the group that is allowed to toggle the performance bar.

    • PERFORMANCE_BAR_ALLOWED_GROUP_PATH

      public static final Setting PERFORMANCE_BAR_ALLOWED_GROUP_PATH
      Path of the group that is allowed to toggle the performance bar.

    • PERFORMANCE_BAR_ENABLED

      @Deprecated public static final Setting PERFORMANCE_BAR_ENABLED
      Deprecated.
      Pass performance_bar_allowed_group_path: nil instead
      Allow enabling the performance bar.

    • PLANTUML_ENABLED

      public static final Setting PLANTUML_ENABLED
      (If enabled, requires: PLANTUML_URL) Enable PlantUML integration. Default is false.

    • PLANTUML_URL

      public static final Setting PLANTUML_URL
      required by: PLANTUML_ENABLED The PlantUML instance URL for integration.

    • POLLING_INTERVAL_MULTIPLIER

      public static final Setting POLLING_INTERVAL_MULTIPLIER
      Interval multiplier used by endpoints that perform polling. Set to 0 to disable polling. The documentation lists this as a decimal, but it is a String in the JSON.

    • PROJECT_EXPORT_ENABLED

      public static final Setting PROJECT_EXPORT_ENABLED
      Enable project export.

    • PROMETHEUS_METRICS_ENABLED

      public static final Setting PROMETHEUS_METRICS_ENABLED
      Enable Prometheus metrics.

    • PROTECTED_CI_VARIABLES

      public static final Setting PROTECTED_CI_VARIABLES
      Environment variables are protected by default.

    • PSEUDONYMIZER_ENABLED

      public static final Setting PSEUDONYMIZER_ENABLED
      (PREMIUM | SILVER) When enabled, GitLab will run a background job that will produce pseudonymized CSVs of the GitLab database that will be uploaded to your configured object storage directory.

    • PUSH_EVENT_HOOKS_LIMIT

      public static final Setting PUSH_EVENT_HOOKS_LIMIT
      Number of changes (branches or tags) in a single push to determine whether webhooks and services will be fired or not. Webhooks and services won’t be submitted if it surpasses that value.

    • PUSH_EVENT_ACTIVITIES_LIMIT

      public static final Setting PUSH_EVENT_ACTIVITIES_LIMIT
      Number of changes (branches or tags) in a single push to determine whether individual push events or bulk push events will be created. Bulk push events will be created if it surpasses that value.

    • RECAPTCHA_ENABLED

      public static final Setting RECAPTCHA_ENABLED
      (If enabled, requires: RECAPTCHA_PRIVATE_KEY and RECAPTCHA_SITE_KEY) Enable reCAPTCHA.

    • RECAPTCHA_PRIVATE_KEY

      public static final Setting RECAPTCHA_PRIVATE_KEY
      required by: RECAPTCHA_ENABLED Private key for reCAPTCHA.

    • RECAPTCHA_SITE_KEY

      public static final Setting RECAPTCHA_SITE_KEY
      required by: RECAPTCHA_ENABLED Site key for reCAPTCHA.

    • RECEIVE_MAX_INPUT_SIZE

      public static final Setting RECEIVE_MAX_INPUT_SIZE
      Maximum push size (MB).

    • REPOSITORY_CHECKS_ENABLED

      public static final Setting REPOSITORY_CHECKS_ENABLED
      GitLab will periodically run git fsck in all project and wiki repositories to look for silent disk corruption issues.

    • REPOSITORY_SIZE_LIMIT

      public static final Setting REPOSITORY_SIZE_LIMIT
      (PREMIUM | SILVER) Size limit per repository (MB)

    • REPOSITORY_STORAGES

      public static final Setting REPOSITORY_STORAGES
      A list of names of enabled storage paths, taken from gitlab.yml. New projects will be created in one of these stores, chosen at random.

    • REQUIRE_TWO_FACTOR_AUTHENTICATION

      public static final Setting REQUIRE_TWO_FACTOR_AUTHENTICATION
      (If enabled, requires: TWO_FACTOR_GRACE_PERIOD) Require all users to set up Two-factor authentication.

    • RESTRICTED_VISIBILITY_LEVELS

      public static final Setting RESTRICTED_VISIBILITY_LEVELS
      Selected levels cannot be used by non-admin users for groups, projects or snippets. Can take private, internal and public as a parameter. Default is null which means there is no restriction.

    • RSA_KEY_RESTRICTION

      public static final Setting RSA_KEY_RESTRICTION
      The minimum allowed bit length of an uploaded RSA key. Default is 0 (no restriction). -1 disables RSA keys.

    • SEND_USER_CONFIRMATION_EMAIL

      public static final Setting SEND_USER_CONFIRMATION_EMAIL
      Send confirmation email on sign-up.

    • SESSION_EXPIRE_DELAY

      public static final Setting SESSION_EXPIRE_DELAY
      Session duration in minutes. GitLab restart is required to apply changes

    • SHARED_RUNNERS_ENABLED

      public static final Setting SHARED_RUNNERS_ENABLED
      (If enabled, requires: SHARED_RUNNERS_TEXT and SHARED_RUNNERS_MINUTES) Enable shared runners for new projects.

    • SHARED_RUNNERS_MINUTES

      public static final Setting SHARED_RUNNERS_MINUTES
      (PREMIUM | SILVER) required by: SHARED_RUNNERS_ENABLED Set the maximum number of pipeline minutes that a group can use on shared Runners per month.

    • SHARED_RUNNERS_TEXT

      public static final Setting SHARED_RUNNERS_TEXT
      required by: SHARED_RUNNERS_ENABLED Shared runners text.

    • SIGN_IN_TEXT

      public static final Setting SIGN_IN_TEXT
      Text on the login page.

    • SIGNIN_ENABLED

      @Deprecated public static final Setting SIGNIN_ENABLED
      Deprecated.
      Use PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB instead
      Flag indicating if password authentication is enabled for the web interface. Documentation lists this as a String, but it s a Boolean.

    • SIGNUP_ENABLED

      public static final Setting SIGNUP_ENABLED
      Enable registration. Default is true.

    • SLACK_APP_ENABLED

      public static final Setting SLACK_APP_ENABLED
      (PREMIUM | SILVER) (If enabled, requires: SLACK_APP_ID, SLACK_APP_SECRET and SLACK_APP_VERIFICATION_TOKEN) Enable Slack app.

    • SLACK_APP_ID

      public static final Setting SLACK_APP_ID
      (PREMIUM | SILVER) required by: SLACK_APP_ENABLED The app id of the Slack-app.

    • SLACK_APP_SECRET

      public static final Setting SLACK_APP_SECRET
      (PREMIUM | SILVER) required by: SLACK_APP_ENABLED The app secret of the Slack-app.

    • SLACK_APP_VERIFICATION_TOKEN

      public static final Setting SLACK_APP_VERIFICATION_TOKEN
      (PREMIUM | SILVER) required by: SLACK_APP_ENABLED The verification token of the Slack-app.

    • SNOWPLOW_APP_ID

      public static final Setting SNOWPLOW_APP_ID
      The Snowplow site name / application id. (e.g. gitlab)

    • SNOWPLOW_COLLECTOR_HOSTNAME

      public static final Setting SNOWPLOW_COLLECTOR_HOSTNAME
      required by: SNOWPLOW_ENABLED The Snowplow collector hostname. (e.g. snowplow.trx.gitlab.net)

    • SNOWPLOW_ENABLED

      public static final Setting SNOWPLOW_ENABLED
      (If enabled, requires: SNOWPLOW_COLLECTOR_HOSTNAME) Enable snowplow tracking.

    • SNOWPLOW_IGLU_REGISTRY_URL

      public static final Setting SNOWPLOW_IGLU_REGISTRY_URL
      The Snowplow base Iglu Schema Registry URL to use for custom context and self describing events.

    • SNOWPLOW_SITE_ID

      public static final Setting SNOWPLOW_SITE_ID
      The Snowplow site name / application id. (e.g. gitlab)

    • SOURCEGRAPH_ENABLED

      public static final Setting SOURCEGRAPH_ENABLED
      Enables Sourcegraph integration. Default is false. If enabled, requires sourcegraph_url.

    • SOURCEGRAPH_PUBLIC_ONLY

      public static final Setting SOURCEGRAPH_PUBLIC_ONLY
      Blocks Sourcegraph from being loaded on private and internal projects. Defaul is true.

    • SOURCEGRAPH_URL

      public static final Setting SOURCEGRAPH_URL
      The Sourcegraph instance URL for integration.

    • SPAM_CHECK_ENDPOINT_ENABLED

      public static final Setting SPAM_CHECK_ENDPOINT_ENABLED
      Enables Spam Check via external API endpoint. Default is false.

    • SPAM_CHECK_ENDPOINT_URL

      public static final Setting SPAM_CHECK_ENDPOINT_URL
      URL of the external Spam Check service endpoint.

    • PENDO_URL

      public static final Setting PENDO_URL
      required by: PENDO_ENABLED The Pendo endpoint url with js snippet. (e.g. https://cdn.pendo.io/agent/static/your-api-key/pendo.js)

    • PENDO_ENABLED

      public static final Setting PENDO_ENABLED
      (If enabled, requires: PENDO_URL) Enable pendo tracking.

    • STATIC_OBJECTS_EXTERNAL_STORAGE_AUTH_TOKEN

      public static final Setting STATIC_OBJECTS_EXTERNAL_STORAGE_AUTH_TOKEN
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings https://gitlab.com/gitlab-org/gitlab/commit/85975447a2b70d1654f2f8163f55d369e130ef2b

    • STATIC_OBJECTS_EXTERNAL_STORAGE_URL

      public static final Setting STATIC_OBJECTS_EXTERNAL_STORAGE_URL
      NOT DOCUMENTED: but it's returned by a call to /api/v4/application/settings https://gitlab.com/gitlab-org/gitlab/commit/85975447a2b70d1654f2f8163f55d369e130ef2b

    • TERMINAL_MAX_SESSION_TIME

      public static final Setting TERMINAL_MAX_SESSION_TIME
      Maximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time.

    • TERMS

      public static final Setting TERMS
      required by: ENFORCE_TERMS Markdown content for the ToS.

    • THROTTLE_AUTHENTICATED_API_ENABLED

      public static final Setting THROTTLE_AUTHENTICATED_API_ENABLED
      (If enabled, requires: THROTTLE_AUTHENTICATED_API_PERIOD_IN_SECONDS and THROTTLE_AUTHENTICATED_API_REQUESTS_PER_PERIOD) Enable authenticated API request rate limit. Helps reduce request volume (e.g. from crawlers or abusive bots).

    • THROTTLE_AUTHENTICATED_API_PERIOD_IN_SECONDS

      public static final Setting THROTTLE_AUTHENTICATED_API_PERIOD_IN_SECONDS
      required by: THROTTLE_AUTHENTICATED_API_ENABLED Rate limit period in seconds.

    • THROTTLE_AUTHENTICATED_API_REQUESTS_PER_PERIOD

      public static final Setting THROTTLE_AUTHENTICATED_API_REQUESTS_PER_PERIOD
      required by: THROTTLE_AUTHENTICATED_API_ENABLED Max requests per period per user.

    • THROTTLE_AUTHENTICATED_WEB_ENABLED

      public static final Setting THROTTLE_AUTHENTICATED_WEB_ENABLED
      (If enabled, requires: THROTTLE_AUTHENTICATED_WEB_PERIOD_IN_SECONDS and THROTTLE_AUTHENTICATED_WEB_REQUESTS_PER_PERIOD) Enable authenticated web request rate limit. Helps reduce request volume (e.g. from crawlers or abusive bots).

    • THROTTLE_AUTHENTICATED_WEB_PERIOD_IN_SECONDS

      public static final Setting THROTTLE_AUTHENTICATED_WEB_PERIOD_IN_SECONDS
      required by: THROTTLE_AUTHENTICATED_WEB_ENABLED Rate limit period in seconds.

    • THROTTLE_AUTHENTICATED_WEB_REQUESTS_PER_PERIOD

      public static final Setting THROTTLE_AUTHENTICATED_WEB_REQUESTS_PER_PERIOD
      required by: THROTTLE_AUTHENTICATED_WEB_ENABLED Max requests per period per user.

    • THROTTLE_UNAUTHENTICATED_ENABLED

      public static final Setting THROTTLE_UNAUTHENTICATED_ENABLED
      (If enabled, requires: THROTTLE_UNAUTHENTICATED_PERIOD_IN_SECONDS and THROTTLE_UNAUTHENTICATED_REQUESTS_PER_PERIOD) Enable unauthenticated request rate limit. Helps reduce request volume (e.g. from crawlers or abusive bots).

    • THROTTLE_UNAUTHENTICATED_PERIOD_IN_SECONDS

      public static final Setting THROTTLE_UNAUTHENTICATED_PERIOD_IN_SECONDS
      required by: THROTTLE_UNAUTHENTICATED_ENABLED Rate limit period in seconds.

    • THROTTLE_UNAUTHENTICATED_REQUESTS_PER_PERIOD

      public static final Setting THROTTLE_UNAUTHENTICATED_REQUESTS_PER_PERIOD
      required by: THROTTLE_UNAUTHENTICATED_ENABLED Max requests per period per IP.

    • TIME_TRACKING_LIMIT_TO_HOURS

      public static final Setting TIME_TRACKING_LIMIT_TO_HOURS
      Limit display of time tracking units to hours. Default is false.

    • TWO_FACTOR_GRACE_PERIOD

      public static final Setting TWO_FACTOR_GRACE_PERIOD
      required by: REQUIRE_TWO_FACTOR_AUTHENTICATION Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication.

    • UNIQUE_IPS_LIMIT_ENABLED

      public static final Setting UNIQUE_IPS_LIMIT_ENABLED
      (If enabled, requires: UNIQUE_IPS_LIMIT_PER_USER and UNIQUE_IPS_LIMIT_TIME_WINDOW) Limit sign in from multiple ips.

    • UNIQUE_IPS_LIMIT_PER_USER

      public static final Setting UNIQUE_IPS_LIMIT_PER_USER
      required by: UNIQUE_IPS_LIMIT_ENABLED Maximum number of ips per user.

    • UNIQUE_IPS_LIMIT_TIME_WINDOW

      public static final Setting UNIQUE_IPS_LIMIT_TIME_WINDOW
      required by: UNIQUE_IPS_LIMIT_ENABLED How many seconds an IP will be counted towards the limit.

    • USAGE_PING_ENABLED

      public static final Setting USAGE_PING_ENABLED
      Every week GitLab will report license usage back to GitLab, Inc.

    • USER_DEFAULT_EXTERNAL

      public static final Setting USER_DEFAULT_EXTERNAL
      Newly registered users will be external by default.

    • USER_DEFAULT_INTERNAL_REGEX

      public static final Setting USER_DEFAULT_INTERNAL_REGEX
      Specify an e-mail address regex pattern to identify default internal users.

    • USER_OAUTH_APPLICATIONS

      public static final Setting USER_OAUTH_APPLICATIONS
      Allow users to register any application to use GitLab as an OAuth provider.

    • USER_SHOW_ADD_SSH_KEY_MESSAGE

      public static final Setting USER_SHOW_ADD_SSH_KEY_MESSAGE
      When set to false disable the “You won’t be able to pull or push project code via SSH” warning shown to users with no uploaded SSH key.

    • VERSION_CHECK_ENABLED

      public static final Setting VERSION_CHECK_ENABLED
      Let GitLab inform you when an update is available.

    • WEB_IDE_CLIENTSIDE_PREVIEW_ENABLED

      public static final Setting WEB_IDE_CLIENTSIDE_PREVIEW_ENABLED
      Client side evaluation (allow live previews of JavaScript projects in the Web IDE using CodeSandbox client side evaluation).

    • CUSTOM_HTTP_CLONE_URL_ROOT

      public static final Setting CUSTOM_HTTP_CLONE_URL_ROOT

    • PROTECTED_PATHS_RAW

      public static final Setting PROTECTED_PATHS_RAW

    • THROTTLE_PROTECTED_PATHS_ENABLED

      public static final Setting THROTTLE_PROTECTED_PATHS_ENABLED

    • THROTTLE_PROTECTED_PATHS_PERIOD_IN_SECONDS

      public static final Setting THROTTLE_PROTECTED_PATHS_PERIOD_IN_SECONDS

    • THROTTLE_PROTECTED_PATHS_REQUESTS_PER_PERIOD

      public static final Setting THROTTLE_PROTECTED_PATHS_REQUESTS_PER_PERIOD

    • FORCE_PAGES_ACCESS_CONTROL

      public static final Setting FORCE_PAGES_ACCESS_CONTROL

    • MINIMUM_PASSWORD_LENGTH

      public static final Setting MINIMUM_PASSWORD_LENGTH

    • SNIPPET_SIZE_LIMIT

      public static final Setting SNIPPET_SIZE_LIMIT

    • EMAIL_RESTRICTIONS_ENABLED

      public static final Setting EMAIL_RESTRICTIONS_ENABLED

    • EMAIL_RESTRICTIONS

      public static final Setting EMAIL_RESTRICTIONS

    • CONTAINER_EXPIRATION_POLICIES_ENABLE_HISTORIC_ENTRIES

      public static final Setting CONTAINER_EXPIRATION_POLICIES_ENABLE_HISTORIC_ENTRIES

    • ISSUES_CREATE_LIMIT

      public static final Setting ISSUES_CREATE_LIMIT

    • RAW_BLOB_REQUEST_LIMIT

      public static final Setting RAW_BLOB_REQUEST_LIMIT

  • Method Details

    • values

      public static Setting[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Setting valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forValue

      public static Setting forValue(String value)

    • toValue

      public String toValue()

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Setting>

    • isValid

      public final boolean isValid(Object value)
      Returns true if the provided value is of the correct type specified by this ApplicationSetting enum, otherwise returns false.
      Parameters:
      value - the value to validate
      Returns:
      true if the value is of the correct type or null

    • validate

      public final void validate(Object value) throws GitLabApiException
      Validates the provided value against the data type of this ApplicationSetting enum. Will throw a GitLabApiException if the value is not of the correct type.
      Parameters:
      value - the value to validate
      Throws:
      GitLabApiException - if the provided value is not a valid type for the ApplicationSetting