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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ADMIN_NOTIFICATION_EMAIL
Abuse reports will be sent to this address if it is set.AFTER_SIGN_OUT_PATH
Where to redirect users after logout.AFTER_SIGN_UP_TEXT
Text shown to the user after signing upAKISMET_API_KEY
required by: akismet_enabled API key for akismet spam protection.AKISMET_ENABLED
(If enabled, requires: akismet_api_key) Enable or disable akismet spam protection.ALLOW_GROUP_OWNERS_TO_MANAGE_LDAP
(Premium) Set to true to allow group owners to manage LDAPALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES
Allow requests to the local network from hooks and services.ARCHIVE_BUILDS_IN_HUMAN_READABLE
AUTHORIZED_KEYS_ENABLED
By default, we write to the authorized_keys file to support Git over SSH without additional configuration.AUTO_DEVOPS_DOMAIN
Specify a domain to use by default for every project’s Auto Review Apps and Auto Deploy stages.AUTO_DEVOPS_ENABLED
Enable Auto DevOps for projects by default.CHECK_NAMESPACE_PLAN
(Premium) 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
required by: clientside_sentry_enabled Clientside Sentry Data Source Name.CLIENTSIDE_SENTRY_ENABLED
(If enabled, requires: clientside_sentry_dsn) Enable Sentry error reporting for the client side.COMMIT_EMAIL_HOSTNAME
CONTAINER_REGISTRY_TOKEN_EXPIRE_DELAY
Container Registry token duration in minutes.DEFAULT_ARTIFACTS_EXPIRE_IN
Set the default expiration time for each job’s artifacts.DEFAULT_BRANCH_PROTECTION
Determine if developers can push to master.DEFAULT_GROUP_VISIBILITY
What visibility level new groups receive.DEFAULT_PROJECT_CREATION
DEFAULT_PROJECT_VISIBILITY
What visibility level new projects receive.DEFAULT_PROJECTS_LIMIT
Project limit per user.DEFAULT_SNIPPET_VISIBILITY
What visibility level new snippets receive.DIFF_MAX_PATCH_BYTES
DISABLED_OAUTH_SIGN_IN_SOURCES
Disabled OAuth sign-in sources.DOMAIN_BLACKLIST
required by: domain_blacklist_enabled Users with e-mail addresses that match these domain(s) will NOT be able to sign-up.DOMAIN_BLACKLIST_ENABLED
(If enabled, requires: domain_blacklist) Allows blocking sign-ups from emails from specific domains.DOMAIN_BLACKLIST_RAW
DOMAIN_WHITELIST
Force people to use only corporate emails for sign-up.DOMAIN_WHITELIST_RAW
DSA_KEY_RESTRICTION
The minimum allowed bit length of an uploaded DSA key.ECDSA_KEY_RESTRICTION
The minimum allowed curve size (in bits) of an uploaded ECDSA key.ED25519_KEY_RESTRICTION
The minimum allowed curve size (in bits) of an uploaded ED25519 key.ELASTICSEARCH_AWS
(Premium) Enable the use of AWS hosted ElasticsearchELASTICSEARCH_AWS_ACCESS_KEY
(Premium) AWS IAM access keyELASTICSEARCH_AWS_REGION
(Premium) The AWS region the elasticsearch domain is configuredELASTICSEARCH_AWS_SECRET_ACCESS_KEY
(Premium) AWS IAM secret access keyELASTICSEARCH_EXPERIMENTAL_INDEXER
(Premium) Use the experimental elasticsearch indexer.ELASTICSEARCH_INDEXING
(Premium) Enable Elasticsearch indexingELASTICSEARCH_SEARCH
(Premium) Enable Elasticsearch searchELASTICSEARCH_URL
(Premium) The url to use for connecting to Elasticsearch.EMAIL_ADDITIONAL_TEXT
(Premium) Additional text added to the bottom of every email for legal/auditing/compliance reasonsEMAIL_AUTHOR_IN_BODY
Some email servers do not support overriding the email sender name.ENABLED_GIT_ACCESS_PROTOCOL
Enabled protocols for Git access.ENFORCE_TERMS
(If enabled, requires: terms) Enforce application ToS to all users.EXTERNAL_AUTH_CLIENT_CERT
(Premium) (If enabled, requires: external_auth_client_key) The certificate to use to authenticate with the external authorization serviceEXTERNAL_AUTH_CLIENT_KEY
required by: external_auth_client_cert (Premium) Private key for the certificate when authentication is required for the external authorization service, this is encrypted when storedEXTERNAL_AUTH_CLIENT_KEY_PASS
(Premium) Passphrase to use for the private key when authenticating with the external service this is encrypted when storedEXTERNAL_AUTHORIZATION_SERVICE_DEFAULT_LABEL
required by: external_authorization_service_enabled (Premium) The default classification label to use when requesting authorization and no classification label has been specified on the projectEXTERNAL_AUTHORIZATION_SERVICE_ENABLED
(Premium) (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 projectsEXTERNAL_AUTHORIZATION_SERVICE_TIMEOUT
required by: external_authorization_service_enabled (Premium) The timeout after which an authorization request is aborted, in seconds.EXTERNAL_AUTHORIZATION_SERVICE_URL
required by: external_authorization_service_enabled (Premium) URL to which authorization requests will be directedFILE_TEMPLATE_PROJECT_ID
(Premium) The ID of a project to load custom file templates fromFIRST_DAY_OF_WEEK
Start day of the week for calendar views and date pickers.GEO_NODE_ALLOWED_IPS
(Premium) Comma-separated list of IPs and CIDRs of allowed secondary nodes.GEO_STATUS_TIMEOUT
(Premium) The amount of seconds after which a request to get a secondary node status will time out.GITALY_TIMEOUT_DEFAULT
Default Gitaly timeout, in seconds.GITALY_TIMEOUT_FAST
Gitaly fast operation timeout, in seconds.GITALY_TIMEOUT_MEDIUM
Medium Gitaly timeout, in seconds.GRAVATAR_ENABLED
Enable Gravatar.HASHED_STORAGE_ENABLED
Create new projects using hashed storage paths: Enable immutable, hash-based paths and repository names to store repositories on disk.HELP_PAGE_HIDE_COMMERCIAL_CONTENT
Hide marketing-related entries from help.HELP_PAGE_SUPPORT_URL
Alternate support URL for help page.HELP_PAGE_TEXT
Custom text displayed on the help page.HELP_TEXT
(Premium) GitLab server administrator informationHIDE_THIRD_PARTY_OFFERS
Do not display offers from third parties within GitLab.HOME_PAGE_URL
Redirect to this URL when not logged in.HOUSEKEEPING_BITMAPS_ENABLED
required by: housekeeping_enabled Enable Git pack file bitmap creation.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
required by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.HOUSEKEEPING_GC_PERIOD
required by: housekeeping_enabled Number of Git pushes after which git gc is run.HOUSEKEEPING_INCREMENTAL_REPACK_PERIOD
required by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.HTML_EMAILS_ENABLED
Enable HTML emails.IMPORT_SOURCES
Sources to allow project import from, possible values: github, bitbucket, gitlab, google_code, fogbugz, git, and gitlab_project.INSTANCE_STATISTICS_VISIBILITY_PRIVATE
When set to true Instance statistics will only be available to admins.LOCAL_MARKDOWN_VERSION
Increase this value when any cached markdown should be invalidated.MAX_ARTIFACTS_SIZE
Maximum artifacts size in MBMAX_ATTACHMENT_SIZE
Limit attachment size in MBMAX_PAGES_SIZE
Maximum size of pages repositories in MBMETRICS_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
required by: metrics_enabled InfluxDB host.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
required by: metrics_enabled The amount of datapoints to send in a single UDP packet.METRICS_POOL_SIZE
required by: metrics_enabled The amount of InfluxDB connections to keep open.METRICS_PORT
required by: metrics_enabled The UDP port to use for connecting to InfluxDB.METRICS_SAMPLE_INTERVAL
required by: metrics_enabled The sampling interval in seconds.METRICS_TIMEOUT
required by: metrics_enabled The amount of seconds after which InfluxDB will time out.MIRROR_AVAILABLE
Allow mirrors to be set up for projects.MIRROR_CAPACITY_THRESHOLD
(Premium) Minimum capacity to be available before scheduling more mirrors preemptivelyMIRROR_MAX_CAPACITY
(Premium) Maximum number of mirrors that can be synchronizing at the same time.MIRROR_MAX_DELAY
(Premium) Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.PAGES_DOMAIN_VERIFICATION_ENABLED
Require users to prove ownership of custom domains.PASSWORD_AUTHENTICATION_ENABLED
PASSWORD_AUTHENTICATION_ENABLED_FOR_GIT
Enable authentication for Git over HTTP(S) via a GitLab account password.PASSWORD_AUTHENTICATION_ENABLED_FOR_WEB
Enable authentication for the web interface via a GitLab account password.PERFORMANCE_BAR_ALLOWED_GROUP_ID
(Deprecated: Use performance_bar_allowed_group_path instead) Path of the group that is allowed to toggle the performance bar.PERFORMANCE_BAR_ALLOWED_GROUP_PATH
Path of the group that is allowed to toggle the performance bar.PERFORMANCE_BAR_ENABLED
(Deprecated: Pass performance_bar_allowed_group_path: nil instead) Allow enabling the performance bar.PLANTUML_ENABLED
(If enabled, requires: plantuml_url) Enable PlantUML integration.PLANTUML_URL
required by: plantuml_enabled The PlantUML instance URL for integration.POLLING_INTERVAL_MULTIPLIER
Interval multiplier used by endpoints that perform polling.PROJECT_EXPORT_ENABLED
Enable project export.PROMETHEUS_METRICS_ENABLED
Enable prometheus metrics.PROTECTED_CI_VARIABLES
PSEUDONYMIZER_ENABLED
(Premium) 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.RECAPTCHA_ENABLED
(If enabled, requires: recaptcha_private_key and recaptcha_site_key) Enable recaptcha.RECAPTCHA_PRIVATE_KEY
required by: recaptcha_enabled Private key for recaptcha.RECAPTCHA_SITE_KEY
required by: recaptcha_enabled Site key for recaptcha.RECEIVE_MAX_INPUT_SIZE
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
(Premium) Size limit per repository (MB)REPOSITORY_STORAGES
A list of names of enabled storage paths, taken from gitlab.yml.REQUIRE_TWO_FACTOR_AUTHENTICATION
(If enabled, requires: two_factor_grace_period) Require all users to set up Two-factor authentication.RESTRICTED_VISIBILITY_LEVELS
Selected levels cannot be used by non-admin users for groups, projects or snippets.RSA_KEY_RESTRICTION
The minimum allowed bit length of an uploaded RSA key.SEND_USER_CONFIRMATION_EMAIL
Send confirmation email on sign-up.SENTRY_DSN
required by: sentry_enabled Sentry Data Source Name.SENTRY_ENABLED
(If enabled, requires: sentry_dsn) Sentry is an error reporting and logging tool which is currently not shipped with GitLab, available at https://sentry.io.SESSION_EXPIRE_DELAY
Session duration in minutes.SHARED_RUNNERS_ENABLED
(If enabled, requires: shared_runners_text and shared_runners_minutes) Enable shared runners for new projects.SHARED_RUNNERS_MINUTES
required by: shared_runners_enabled (Premium) Set the maximum number of pipeline minutes that a group can use on shared Runners per month.SHARED_RUNNERS_TEXT
required by: shared_runners_enabled Shared runners text.SIGN_IN_TEXT
Text on the login page.SIGNIN_ENABLED
(Deprecated: Use password_authentication_enabled_for_web instead) Flag indicating if password authentication is enabled for the web interface.SIGNUP_ENABLED
Enable registration.SLACK_APP_ENABLED
(Premium) (If enabled, requires: slack_app_id, slack_app_secret and slack_app_secret) Enable Slack app.SLACK_APP_ID
string required by: slack_app_enabled (Premium) The app id of the Slack-app.SLACK_APP_SECRET
required by: slack_app_enabled (Premium) The app secret of the Slack-app.SLACK_APP_VERIFICATION_TOKEN
required by: slack_app_enabled (Premium) The verification token of the Slack-app.TERMINAL_MAX_SESSION_TIME
Maximum time for web terminal websocket connection (in seconds).TERMS
required by: enforce_terms (Required by: enforce_terms) Markdown content for the ToS.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.THROTTLE_AUTHENTICATED_API_PERIOD_IN_SECONDS
required by: throttle_authenticated_api_enabled Rate limit period in seconds.THROTTLE_AUTHENTICATED_API_REQUESTS_PER_PERIOD
required by: throttle_authenticated_api_enabled Max requests per period per user.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.THROTTLE_AUTHENTICATED_WEB_PERIOD_IN_SECONDS
required by: throttle_authenticated_web_enabled Rate limit period in seconds.THROTTLE_AUTHENTICATED_WEB_REQUESTS_PER_PERIOD
required by: throttle_authenticated_web_enabled Max requests per period per user.THROTTLE_UNAUTHENTICATED_ENABLED
(If enabled, requires: throttle_unauthenticated_period_in_seconds and throttle_unauthenticated_requests_per_period) Enable unauthenticated request rate limit.THROTTLE_UNAUTHENTICATED_PERIOD_IN_SECONDS
required by: throttle_unauthenticated_enabled Rate limit period in seconds.THROTTLE_UNAUTHENTICATED_REQUESTS_PER_PERIOD
required by: throttle_unauthenticated_enabled Max requests per period per IP.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
(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
integer required by: unique_ips_limit_enabled Maximum number of ips per user.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
Every week GitLab will report license usage back to GitLab, Inc.USER_DEFAULT_EXTERNAL
Newly registered users will be external by default.USER_DEFAULT_INTERNAL_REGEX
USER_OAUTH_APPLICATIONS
Allow users to register any application to use GitLab as an OAuth provider.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
Let GitLab inform you when an update is available.WEB_IDE_CLIENTSIDE_PREVIEW_ENABLED
-
Method Summary
Modifier and Type Method Description static Setting
forValue(String value)
Class<?>
getType()
boolean
isValid(Object value)
Returns true if the provided value is of the correct type specified by this ApplicationSetting enum, otherwise returns false.String
toString()
String
toValue()
void
validate(Object value)
Validates the provided value against the data type of this ApplicationSetting enum.static Setting
valueOf(String name)
Returns the enum constant of this type with the specified name.static Setting[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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) Set to true to allow group owners to manage LDAP
-
ALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES
public static final Setting ALLOW_LOCAL_REQUESTS_FROM_HOOKS_AND_SERVICES
Allow requests to the local network from hooks and services.
-
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) 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
public static final Setting CLIENTSIDE_SENTRY_DSN
required by: clientside_sentry_enabled Clientside Sentry Data Source Name.
-
CLIENTSIDE_SENTRY_ENABLED
public static final Setting CLIENTSIDE_SENTRY_ENABLED
(If enabled, requires: clientside_sentry_dsn) Enable Sentry error reporting for the client side.
-
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_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_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.
-
DISABLED_OAUTH_SIGN_IN_SOURCES
public static final Setting DISABLED_OAUTH_SIGN_IN_SOURCES
Disabled OAuth sign-in sources.
-
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_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.
-
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) Enable the use of AWS hosted Elasticsearch
-
ELASTICSEARCH_AWS_ACCESS_KEY
public static final Setting ELASTICSEARCH_AWS_ACCESS_KEY
(Premium) AWS IAM access key
-
ELASTICSEARCH_AWS_REGION
public static final Setting ELASTICSEARCH_AWS_REGION
(Premium) The AWS region the elasticsearch domain is configured
-
ELASTICSEARCH_AWS_SECRET_ACCESS_KEY
public static final Setting ELASTICSEARCH_AWS_SECRET_ACCESS_KEY
(Premium) AWS IAM secret access key
-
ELASTICSEARCH_EXPERIMENTAL_INDEXER
public static final Setting ELASTICSEARCH_EXPERIMENTAL_INDEXER
(Premium) Use the experimental elasticsearch indexer. More info: https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer
-
ELASTICSEARCH_INDEXING
public static final Setting ELASTICSEARCH_INDEXING
(Premium) Enable Elasticsearch indexing
-
ELASTICSEARCH_SEARCH
public static final Setting ELASTICSEARCH_SEARCH
(Premium) Enable Elasticsearch search
-
ELASTICSEARCH_URL
public static final Setting ELASTICSEARCH_URL
(Premium) 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,
-
EMAIL_ADDITIONAL_TEXT
public static final Setting EMAIL_ADDITIONAL_TEXT
(Premium) 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
(Premium) (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 (Premium) 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
(Premium) 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 (Premium) 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
(Premium) (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 (Premium) 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 (Premium) URL to which authorization requests will be directed
-
FILE_TEMPLATE_PROJECT_ID
public static final Setting FILE_TEMPLATE_PROJECT_ID
(Premium) 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) 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) 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.
-
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.
-
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) 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, gitlab, google_code, fogbugz, git, and gitlab_project.
-
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.
-
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_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 mirrors to be set up for projects. If disabled, only admins will be able to set up mirrors in projects.
-
MIRROR_CAPACITY_THRESHOLD
public static final Setting MIRROR_CAPACITY_THRESHOLD
(Premium) Minimum capacity to be available before scheduling more mirrors preemptively
-
MIRROR_MAX_CAPACITY
public static final Setting MIRROR_MAX_CAPACITY
(Premium) Maximum number of mirrors that can be synchronizing at the same time.
-
MIRROR_MAX_DELAY
public static final Setting MIRROR_MAX_DELAY
(Premium) Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.
-
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_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
public static final Setting PERFORMANCE_BAR_ALLOWED_GROUP_ID
(Deprecated: Use performance_bar_allowed_group_path instead) Path 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
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 liusts 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.
-
PSEUDONYMIZER_ENABLED
public static final Setting PSEUDONYMIZER_ENABLED
(Premium) 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.
-
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.
-
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) 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.
-
SENTRY_DSN
public static final Setting SENTRY_DSN
required by: sentry_enabled Sentry Data Source Name.
-
SENTRY_ENABLED
public static final Setting SENTRY_ENABLED
(If enabled, requires: sentry_dsn) Sentry is an error reporting and logging tool which is currently not shipped with GitLab, available at https://sentry.io.
-
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
required by: shared_runners_enabled (Premium) 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
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) (If enabled, requires: slack_app_id, slack_app_secret and slack_app_secret) Enable Slack app.
-
SLACK_APP_ID
public static final Setting SLACK_APP_ID
string required by: slack_app_enabled (Premium) The app id of the Slack-app.
-
SLACK_APP_SECRET
public static final Setting SLACK_APP_SECRET
required by: slack_app_enabled (Premium) The app secret of the Slack-app.
-
SLACK_APP_VERIFICATION_TOKEN
public static final Setting SLACK_APP_VERIFICATION_TOKEN
required by: slack_app_enabled (Premium) The verification token of the Slack-app.
-
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 (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.
-
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
integer 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_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.
-
ARCHIVE_BUILDS_IN_HUMAN_READABLE
public static final Setting ARCHIVE_BUILDS_IN_HUMAN_READABLE
-
DEFAULT_PROJECT_CREATION
public static final Setting DEFAULT_PROJECT_CREATION
-
DOMAIN_BLACKLIST_RAW
public static final Setting DOMAIN_BLACKLIST_RAW
-
DOMAIN_WHITELIST_RAW
public static final Setting DOMAIN_WHITELIST_RAW
-
RECEIVE_MAX_INPUT_SIZE
public static final Setting RECEIVE_MAX_INPUT_SIZE
-
USER_DEFAULT_INTERNAL_REGEX
public static final Setting USER_DEFAULT_INTERNAL_REGEX
-
WEB_IDE_CLIENTSIDE_PREVIEW_ENABLED
public static final Setting WEB_IDE_CLIENTSIDE_PREVIEW_ENABLED
-
DIFF_MAX_PATCH_BYTES
public static final Setting DIFF_MAX_PATCH_BYTES
-
COMMIT_EMAIL_HOSTNAME
public static final Setting COMMIT_EMAIL_HOSTNAME
-
PROTECTED_CI_VARIABLES
public static final Setting PROTECTED_CI_VARIABLES
-
PASSWORD_AUTHENTICATION_ENABLED
public static final Setting PASSWORD_AUTHENTICATION_ENABLED
-
-
Method Detail
-
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 nameNullPointerException
- if the argument is null
-
getType
public final Class<?> getType()
-
toValue
public String toValue()
-
isValid
public 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
-
-