· 7 years ago · Oct 22, 2018, 11:04 AM
1## GitLab configuration settings
2##! This file is generated during initial installation and **is not** modified
3##! during upgrades.
4##! Check out the latest version of this file to know about the different
5##! settings that can be configured by this file, which may be found at:
6##! https://gitlab.com/gitlab-org/omnibus-gitlab/raw/master/files/gitlab-config-template/gitlab.rb.template
7
8
9## GitLab URL
10##! URL on which GitLab will be reachable.
11##! For more details on configuring external_url see:
12##! https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-the-external-url-for-gitlab
13external_url 'http://gitlab.6cc42e6a.ticket-427.linxsys.pl’
14
15## Roles for multi-instance GitLab
16##! The default is to have no roles enabled, which results in GitLab running as an all-in-one instance.
17##! Options:
18##! redis_sentinel_role redis_master_role redis_slave_role geo_primary_role geo_secondary_role
19##! For more deatils on each role, see:
20##! https://docs.gitlab.com/omnibus/roles/README.html#roles
21##!
22# roles ['redis_sentinel_role', 'redis_master_role']
23
24## Legend
25##! The following notations at the beginning of each line may be used to
26##! differentiate between components of this file and to easily select them using
27##! a regex.
28##! ## Titles, subtitles etc
29##! ##! More information - Description, Docs, Links, Issues etc.
30##! Configuration settings have a single # followed by a single space at the
31##! beginning; Remove them to enable the setting.
32
33##! **Configuration settings below are optional.**
34##! **The values currently assigned are only examples and ARE NOT the default
35##! values.**
36
37
38################################################################################
39################################################################################
40## Configuration Settings for GitLab CE and EE ##
41################################################################################
42################################################################################
43
44################################################################################
45## gitlab.yml configuration
46##! Docs: https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/settings/gitlab.yml.md
47################################################################################
48# gitlab_rails['gitlab_ssh_host'] = 'ssh.host_example.com'
49# gitlab_rails['time_zone'] = 'UTC'
50
51### Email Settings
52# gitlab_rails['gitlab_email_enabled'] = true
53# gitlab_rails['gitlab_email_from'] = 'example@example.com'
54# gitlab_rails['gitlab_email_display_name'] = 'Example'
55# gitlab_rails['gitlab_email_reply_to'] = 'noreply@example.com'
56# gitlab_rails['gitlab_email_subject_suffix'] = ''
57
58### GitLab user privileges
59# gitlab_rails['gitlab_default_can_create_group'] = true
60# gitlab_rails['gitlab_username_changing_enabled'] = true
61
62### Default Theme
63# gitlab_rails['gitlab_default_theme'] = 2
64
65### Default project feature settings
66# gitlab_rails['gitlab_default_projects_features_issues'] = true
67# gitlab_rails['gitlab_default_projects_features_merge_requests'] = true
68# gitlab_rails['gitlab_default_projects_features_wiki'] = true
69# gitlab_rails['gitlab_default_projects_features_snippets'] = true
70# gitlab_rails['gitlab_default_projects_features_builds'] = true
71# gitlab_rails['gitlab_default_projects_features_container_registry'] = true
72
73### Automatic issue closing
74###! See https://docs.gitlab.com/ce/customization/issue_closing.html for more
75###! information about this pattern.
76# gitlab_rails['gitlab_issue_closing_pattern'] = "\b((?:[Cc]los(?:e[sd]?|ing)|\b[Ff]ix(?:e[sd]|ing)?|\b[Rr]esolv(?:e[sd]?|ing)|\b[Ii]mplement(?:s|ed|ing)?)(:?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?)|([A-Z][A-Z0-9_]+-\d+))+)"
77
78### Download location
79###! When a user clicks e.g. 'Download zip' on a project, a temporary zip file
80###! is created in the following directory.
81###! Should not be the same path, or a sub directory of any of the `git_data_dirs`
82# gitlab_rails['gitlab_repository_downloads_path'] = 'tmp/repositories'
83
84### Gravatar Settings
85# gitlab_rails['gravatar_plain_url'] = 'http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon'
86# gitlab_rails['gravatar_ssl_url'] = 'https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon'
87
88### Auxiliary jobs
89###! Periodically executed jobs, to self-heal Gitlab, do external
90###! synchronizations, etc.
91###! Docs: https://github.com/ondrejbartas/sidekiq-cron#adding-cron-job
92###! https://docs.gitlab.com/ce/ci/yaml/README.html#artifacts:expire_in
93# gitlab_rails['stuck_ci_jobs_worker_cron'] = "0 0 * * *"
94# gitlab_rails['expire_build_artifacts_worker_cron'] = "50 * * * *"
95# gitlab_rails['pipeline_schedule_worker_cron'] = "41 * * * *"
96# gitlab_rails['ci_archive_traces_cron_worker_cron'] = "17 * * * *"
97# gitlab_rails['repository_check_worker_cron'] = "20 * * * *"
98# gitlab_rails['admin_email_worker_cron'] = "0 0 * * 0"
99# gitlab_rails['repository_archive_cache_worker_cron'] = "0 * * * *"
100# gitlab_rails['pages_domain_verification_cron_worker'] = "*/15 * * * *"
101
102### Webhook Settings
103###! Number of seconds to wait for HTTP response after sending webhook HTTP POST
104###! request (default: 10)
105# gitlab_rails['webhook_timeout'] = 10
106
107### Trusted proxies
108###! Customize if you have GitLab behind a reverse proxy which is running on a
109###! different machine.
110###! **Add the IP address for your reverse proxy to the list, otherwise users
111###! will appear signed in from that address.**
112# gitlab_rails['trusted_proxies'] = []
113
114### Monitoring settings
115###! IP whitelist controlling access to monitoring endpoints
116# gitlab_rails['monitoring_whitelist'] = ['127.0.0.0/8', '::1/128']
117###! Time between sampling of unicorn socket metrics, in seconds
118# gitlab_rails['monitoring_unicorn_sampler_interval'] = 10
119
120### Reply by email
121###! Allow users to comment on issues and merge requests by replying to
122###! notification emails.
123###! Docs: https://docs.gitlab.com/ce/administration/reply_by_email.html
124# gitlab_rails['incoming_email_enabled'] = true
125
126#### Incoming Email Address
127####! The email address including the `%{key}` placeholder that will be replaced
128####! to reference the item being replied to.
129####! **The placeholder can be omitted but if present, it must appear in the
130####! "user" part of the address (before the `@`).**
131# gitlab_rails['incoming_email_address'] = "gitlab-incoming+%{key}@gmail.com"
132
133#### Email account username
134####! **With third party providers, this is usually the full email address.**
135####! **With self-hosted email servers, this is usually the user part of the
136####! email address.**
137# gitlab_rails['incoming_email_email'] = "gitlab-incoming@gmail.com"
138
139#### Email account password
140# gitlab_rails['incoming_email_password'] = "[REDACTED]"
141
142#### IMAP Settings
143# gitlab_rails['incoming_email_host'] = "imap.gmail.com"
144# gitlab_rails['incoming_email_port'] = 993
145# gitlab_rails['incoming_email_ssl'] = true
146# gitlab_rails['incoming_email_start_tls'] = false
147
148#### Incoming Mailbox Settings
149####! The mailbox where incoming mail will end up. Usually "inbox".
150# gitlab_rails['incoming_email_mailbox_name'] = "inbox"
151####! The IDLE command timeout.
152# gitlab_rails['incoming_email_idle_timeout'] = 60
153
154### Job Artifacts
155# gitlab_rails['artifacts_enabled'] = true
156# gitlab_rails['artifacts_path'] = "/var/opt/gitlab/gitlab-rails/shared/artifacts"
157####! Job artifacts Object Store
158####! Docs: https://docs.gitlab.com/ee/administration/job_artifacts.html#using-object-storage
159# gitlab_rails['artifacts_object_store_enabled'] = false
160# gitlab_rails['artifacts_object_store_direct_upload'] = false
161# gitlab_rails['artifacts_object_store_background_upload'] = true
162# gitlab_rails['artifacts_object_store_proxy_download'] = false
163# gitlab_rails['artifacts_object_store_remote_directory'] = "artifacts"
164# gitlab_rails['artifacts_object_store_connection'] = {
165# 'provider' => 'AWS',
166# 'region' => 'eu-west-1',
167# 'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
168# 'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
169# # # The below options configure an S3 compatible host instead of AWS
170# # 'aws_signature_version' => 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
171# # 'endpoint' => 'https://s3.amazonaws.com' # default: nil - Useful for S3 compliant services such as DigitalOcean Spaces
172# # 'host' => 's3.amazonaws.com',
173# # 'path_style' => false # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
174# }
175
176### Git LFS
177# gitlab_rails['lfs_enabled'] = true
178# gitlab_rails['lfs_storage_path'] = "/var/opt/gitlab/gitlab-rails/shared/lfs-objects"
179# gitlab_rails['lfs_object_store_enabled'] = false
180# gitlab_rails['lfs_object_store_direct_upload'] = false
181# gitlab_rails['lfs_object_store_background_upload'] = true
182# gitlab_rails['lfs_object_store_proxy_download'] = false
183# gitlab_rails['lfs_object_store_remote_directory'] = "lfs-objects"
184# gitlab_rails['lfs_object_store_connection'] = {
185# 'provider' => 'AWS',
186# 'region' => 'eu-west-1',
187# 'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
188# 'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
189# # # The below options configure an S3 compatible host instead of AWS
190# # 'aws_signature_version' => 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
191# # 'endpoint' => 'https://s3.amazonaws.com' # default: nil - Useful for S3 compliant services such as DigitalOcean Spaces
192# # 'host' => 's3.amazonaws.com',
193# # 'path_style' => false # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
194# }
195
196### GitLab uploads
197###! Docs: https://docs.gitlab.com/ee/administration/uploads.html
198# gitlab_rails['uploads_storage_path'] = "/var/opt/gitlab/gitlab-rails/public"
199# gitlab_rails['uploads_base_dir'] = "uploads/-/system"
200# gitlab_rails['uploads_object_store_enabled'] = false
201# gitlab_rails['uploads_object_store_direct_upload'] = false
202# gitlab_rails['uploads_object_store_background_upload'] = true
203# gitlab_rails['uploads_object_store_proxy_download'] = false
204# gitlab_rails['uploads_object_store_remote_directory'] = "uploads"
205# gitlab_rails['uploads_object_store_connection'] = {
206# 'provider' => 'AWS',
207# 'region' => 'eu-west-1',
208# 'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
209# 'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
210# # # The below options configure an S3 compatible host instead of AWS
211# # 'host' => 's3.amazonaws.com',
212# # 'aws_signature_version' => 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
213# # 'endpoint' => 'https://s3.amazonaws.com' # default: nil - Useful for S3 compliant services such as DigitalOcean Spaces
214# # 'path_style' => false # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
215# }
216
217### Usage Statistics
218# gitlab_rails['usage_ping_enabled'] = true
219
220### GitLab Mattermost
221###! These settings are void if Mattermost is installed on the same omnibus
222###! install
223# gitlab_rails['mattermost_host'] = "https://mattermost.example.com"
224
225### LDAP Settings
226###! Docs: https://docs.gitlab.com/omnibus/settings/ldap.html
227###! **Be careful not to break the indentation in the ldap_servers block. It is
228###! in yaml format and the spaces must be retained. Using tabs will not work.**
229
230# gitlab_rails['ldap_enabled'] = false
231
232###! **remember to close this block with 'EOS' below**
233# gitlab_rails['ldap_servers'] = YAML.load <<-'EOS'
234# main: # 'main' is the GitLab 'provider ID' of this LDAP server
235# label: 'LDAP'
236# host: '_your_ldap_server'
237# port: 389
238# uid: 'sAMAccountName'
239# bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
240# password: '_the_password_of_the_bind_user'
241# encryption: 'plain' # "start_tls" or "simple_tls" or "plain"
242# verify_certificates: true
243# active_directory: true
244# allow_username_or_email_login: false
245# lowercase_usernames: false
246# block_auto_created_users: false
247# base: ''
248# user_filter: ''
249# ## EE only
250# group_base: ''
251# admin_group: ''
252# sync_ssh_keys: false
253#
254# secondary: # 'secondary' is the GitLab 'provider ID' of second LDAP server
255# label: 'LDAP'
256# host: '_your_ldap_server'
257# port: 389
258# uid: 'sAMAccountName'
259# bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
260# password: '_the_password_of_the_bind_user'
261# encryption: 'plain' # "start_tls" or "simple_tls" or "plain"
262# verify_certificates: true
263# active_directory: true
264# allow_username_or_email_login: false
265# lowercase_usernames: false
266# block_auto_created_users: false
267# base: ''
268# user_filter: ''
269# ## EE only
270# group_base: ''
271# admin_group: ''
272# sync_ssh_keys: false
273# EOS
274
275### OmniAuth Settings
276###! Docs: https://docs.gitlab.com/ce/integration/omniauth.html
277# gitlab_rails['omniauth_enabled'] = false
278# gitlab_rails['omniauth_allow_single_sign_on'] = ['saml']
279# gitlab_rails['omniauth_sync_email_from_provider'] = 'saml'
280# gitlab_rails['omniauth_sync_profile_from_provider'] = ['saml']
281# gitlab_rails['omniauth_sync_profile_attributes'] = ['email']
282# gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'saml'
283# gitlab_rails['omniauth_block_auto_created_users'] = true
284# gitlab_rails['omniauth_auto_link_ldap_user'] = false
285# gitlab_rails['omniauth_auto_link_saml_user'] = false
286# gitlab_rails['omniauth_external_providers'] = ['twitter', 'google_oauth2']
287# gitlab_rails['omniauth_providers'] = [
288# {
289# "name" => "google_oauth2",
290# "app_id" => "YOUR APP ID",
291# "app_secret" => "YOUR APP SECRET",
292# "args" => { "access_type" => "offline", "approval_prompt" => "" }
293# }
294# ]
295
296### Backup Settings
297###! Docs: https://docs.gitlab.com/omnibus/settings/backups.html
298
299# gitlab_rails['manage_backup_path'] = true
300# gitlab_rails['backup_path'] = "/var/opt/gitlab/backups"
301
302###! Docs: https://docs.gitlab.com/ce/raketasks/backup_restore.html#backup-archive-permissions
303# gitlab_rails['backup_archive_permissions'] = 0644
304
305# gitlab_rails['backup_pg_schema'] = 'public'
306
307###! The duration in seconds to keep backups before they are allowed to be deleted
308# gitlab_rails['backup_keep_time'] = 604800
309
310# gitlab_rails['backup_upload_connection'] = {
311# 'provider' => 'AWS',
312# 'region' => 'eu-west-1',
313# 'aws_access_key_id' => 'AKIAKIAKI',
314# 'aws_secret_access_key' => 'secret123'
315# }
316# gitlab_rails['backup_upload_remote_directory'] = 'my.s3.bucket'
317# gitlab_rails['backup_multipart_chunk_size'] = 104857600
318
319###! **Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for
320###! backups**
321# gitlab_rails['backup_encryption'] = 'AES256'
322
323###! **Specifies Amazon S3 storage class to use for backups. Valid values
324###! include 'STANDARD', 'STANDARD_IA', and 'REDUCED_REDUNDANCY'**
325# gitlab_rails['backup_storage_class'] = 'STANDARD'
326
327
328### Pseudonymizer Settings
329# gitlab_rails['pseudonymizer_manifest'] = 'config/pseudonymizer.yml'
330# gitlab_rails['pseudonymizer_upload_remote_directory'] = 'gitlab-elt'
331# gitlab_rails['pseudonymizer_upload_connection'] = {
332# 'provider' => 'AWS',
333# 'region' => 'eu-west-1',
334# 'aws_access_key_id' => 'AKIAKIAKI',
335# 'aws_secret_access_key' => 'secret123'
336# }
337
338
339### For setting up different data storing directory
340###! Docs: https://docs.gitlab.com/omnibus/settings/configuration.html#storing-git-data-in-an-alternative-directory
341###! **If you want to use a single non-default directory to store git data use a
342###! path that doesn't contain symlinks.**
343# git_data_dirs({
344# "default" => {
345# "path" => "/mnt/nfs-01/git-data"
346# }
347# })
348
349### Gitaly settings
350# gitlab_rails['gitaly_token'] = 'secret token'
351
352### For storing GitLab application uploads, eg. LFS objects, build artifacts
353###! Docs: https://docs.gitlab.com/ce/development/shared_files.html
354# gitlab_rails['shared_path'] = '/var/opt/gitlab/gitlab-rails/shared'
355
356### Wait for file system to be mounted
357###! Docs: https://docs.gitlab.com/omnibus/settings/configuration.html#only-start-omnibus-gitlab-services-after-a-given-filesystem-is-mounted
358# high_availability['mountpoint'] = ["/var/opt/gitlab/git-data", "/var/opt/gitlab/gitlab-rails/shared"]
359
360### GitLab Shell settings for GitLab
361# gitlab_rails['gitlab_shell_ssh_port'] = 22
362# gitlab_rails['gitlab_shell_git_timeout'] = 800
363
364### Extra customization
365# gitlab_rails['extra_google_analytics_id'] = '_your_tracking_id'
366# gitlab_rails['extra_piwik_url'] = '_your_piwik_url'
367# gitlab_rails['extra_piwik_site_id'] = '_your_piwik_site_id'
368
369##! Docs: https://docs.gitlab.com/omnibus/settings/environment-variables.html
370# gitlab_rails['env'] = {
371# 'BUNDLE_GEMFILE' => "/opt/gitlab/embedded/service/gitlab-rails/Gemfile",
372# 'PATH' => "/opt/gitlab/bin:/opt/gitlab/embedded/bin:/bin:/usr/bin"
373# }
374
375# gitlab_rails['rack_attack_git_basic_auth'] = {
376# 'enabled' => true,
377# 'ip_whitelist' => ["127.0.0.1"],
378# 'maxretry' => 10,
379# 'findtime' => 60,
380# 'bantime' => 3600
381# }
382
383# gitlab_rails['rack_attack_protected_paths'] = [
384# '/users/password',
385# '/users/sign_in',
386# '/api/#{API::API.version}/session.json',
387# '/api/#{API::API.version}/session',
388# '/users',
389# '/users/confirmation',
390# '/unsubscribes/',
391# '/import/github/personal_access_token'
392# ]
393
394###! **We do not recommend changing these directories.**
395# gitlab_rails['dir'] = "/var/opt/gitlab/gitlab-rails"
396# gitlab_rails['log_directory'] = "/var/log/gitlab/gitlab-rails"
397
398### GitLab application settings
399# gitlab_rails['uploads_directory'] = "/var/opt/gitlab/gitlab-rails/uploads"
400# gitlab_rails['rate_limit_requests_per_period'] = 10
401# gitlab_rails['rate_limit_period'] = 60
402
403#### Change the initial default admin password and shared runner registraion tokens.
404####! **Only applicable on initial setup, changing these settings after database
405####! is created and seeded won't yield any change.**
406# gitlab_rails['initial_root_password'] = "password"
407# gitlab_rails['initial_shared_runners_registration_token'] = "token"
408
409#### Enable or disable automatic database migrations
410# gitlab_rails['auto_migrate'] = true
411
412#### This is advanced feature used by large gitlab deployments where loading
413#### whole RAILS env takes a lot of time.
414# gitlab_rails['rake_cache_clear'] = true
415
416### GitLab database settings
417###! Docs: https://docs.gitlab.com/omnibus/settings/database.html
418###! **Only needed if you use an external database.**
419# gitlab_rails['db_adapter'] = "postgresql"
420# gitlab_rails['db_encoding'] = "unicode"
421# gitlab_rails['db_collation'] = nil
422# gitlab_rails['db_database'] = "gitlabhq_production"
423# gitlab_rails['db_pool'] = 10
424# gitlab_rails['db_username'] = "gitlab"
425# gitlab_rails['db_password'] = nil
426# gitlab_rails['db_host'] = nil
427# gitlab_rails['db_port'] = 5432
428# gitlab_rails['db_socket'] = nil
429# gitlab_rails['db_sslmode'] = nil
430# gitlab_rails['db_sslcompression'] = 0
431# gitlab_rails['db_sslrootcert'] = nil
432# gitlab_rails['db_prepared_statements'] = false
433# gitlab_rails['db_statements_limit'] = 1000
434
435
436### GitLab Redis settings
437###! Connect to your own Redis instance
438###! Docs: https://docs.gitlab.com/omnibus/settings/redis.html
439
440#### Redis TCP connection
441# gitlab_rails['redis_host'] = "127.0.0.1"
442# gitlab_rails['redis_port'] = 6379
443# gitlab_rails['redis_password'] = nil
444# gitlab_rails['redis_database'] = 0
445
446#### Redis local UNIX socket (will be disabled if TCP method is used)
447# gitlab_rails['redis_socket'] = "/var/opt/gitlab/redis/redis.socket"
448
449#### Sentinel support
450####! To have Sentinel working, you must enable Redis TCP connection support
451####! above and define a few Sentinel hosts below (to get a reliable setup
452####! at least 3 hosts).
453####! **You don't need to list every sentinel host, but the ones not listed will
454####! not be used in a fail-over situation to query for the new master.**
455# gitlab_rails['redis_sentinels'] = [
456# {'host' => '127.0.0.1', 'port' => 26379},
457# ]
458
459#### Separate instances support
460###! Docs: https://docs.gitlab.com/omnibus/settings/redis.html#running-with-multiple-redis-instances
461# gitlab_rails['redis_cache_instance'] = nil
462# gitlab_rails['redis_cache_sentinels'] = nil
463# gitlab_rails['redis_queues_instance'] = nil
464# gitlab_rails['redis_queues_sentinels'] = nil
465# gitlab_rails['redis_shared_state_instance'] = nil
466# gitlab_rails['redis_shared_sentinels'] = nil
467
468### GitLab email server settings
469###! Docs: https://docs.gitlab.com/omnibus/settings/smtp.html
470###! **Use smtp instead of sendmail/postfix.**
471
472# gitlab_rails['smtp_enable'] = true
473# gitlab_rails['smtp_address'] = "smtp.server"
474# gitlab_rails['smtp_port'] = 465
475# gitlab_rails['smtp_user_name'] = "smtp user"
476# gitlab_rails['smtp_password'] = "smtp password"
477# gitlab_rails['smtp_domain'] = "example.com"
478# gitlab_rails['smtp_authentication'] = "login"
479# gitlab_rails['smtp_enable_starttls_auto'] = true
480# gitlab_rails['smtp_tls'] = false
481
482###! **Can be: 'none', 'peer', 'client_once', 'fail_if_no_peer_cert'**
483###! Docs: http://api.rubyonrails.org/classes/ActionMailer/Base.html
484# gitlab_rails['smtp_openssl_verify_mode'] = 'none'
485
486# gitlab_rails['smtp_ca_path'] = "/etc/ssl/certs"
487# gitlab_rails['smtp_ca_file'] = "/etc/ssl/certs/ca-certificates.crt"
488
489################################################################################
490## Container Registry settings
491##! Docs: https://docs.gitlab.com/ce/administration/container_registry.html
492################################################################################
493
494# registry_external_url 'https://registry.gitlab.example.com'
495
496### Settings used by GitLab application
497# gitlab_rails['registry_enabled'] = true
498# gitlab_rails['registry_host'] = "registry.gitlab.example.com"
499# gitlab_rails['registry_port'] = "5005"
500# gitlab_rails['registry_path'] = "/var/opt/gitlab/gitlab-rails/shared/registry"
501
502###! **Do not change the following 3 settings unless you know what you are
503###! doing**
504# gitlab_rails['registry_api_url'] = "http://localhost:5000"
505# gitlab_rails['registry_key_path'] = "/var/opt/gitlab/gitlab-rails/certificate.key"
506# gitlab_rails['registry_issuer'] = "omnibus-gitlab-issuer"
507
508### Settings used by Registry application
509# registry['enable'] = true
510# registry['username'] = "registry"
511# registry['group'] = "registry"
512# registry['uid'] = nil
513# registry['gid'] = nil
514# registry['dir'] = "/var/opt/gitlab/registry"
515# registry['registry_http_addr'] = "localhost:5000"
516# registry['debug_addr'] = "localhost:5001"
517# registry['log_directory'] = "/var/log/gitlab/registry"
518# registry['env_directory'] = "/opt/gitlab/etc/registry/env"
519# registry['env'] = {}
520# registry['log_level'] = "info"
521# registry['rootcertbundle'] = "/var/opt/gitlab/registry/certificate.crt"
522# registry['health_storagedriver_enabled'] = true
523# registry['storage_delete_enabled'] = true
524
525### Registry backend storage
526###! Docs: https://docs.gitlab.com/ce/administration/container_registry.html#container-registry-storage-driver
527# registry['storage'] = {
528# 's3' => {
529# 'accesskey' => 'AKIAKIAKI',
530# 'secretkey' => 'secret123',
531# 'bucket' => 'gitlab-registry-bucket-AKIAKIAKI'
532# }
533# }
534
535### Registry notifications endpoints
536# registry['notifications'] = [
537# {
538# 'name' => 'test_endpoint',
539# 'url' => 'https://gitlab.example.com/notify2',
540# 'timeout' => '500ms',
541# 'threshold' => 5,
542# 'backoff' => '1s',
543# 'headers' => {
544# "Authorization" => ["AUTHORIZATION_EXAMPLE_TOKEN"]
545# }
546# }
547# ]
548### Default registry notifications
549# registry['default_notifications_timeout'] = "500ms"
550# registry['default_notifications_threshold'] = 5
551# registry['default_notifications_backoff'] = "1s"
552# registry['default_notifications_headers'] = {}
553
554
555
556################################################################################
557## GitLab Workhorse
558##! Docs: https://gitlab.com/gitlab-org/gitlab-workhorse/blob/master/README.md
559################################################################################
560
561# gitlab_workhorse['enable'] = true
562# gitlab_workhorse['ha'] = false
563# gitlab_workhorse['listen_network'] = "unix"
564# gitlab_workhorse['listen_umask'] = 000
565# gitlab_workhorse['listen_addr'] = "/var/opt/gitlab/gitlab-workhorse/socket"
566# gitlab_workhorse['auth_backend'] = "http://localhost:8080"
567
568##! the empty string is the default in gitlab-workhorse option parser
569# gitlab_workhorse['auth_socket'] = "''"
570
571##! put an empty string on the command line
572# gitlab_workhorse['pprof_listen_addr'] = "''"
573
574# gitlab_workhorse['prometheus_listen_addr'] = "localhost:9229"
575
576# gitlab_workhorse['dir'] = "/var/opt/gitlab/gitlab-workhorse"
577# gitlab_workhorse['log_directory'] = "/var/log/gitlab/gitlab-workhorse"
578# gitlab_workhorse['proxy_headers_timeout'] = "1m0s"
579
580##! limit number of concurrent API requests, defaults to 0 which is unlimited
581# gitlab_workhorse['api_limit'] = 0
582
583##! limit number of API requests allowed to be queued, defaults to 0 which
584##! disables queuing
585# gitlab_workhorse['api_queue_limit'] = 0
586
587##! duration after which we timeout requests if they sit too long in the queue
588# gitlab_workhorse['api_queue_duration'] = "30s"
589
590##! Long polling duration for job requesting for runners
591# gitlab_workhorse['api_ci_long_polling_duration'] = "60s"
592
593##! Log format: default is text, can also be json or none.
594# gitlab_workhorse['log_format'] = "json"
595
596# gitlab_workhorse['env'] = {
597# 'PATH' => "/opt/gitlab/bin:/opt/gitlab/embedded/bin:/bin:/usr/bin"
598# }
599
600################################################################################
601## GitLab User Settings
602##! Modify default git user.
603##! Docs: https://docs.gitlab.com/omnibus/settings/configuration.html#changing-the-name-of-the-git-user-group
604################################################################################
605
606# user['username'] = "git"
607# user['group'] = "git"
608# user['uid'] = nil
609# user['gid'] = nil
610
611##! The shell for the git user
612# user['shell'] = "/bin/sh"
613
614##! The home directory for the git user
615# user['home'] = "/var/opt/gitlab"
616
617# user['git_user_name'] = "GitLab"
618# user['git_user_email'] = "gitlab@#{node['fqdn']}"
619
620################################################################################
621## GitLab Unicorn
622##! Tweak unicorn settings.
623##! Docs: https://docs.gitlab.com/omnibus/settings/unicorn.html
624################################################################################
625
626# unicorn['worker_timeout'] = 60
627###! Minimum worker_processes is 2 at this moment
628###! See https://gitlab.com/gitlab-org/gitlab-ce/issues/18771
629# unicorn['worker_processes'] = 2
630
631### Advanced settings
632# unicorn['listen'] = 'localhost'
633# unicorn['port'] = 8080
634# unicorn['socket'] = '/var/opt/gitlab/gitlab-rails/sockets/gitlab.socket'
635# unicorn['pidfile'] = '/opt/gitlab/var/unicorn/unicorn.pid'
636# unicorn['tcp_nopush'] = true
637# unicorn['backlog_socket'] = 1024
638
639###! **Make sure somaxconn is equal or higher then backlog_socket**
640# unicorn['somaxconn'] = 1024
641
642###! **We do not recommend changing this setting**
643# unicorn['log_directory'] = "/var/log/gitlab/unicorn"
644
645### **Only change these settings if you understand well what they mean**
646###! Docs: https://about.gitlab.com/2015/06/05/how-gitlab-uses-unicorn-and-unicorn-worker-killer/
647###! https://github.com/kzk/unicorn-worker-killer
648# unicorn['worker_memory_limit_min'] = "400 * 1 << 20"
649# unicorn['worker_memory_limit_max'] = "650 * 1 << 20"
650
651################################################################################
652## GitLab Sidekiq
653################################################################################
654
655# sidekiq['log_directory'] = "/var/log/gitlab/sidekiq"
656# sidekiq['log_format'] = "default"
657# sidekiq['shutdown_timeout'] = 4
658# sidekiq['concurrency'] = 25
659# sidekiq['metrics_enabled'] = true
660# sidekiq['listen_address'] = "localhost"
661# sidekiq['listen_port'] = 8082
662
663################################################################################
664## gitlab-shell
665################################################################################
666
667# gitlab_shell['audit_usernames'] = false
668# gitlab_shell['log_level'] = 'INFO'
669# gitlab_shell['log_format'] = 'json'
670# gitlab_shell['http_settings'] = { user: 'username', password: 'password', ca_file: '/etc/ssl/cert.pem', ca_path: '/etc/pki/tls/certs', self_signed_cert: false}
671# gitlab_shell['log_directory'] = "/var/log/gitlab/gitlab-shell/"
672# gitlab_shell['custom_hooks_dir'] = "/opt/gitlab/embedded/service/gitlab-shell/hooks"
673
674# gitlab_shell['auth_file'] = "/var/opt/gitlab/.ssh/authorized_keys"
675
676### Git trace log file.
677###! If set, git commands receive GIT_TRACE* environment variables
678###! Docs: https://git-scm.com/book/es/v2/Git-Internals-Environment-Variables#Debugging
679###! An absolute path starting with / – the trace output will be appended to
680###! that file. It needs to exist so we can check permissions and avoid
681###! throwing warnings to the users.
682# gitlab_shell['git_trace_log_file'] = "/var/log/gitlab/gitlab-shell/gitlab-shell-git-trace.log"
683
684##! **We do not recommend changing this directory.**
685# gitlab_shell['dir'] = "/var/opt/gitlab/gitlab-shell"
686
687################################################################
688## GitLab PostgreSQL
689################################################################
690
691###! Changing any of these settings requires a restart of postgresql.
692###! By default, reconfigure reloads postgresql if it is running. If you
693###! change any of these settings, be sure to run `gitlab-ctl restart postgresql`
694###! after reconfigure in order for the changes to take effect.
695# postgresql['enable'] = true
696# postgresql['listen_address'] = nil
697# postgresql['port'] = 5432
698# postgresql['data_dir'] = "/var/opt/gitlab/postgresql/data"
699
700##! **recommend value is 1/4 of total RAM, up to 14GB.**
701# postgresql['shared_buffers'] = "256MB"
702
703### Advanced settings
704# postgresql['ha'] = false
705# postgresql['dir'] = "/var/opt/gitlab/postgresql"
706# postgresql['log_directory'] = "/var/log/gitlab/postgresql"
707# postgresql['username'] = "gitlab-psql"
708##! `SQL_USER_PASSWORD_HASH` can be generated using the command `gitlab-ctl pg-password-md5 gitlab`
709# postgresql['sql_user_password'] = 'SQL_USER_PASSWORD_HASH'
710# postgresql['uid'] = nil
711# postgresql['gid'] = nil
712# postgresql['shell'] = "/bin/sh"
713# postgresql['home'] = "/var/opt/gitlab/postgresql"
714# postgresql['user_path'] = "/opt/gitlab/embedded/bin:/opt/gitlab/bin:$PATH"
715# postgresql['sql_user'] = "gitlab"
716# postgresql['max_connections'] = 200
717# postgresql['md5_auth_cidr_addresses'] = []
718# postgresql['trust_auth_cidr_addresses'] = []
719# postgresql['wal_buffers'] = "-1"
720# postgresql['autovacuum_max_workers'] = "3"
721# postgresql['autovacuum_freeze_max_age'] = "200000000"
722# postgresql['log_statement'] = nil
723# postgresql['track_activity_query_size'] = "1024"
724# postgresql['shared_preload_libraries'] = nil
725# postgresql['dynamic_shared_memory_type'] = nil
726# postgresql['hot_standby'] = "off"
727
728### SSL settings
729# See https://www.postgresql.org/docs/9.6/static/runtime-config-connection.html#GUC-SSL-CERT-FILE for more details
730# postgresql['ssl'] = 'on'
731# postgresql['ssl_ciphers'] = 'HIGH:MEDIUM:+3DES:!aNULL:!SSLv3:!TLSv1'
732# postgresql['ssl_cert_file'] = 'server.crt'
733# postgresql['ssl_key_file'] = 'server.key'
734# postgresql['ssl_ca_file'] = '/opt/gitlab/embedded/ssl/certs/cacert.pem'
735# postgresql['ssl_crl_file'] = nil
736
737### Replication settings
738###! Note, some replication settings do not require a full restart. They are documented below.
739# postgresql['wal_level'] = "hot_standby"
740# postgresql['max_wal_senders'] = 5
741# postgresql['max_replication_slots'] = 0
742# postgresql['max_locks_per_transaction'] = 128
743
744# Backup/Archive settings
745# postgresql['archive_mode'] = "off"
746
747###! Changing any of these settings only requires a reload of postgresql. You do not need to
748###! restart postgresql if you change any of these and run reconfigure.
749# postgresql['work_mem'] = "16MB"
750# postgresql['maintenance_work_mem'] = "16MB"
751# postgresql['checkpoint_segments'] = 10
752# postgresql['checkpoint_timeout'] = "5min"
753# postgresql['checkpoint_completion_target'] = 0.9
754# postgresql['effective_io_concurrency'] = 1
755# postgresql['checkpoint_warning'] = "30s"
756# postgresql['effective_cache_size'] = "1MB"
757# postgresql['shmmax'] = 17179869184 # or 4294967295
758# postgresql['shmall'] = 4194304 # or 1048575
759# postgresql['autovacuum'] = "on"
760# postgresql['log_autovacuum_min_duration'] = "-1"
761# postgresql['autovacuum_naptime'] = "1min"
762# postgresql['autovacuum_vacuum_threshold'] = "50"
763# postgresql['autovacuum_analyze_threshold'] = "50"
764# postgresql['autovacuum_vacuum_scale_factor'] = "0.02"
765# postgresql['autovacuum_analyze_scale_factor'] = "0.01"
766# postgresql['autovacuum_vacuum_cost_delay'] = "20ms"
767# postgresql['autovacuum_vacuum_cost_limit'] = "-1"
768# postgresql['statement_timeout'] = "60000"
769# postgresql['idle_in_transaction_session_timeout'] = "60000"
770# postgresql['log_line_prefix'] = "%a"
771# postgresql['max_worker_processes'] = 8
772# postgresql['max_parallel_workers_per_gather'] = 0
773# postgresql['log_lock_waits'] = 1
774# postgresql['deadlock_timeout'] = '5s'
775# postgresql['track_io_timing'] = 0
776# postgresql['default_statistics_target'] = 1000
777
778### Available in PostgreSQL 9.6 and later
779# postgresql['min_wal_size'] = 80MB
780# postgresql['max_wal_size'] = 1GB
781
782# Backup/Archive settings
783# postgresql['archive_command'] = nil
784# postgresql['archive_timeout'] = "0"
785
786### Replication settings
787# postgresql['sql_replication_user'] = "gitlab_replicator"
788# postgresql['sql_replication_password'] = "md5 hash of postgresql password" # You can generate with `gitlab-ctl pg-password-md5 <dbuser>`
789# postgresql['wal_keep_segments'] = 10
790# postgresql['max_standby_archive_delay'] = "30s"
791# postgresql['max_standby_streaming_delay'] = "30s"
792# postgresql['synchronous_commit'] = on
793# postgresql['synchronous_standby_names'] = ''
794# postgresql['hot_standby_feedback'] = 'off'
795# postgresql['random_page_cost'] = 2.0
796# postgresql['log_temp_files'] = -1
797# postgresql['log_checkpoints'] = 'off'
798# To add custom entries to pg_hba.conf use the following
799# postgresql['custom_pg_hba_entries'] = {
800# APPLICATION: [ # APPLICATION should identify what the settings are used for
801# {
802# type: example,
803# database: example,
804# user: example,
805# cidr: example,
806# method: example,
807# option: example
808# }
809# ]
810# }
811# See https://www.postgresql.org/docs/9.6/static/auth-pg-hba-conf.html for an explanation
812# of the values
813
814
815################################################################################
816## GitLab Redis
817##! **Can be disabled if you are using your own Redis instance.**
818##! Docs: https://docs.gitlab.com/omnibus/settings/redis.html
819################################################################################
820
821# redis['enable'] = true
822# redis['ha'] = false
823# redis['hz'] = 10
824# redis['dir'] = "/var/opt/gitlab/redis"
825# redis['log_directory'] = "/var/log/gitlab/redis"
826# redis['username'] = "gitlab-redis"
827# redis['maxclients'] = "10000"
828# redis['maxmemory'] = "0"
829# redis['maxmemory_policy'] = "noeviction"
830# redis['maxmemory_samples'] = "5"
831# redis['tcp_backlog'] = 511
832# redis['tcp_timeout'] = "60"
833# redis['tcp_keepalive'] = "300"
834# redis['uid'] = nil
835# redis['gid'] = nil
836
837###! **To enable only Redis service in this machine, uncomment
838###! one of the lines below (choose master or slave instance types).**
839###! Docs: https://docs.gitlab.com/omnibus/settings/redis.html
840###! https://docs.gitlab.com/ce/administration/high_availability/redis.html
841# redis_master_role['enable'] = true
842# redis_slave_role['enable'] = true
843
844### Redis TCP support (will disable UNIX socket transport)
845# redis['bind'] = '0.0.0.0' # or specify an IP to bind to a single one
846# redis['port'] = 6379
847# redis['password'] = 'redis-password-goes-here'
848
849### Redis Sentinel support
850###! **You need a master slave Redis replication to be able to do failover**
851###! **Please read the documentation before enabling it to understand the
852###! caveats:**
853###! Docs: https://docs.gitlab.com/ce/administration/high_availability/redis.html
854
855### Replication support
856#### Slave Redis instance
857# redis['master'] = false # by default this is true
858
859#### Slave and Sentinel shared configuration
860####! **Both need to point to the master Redis instance to get replication and
861####! heartbeat monitoring**
862# redis['master_name'] = 'gitlab-redis'
863# redis['master_ip'] = nil
864# redis['master_port'] = 6379
865
866#### Support to run redis slaves in a Docker or NAT environment
867####! Docs: https://redis.io/topics/replication#configuring-replication-in-docker-and-nat
868# redis['announce_ip'] = nil
869# redis['announce_port'] = nil
870
871####! **Master password should have the same value defined in
872####! redis['password'] to enable the instance to transition to/from
873####! master/slave in a failover event.**
874# redis['master_password'] = 'redis-password-goes-here'
875
876####! Increase these values when your slaves can't catch up with master
877# redis['client_output_buffer_limit_normal'] = '0 0 0'
878# redis['client_output_buffer_limit_slave'] = '256mb 64mb 60'
879# redis['client_output_buffer_limit_pubsub'] = '32mb 8mb 60'
880
881#####! Redis snapshotting frequency
882#####! Set to [] to disable
883#####! Set to [''] to clear previously set values
884# redis['save'] = [ '900 1', '300 10', '60 10000' ]
885
886################################################################################
887## GitLab Web server
888##! Docs: https://docs.gitlab.com/omnibus/settings/nginx.html#using-a-non-bundled-web-server
889################################################################################
890
891##! When bundled nginx is disabled we need to add the external webserver user to
892##! the GitLab webserver group.
893# web_server['external_users'] = []
894# web_server['username'] = 'gitlab-www'
895# web_server['group'] = 'gitlab-www'
896# web_server['uid'] = nil
897# web_server['gid'] = nil
898# web_server['shell'] = '/bin/false'
899# web_server['home'] = '/var/opt/gitlab/nginx'
900
901################################################################################
902## GitLab NGINX
903##! Docs: https://docs.gitlab.com/omnibus/settings/nginx.html
904################################################################################
905
906# nginx['enable'] = true
907# nginx['client_max_body_size'] = '250m'
908# nginx['redirect_http_to_https'] = false
909# nginx['redirect_http_to_https_port'] = 80
910
911##! Most root CA's are included by default
912# nginx['ssl_client_certificate'] = "/etc/gitlab/ssl/ca.crt"
913
914##! enable/disable 2-way SSL client authentication
915# nginx['ssl_verify_client'] = "off"
916
917##! if ssl_verify_client on, verification depth in the client certificates chain
918# nginx['ssl_verify_depth'] = "1"
919
920# nginx['ssl_certificate'] = "/etc/gitlab/ssl/#{node['fqdn']}.crt"
921# nginx['ssl_certificate_key'] = "/etc/gitlab/ssl/#{node['fqdn']}.key"
922# nginx['ssl_ciphers'] = "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256"
923# nginx['ssl_prefer_server_ciphers'] = "on"
924
925##! **Recommended by: https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html
926##! https://cipherli.st/**
927# nginx['ssl_protocols'] = "TLSv1.1 TLSv1.2"
928
929##! **Recommended in: https://nginx.org/en/docs/http/ngx_http_ssl_module.html**
930# nginx['ssl_session_cache'] = "builtin:1000 shared:SSL:10m"
931
932##! **Default according to https://nginx.org/en/docs/http/ngx_http_ssl_module.html**
933# nginx['ssl_session_timeout'] = "5m"
934
935# nginx['ssl_dhparam'] = nil # Path to dhparams.pem, eg. /etc/gitlab/ssl/dhparams.pem
936# nginx['listen_addresses'] = ['*', '[::]']
937
938##! **Defaults to forcing web browsers to always communicate using only HTTPS**
939##! Docs: https://docs.gitlab.com/omnibus/settings/nginx.html#setting-http-strict-transport-security
940# nginx['hsts_max_age'] = 31536000
941# nginx['hsts_include_subdomains'] = false
942
943##! **Docs: http://nginx.org/en/docs/http/ngx_http_gzip_module.html**
944# nginx['gzip_enabled'] = true
945
946##! **Override only if you use a reverse proxy**
947##! Docs: https://docs.gitlab.com/omnibus/settings/nginx.html#setting-the-nginx-listen-port
948# nginx['listen_port'] = nil
949
950##! **Override only if your reverse proxy internally communicates over HTTP**
951##! Docs: https://docs.gitlab.com/omnibus/settings/nginx.html#supporting-proxied-ssl
952# nginx['listen_https'] = nil
953
954# nginx['custom_gitlab_server_config'] = "location ^~ /foo-namespace/bar-project/raw/ {\n deny all;\n}\n"
955# nginx['custom_nginx_config'] = "include /etc/nginx/conf.d/example.conf;"
956# nginx['proxy_read_timeout'] = 3600
957# nginx['proxy_connect_timeout'] = 300
958# nginx['proxy_set_headers'] = {
959# "Host" => "$http_host_with_default",
960# "X-Real-IP" => "$remote_addr",
961# "X-Forwarded-For" => "$proxy_add_x_forwarded_for",
962# "X-Forwarded-Proto" => "https",
963# "X-Forwarded-Ssl" => "on",
964# "Upgrade" => "$http_upgrade",
965# "Connection" => "$connection_upgrade"
966# }
967# nginx['proxy_cache_path'] = 'proxy_cache keys_zone=gitlab:10m max_size=1g levels=1:2'
968# nginx['proxy_cache'] = 'gitlab'
969# nginx['http2_enabled'] = true
970# nginx['real_ip_trusted_addresses'] = []
971# nginx['real_ip_header'] = nil
972# nginx['real_ip_recursive'] = nil
973# nginx['custom_error_pages'] = {
974# '404' => {
975# 'title' => 'Example title',
976# 'header' => 'Example header',
977# 'message' => 'Example message'
978# }
979# }
980
981### Advanced settings
982# nginx['dir'] = "/var/opt/gitlab/nginx"
983# nginx['log_directory'] = "/var/log/gitlab/nginx"
984# nginx['worker_processes'] = 4
985# nginx['worker_connections'] = 10240
986# nginx['log_format'] = '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"'
987# nginx['sendfile'] = 'on'
988# nginx['tcp_nopush'] = 'on'
989# nginx['tcp_nodelay'] = 'on'
990# nginx['gzip'] = "on"
991# nginx['gzip_http_version'] = "1.0"
992# nginx['gzip_comp_level'] = "2"
993# nginx['gzip_proxied'] = "any"
994# nginx['gzip_types'] = [ "text/plain", "text/css", "application/x-javascript", "text/xml", "application/xml", "application/xml+rss", "text/javascript", "application/json" ]
995# nginx['keepalive_timeout'] = 65
996# nginx['cache_max_size'] = '5000m'
997# nginx['server_names_hash_bucket_size'] = 64
998
999### Nginx status
1000# nginx['status'] = {
1001# "enable" => true,
1002# "listen_addresses" => ["127.0.0.1"],
1003# "fqdn" => "dev.example.com",
1004# "port" => 9999,
1005# "options" => {
1006# "stub_status" => "on", # Turn on stats
1007# "server_tokens" => "off", # Don't show the version of NGINX
1008# "access_log" => "off", # Disable logs for stats
1009# "allow" => "127.0.0.1", # Only allow access from localhost
1010# "deny" => "all" # Deny access to anyone else
1011# }
1012# }
1013
1014################################################################################
1015## GitLab Logging
1016##! Docs: https://docs.gitlab.com/omnibus/settings/logs.html
1017################################################################################
1018
1019# logging['svlogd_size'] = 200 * 1024 * 1024 # rotate after 200 MB of log data
1020# logging['svlogd_num'] = 30 # keep 30 rotated log files
1021# logging['svlogd_timeout'] = 24 * 60 * 60 # rotate after 24 hours
1022# logging['svlogd_filter'] = "gzip" # compress logs with gzip
1023# logging['svlogd_udp'] = nil # transmit log messages via UDP
1024# logging['svlogd_prefix'] = nil # custom prefix for log messages
1025# logging['logrotate_frequency'] = "daily" # rotate logs daily
1026# logging['logrotate_size'] = nil # do not rotate by size by default
1027# logging['logrotate_rotate'] = 30 # keep 30 rotated logs
1028# logging['logrotate_compress'] = "compress" # see 'man logrotate'
1029# logging['logrotate_method'] = "copytruncate" # see 'man logrotate'
1030# logging['logrotate_postrotate'] = nil # no postrotate command by default
1031# logging['logrotate_dateformat'] = nil # use date extensions for rotated files rather than numbers e.g. a value of "-%Y-%m-%d" would give rotated files like production.log-2016-03-09.gz
1032
1033### UDP log forwarding
1034##! Docs: http://docs.gitlab.com/omnibus/settings/logs.html#udp-log-forwarding
1035
1036##! remote host to ship log messages to via UDP
1037# logging['udp_log_shipping_host'] = nil
1038
1039##! override the hostname used when logs are shipped via UDP,
1040## by default the system hostname will be used.
1041# logging['udp_log_shipping_hostname'] = nil
1042
1043##! remote port to ship log messages to via UDP
1044# logging['udp_log_shipping_port'] = 514
1045
1046################################################################################
1047## Logrotate
1048##! Docs: https://docs.gitlab.com/omnibus/settings/logs.html#logrotate
1049##! You can disable built in logrotate feature.
1050################################################################################
1051# logrotate['enable'] = true
1052
1053################################################################################
1054## Users and groups accounts
1055##! Disable management of users and groups accounts.
1056##! **Set only if creating accounts manually**
1057##! Docs: https://docs.gitlab.com/omnibus/settings/configuration.html#disable-user-and-group-account-management
1058################################################################################
1059
1060# manage_accounts['enable'] = false
1061
1062################################################################################
1063## Storage directories
1064##! Disable managing storage directories
1065##! Docs: https://docs.gitlab.com/omnibus/settings/configuration.html#disable-storage-directories-management
1066################################################################################
1067
1068##! **Set only if the select directories are created manually**
1069# manage_storage_directories['enable'] = false
1070# manage_storage_directories['manage_etc'] = false
1071
1072################################################################################
1073## Runtime directory
1074##! Docs: https://docs.gitlab.com//omnibus/settings/configuration.html#configuring-runtime-directory
1075################################################################################
1076
1077# runtime_dir '/run'
1078
1079################################################################################
1080## Git
1081##! Advanced setting for configuring git system settings for omnibus-gitlab
1082##! internal git
1083################################################################################
1084
1085##! For multiple options under one header use array of comma separated values,
1086##! eg.:
1087##! { "receive" => ["fsckObjects = true"], "alias" => ["st = status", "co = checkout"] }
1088
1089# omnibus_gitconfig['system'] = {
1090# "pack" => ["threads = 1"],
1091# "receive" => ["fsckObjects = true", "advertisePushOptions = true"],
1092# "repack" => ["writeBitmaps = true"],
1093# "transfer" => ["hideRefs=^refs/tmp/", "hideRefs=^refs/keep-around/"],
1094# }
1095
1096################################################################################
1097## GitLab Pages
1098##! Docs: https://docs.gitlab.com/ce/pages/administration.html
1099################################################################################
1100
1101##! Define to enable GitLab Pages
1102# pages_external_url "http://pages.example.com/"
1103# gitlab_pages['enable'] = false
1104
1105##! Configure to expose GitLab Pages on external IP address, serving the HTTP
1106# gitlab_pages['external_http'] = []
1107
1108##! Configure to expose GitLab Pages on external IP address, serving the HTTPS
1109# gitlab_pages['external_https'] = []
1110
1111##! Configure to enable health check endpoint on GitLab Pages
1112# gitlab_pages['status_uri'] = "/@status"
1113
1114##! Configure to use JSON structured logging in GitLab Pages
1115# gitlab_pages['log_format'] = "json"
1116
1117##! Configure verbose logging for GitLab Pages
1118# gitlab_pages['log_verbose'] = false
1119
1120##! Listen for requests forwarded by reverse proxy
1121# gitlab_pages['listen_proxy'] = "localhost:8090"
1122
1123# gitlab_pages['redirect_http'] = true
1124# gitlab_pages['use_http2'] = true
1125# gitlab_pages['dir'] = "/var/opt/gitlab/gitlab-pages"
1126# gitlab_pages['log_directory'] = "/var/log/gitlab/gitlab-pages"
1127
1128# gitlab_pages['artifacts_server'] = true
1129# gitlab_pages['artifacts_server_url'] = nil # Defaults to external_url + '/api/v4'
1130# gitlab_pages['artifacts_server_timeout'] = 10
1131
1132##! Environments that do not support bind-mounting should set this parameter to
1133##! true. This is incompatible with the artifacts server
1134# gitlab_pages['inplace_chroot'] = false
1135
1136##! Prometheus metrics for Pages docs: https://gitlab.com/gitlab-org/gitlab-pages/#enable-prometheus-metrics
1137# gitlab_pages['metrics_address'] = ":9235"
1138
1139##! Configure the pages admin API
1140# gitlab_pages['admin_secret_token'] = 'custom secret'
1141# gitlab_pages['admin_https_listener'] = '0.0.0.0:5678'
1142# gitlab_pages['admin_https_cert'] = '/etc/gitlab/pages-admin.crt'
1143# gitlab_pages['admin_https_key'] = '/etc/gitlab/pages-admin.key'
1144
1145##! Client side configuration for gitlab-pages admin API, in case pages runs on a different host
1146# gitlab_rails['pages_admin_address'] = 'pages.gitlab.example.com:5678'
1147# gitlab_rails['pages_admin_certificate'] = '/etc/gitlab/pages-admin.crt'
1148
1149################################################################################
1150## GitLab Pages NGINX
1151################################################################################
1152
1153# All the settings defined in the "GitLab Nginx" section are also available in this "GitLab Pages NGINX" section
1154# You just have to change the key "nginx['some_settings']" with "pages_nginx['some_settings']"
1155
1156# Below you can find settings that are exclusive to "GitLab Pages NGINX"
1157# pages_nginx['enable'] = false
1158
1159# gitlab_rails['pages_path'] = "/var/opt/gitlab/gitlab-rails/shared/pages"
1160
1161################################################################################
1162## GitLab CI
1163##! Docs: https://docs.gitlab.com/ce/ci/quick_start/README.html
1164################################################################################
1165
1166# gitlab_ci['gitlab_ci_all_broken_builds'] = true
1167# gitlab_ci['gitlab_ci_add_pusher'] = true
1168# gitlab_ci['builds_directory'] = '/var/opt/gitlab/gitlab-ci/builds'
1169
1170################################################################################
1171## GitLab Mattermost
1172##! Docs: https://docs.gitlab.com/omnibus/gitlab-mattermost
1173################################################################################
1174
1175# mattermost_external_url 'http://mattermost.example.com'
1176
1177# mattermost['enable'] = false
1178# mattermost['username'] = 'mattermost'
1179# mattermost['group'] = 'mattermost'
1180# mattermost['uid'] = nil
1181# mattermost['gid'] = nil
1182# mattermost['home'] = '/var/opt/gitlab/mattermost'
1183# mattermost['database_name'] = 'mattermost_production'
1184# mattermost['env'] = {}
1185
1186# mattermost['service_address'] = "127.0.0.1"
1187# mattermost['service_port'] = "8065"
1188# mattermost['service_site_url'] = nil
1189# mattermost['service_allowed_untrusted_internal_connections'] = ""
1190# mattermost['service_enable_api_team_deletion'] = true
1191# mattermost['team_site_name'] = "GitLab Mattermost"
1192# mattermost['sql_driver_name'] = 'mysql'
1193# mattermost['sql_data_source'] = "mmuser:mostest@tcp(dockerhost:3306)/mattermost_test?charset=utf8mb4,utf8"
1194# mattermost['log_file_directory'] = '/var/log/gitlab/mattermost/'
1195# mattermost['gitlab_enable'] = false
1196# mattermost['gitlab_id'] = "12345656"
1197# mattermost['gitlab_secret'] = "123456789"
1198# mattermost['gitlab_scope'] = ""
1199# mattermost['gitlab_auth_endpoint'] = "http://gitlab.example.com/oauth/authorize"
1200# mattermost['gitlab_token_endpoint'] = "http://gitlab.example.com/oauth/token"
1201# mattermost['gitlab_user_api_endpoint'] = "http://gitlab.example.com/api/v4/user"
1202# mattermost['file_directory'] = "/var/opt/gitlab/mattermost/data"
1203# mattermost['plugin_directory'] = "/var/opt/gitlab/mattermost/plugins"
1204# mattermost['plugin_client_directory'] = "/var/opt/gitlab/mattermost/client-plugins"
1205
1206################################################################################
1207## Mattermost NGINX
1208################################################################################
1209
1210# All the settings defined in the "GitLab NGINX" section are also available in this "Mattermost NGINX" section
1211# You just have to change the key "nginx['some_settings']" with "mattermost_nginx['some_settings']"
1212
1213# Below you can find settings that are exclusive to "Mattermost NGINX"
1214# mattermost_nginx['enable'] = false
1215
1216# mattermost_nginx['custom_gitlab_mattermost_server_config'] = "location ^~ /foo-namespace/bar-project/raw/ {\n deny all;\n}\n"
1217# mattermost_nginx['proxy_set_headers'] = {
1218# "Host" => "$http_host",
1219# "X-Real-IP" => "$remote_addr",
1220# "X-Forwarded-For" => "$proxy_add_x_forwarded_for",
1221# "X-Frame-Options" => "SAMEORIGIN",
1222# "X-Forwarded-Proto" => "https",
1223# "X-Forwarded-Ssl" => "on",
1224# "Upgrade" => "$http_upgrade",
1225# "Connection" => "$connection_upgrade"
1226# }
1227
1228
1229################################################################################
1230## Registry NGINX
1231################################################################################
1232
1233# All the settings defined in the "GitLab NGINX" section are also available in this "Registry NGINX" section
1234# You just have to change the key "nginx['some_settings']" with "registry_nginx['some_settings']"
1235
1236# Below you can find settings that are exclusive to "Registry NGINX"
1237# registry_nginx['enable'] = false
1238
1239# registry_nginx['proxy_set_headers'] = {
1240# "Host" => "$http_host",
1241# "X-Real-IP" => "$remote_addr",
1242# "X-Forwarded-For" => "$proxy_add_x_forwarded_for",
1243# "X-Forwarded-Proto" => "https",
1244# "X-Forwarded-Ssl" => "on"
1245# }
1246
1247################################################################################
1248## Prometheus
1249##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/
1250################################################################################
1251
1252# prometheus['enable'] = true
1253# prometheus['monitor_kubernetes'] = true
1254# prometheus['username'] = 'gitlab-prometheus'
1255# prometheus['uid'] = nil
1256# prometheus['gid'] = nil
1257# prometheus['shell'] = '/bin/sh'
1258# prometheus['home'] = '/var/opt/gitlab/prometheus'
1259# prometheus['log_directory'] = '/var/log/gitlab/prometheus'
1260# prometheus['rules_files'] = ['/var/opt/gitlab/prometheus/rules/*.rules']
1261# prometheus['scrape_interval'] = 15
1262# prometheus['scrape_timeout'] = 15
1263# prometheus['chunk_encoding_version'] = 2
1264#
1265### Custom scrape configs
1266#
1267# Prometheus can scrape additional jobs via scrape_configs. The default automatically
1268# includes all of the exporters supported by the omnibus config.
1269#
1270# See: https://prometheus.io/docs/operating/configuration/#<scrape_config>
1271#
1272# Example:
1273#
1274# prometheus['scrape_configs'] = [
1275# {
1276# 'job_name': 'example',
1277# 'static_configs' => [
1278# 'targets' => ['hostname:port'],
1279# ],
1280# },
1281# ]
1282#
1283### Prometheus Memory Management
1284#
1285# Prometheus needs to be configured for how much memory is used.
1286# * This sets the target heap size.
1287# * This value accounts for approximately 2/3 of the memory used by the server.
1288# * The recommended memory is 4kb per unique metrics time-series.
1289# See: https://prometheus.io/docs/operating/storage/#memory-usage
1290#
1291# prometheus['target_heap_size'] = (
1292# # Use 25mb + 2% of total memory for Prometheus memory.
1293# 26_214_400 + (node['memory']['total'].to_i * 1024 * 0.02 )
1294# ).to_i
1295#
1296# prometheus['flags'] = {
1297# 'storage.local.path' => "#{node['gitlab']['prometheus']['home']}/data",
1298# 'storage.local.chunk-encoding-version' => user_config['chunk-encoding-version'],
1299# 'storage.local.target-heap-size' => node['gitlab']['prometheus']['target-heap-size'],
1300# 'config.file' => "#{node['gitlab']['prometheus']['home']}/prometheus.yml"
1301# }
1302
1303##! Advanced settings. Should be changed only if absolutely needed.
1304# prometheus['listen_address'] = 'localhost:9090'
1305
1306################################################################################
1307## Prometheus Alertmanager
1308##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/alertmanager.html
1309################################################################################
1310
1311# alertmanager['enable'] = true
1312# alertmanager['home'] = '/var/opt/gitlab/alertmanager'
1313# alertmanager['log_directory'] = '/var/log/gitlab/alertmanager'
1314# alertmanager['admin_email'] = 'admin@example.com'
1315# alertmanager['flags'] = {
1316# 'web.listen-address' => "#{node['gitlab']['alertmanager']['listen_address']}"
1317# 'storage.path' => "#{node['gitlab']['alertmanager']['home']}/data"
1318# 'config.file' => "#{node['gitlab']['alertmanager']['home']}/alertmanager.yml"
1319# }
1320
1321##! Advanced settings. Should be changed only if absolutely needed.
1322# alertmanager['listen_address'] = 'localhost:9093'
1323
1324################################################################################
1325## Prometheus Node Exporter
1326##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/node_exporter.html
1327################################################################################
1328
1329# node_exporter['enable'] = true
1330# node_exporter['home'] = '/var/opt/gitlab/node-exporter'
1331# node_exporter['log_directory'] = '/var/log/gitlab/node-exporter'
1332# node_exporter['flags'] = {
1333# 'collector.textfile.directory' => "#{node['gitlab']['node-exporter']['home']}/textfile_collector"
1334# }
1335
1336##! Advanced settings. Should be changed only if absolutely needed.
1337# node_exporter['listen_address'] = 'localhost:9100'
1338
1339################################################################################
1340## Prometheus Redis exporter
1341##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/redis_exporter.html
1342################################################################################
1343
1344# redis_exporter['enable'] = true
1345# redis_exporter['log_directory'] = '/var/log/gitlab/redis-exporter'
1346# redis_exporter['flags'] = {
1347# 'redis.addr' => "unix://#{node['gitlab']['gitlab-rails']['redis_socket']}",
1348# }
1349
1350##! Advanced settings. Should be changed only if absolutely needed.
1351# redis_exporter['listen_address'] = 'localhost:9121'
1352
1353################################################################################
1354## Prometheus Postgres exporter
1355##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/postgres_exporter.html
1356################################################################################
1357
1358# postgres_exporter['enable'] = true
1359# postgres_exporter['home'] = '/var/opt/gitlab/postgres-exporter'
1360# postgres_exporter['log_directory'] = '/var/log/gitlab/postgres-exporter'
1361# postgres_exporter['flags'] = {}
1362# postgres_exporter['listen_address'] = 'localhost:9187'
1363
1364################################################################################
1365## Prometheus PgBouncer exporter (EE only)
1366##! Docs: https://docs.gitlab.com/ee/administration/monitoring/prometheus/pgbouncer_exporter.html
1367################################################################################
1368
1369# pgbouncer-exporter['enable'] = false
1370# pgbouncer-exporter['log_directory'] = "/var/log/gitlab/pgbouncer-exporter"
1371# pgbouncer-exporter['listen_address'] = 'localhost:9188'
1372
1373################################################################################
1374## Prometheus Gitlab monitor
1375##! Docs: https://docs.gitlab.com/ce/administration/monitoring/prometheus/gitlab_monitor_exporter.html
1376################################################################################
1377
1378
1379# gitlab_monitor['enable'] = true
1380# gitlab_monitor['log_directory'] = "/var/log/gitlab/gitlab-monitor"
1381# gitlab_monitor['home'] = "/var/opt/gitlab/gitlab-monitor"
1382
1383##! Advanced settings. Should be changed only if absolutely needed.
1384# gitlab_monitor['listen_address'] = 'localhost'
1385# gitlab_monitor['listen_port'] = '9168'
1386
1387# To completely disable prometheus, and all of it's exporters, set to false
1388# prometheus_monitoring['enable'] = true
1389
1390################################################################################
1391## Gitaly
1392##! Docs:
1393################################################################################
1394
1395# The gitaly['enable'] option exists for the purpose of cluster
1396# deployments, see https://docs.gitlab.com/ee/administration/gitaly/index.html .
1397# gitaly['enable'] = true
1398# gitaly['dir'] = "/var/opt/gitlab/gitaly"
1399# gitaly['log_directory'] = "/var/log/gitlab/gitaly"
1400# gitaly['bin_path'] = "/opt/gitlab/embedded/bin/gitaly"
1401# gitaly['env_directory'] = "/opt/gitlab/etc/gitaly"
1402# gitaly['env'] = {
1403# 'PATH' => "/opt/gitlab/bin:/opt/gitlab/embedded/bin:/bin:/usr/bin",
1404# 'HOME' => '/var/opt/gitlab'
1405# }
1406# gitaly['socket_path'] = "/var/opt/gitlab/gitaly/gitaly.socket"
1407# gitaly['listen_addr'] = "localhost:8075"
1408# gitaly['prometheus_listen_addr'] = "localhost:9236"
1409# gitaly['logging_level'] = "warn"
1410# gitaly['logging_format'] = "json"
1411# gitaly['logging_sentry_dsn'] = "https://<key>:<secret>@sentry.io/<project>"
1412# gitaly['logging_ruby_sentry_dsn'] = "https://<key>:<secret>@sentry.io/<project>"
1413# gitaly['prometheus_grpc_latency_buckets'] = "[0.001, 0.005, 0.025, 0.1, 0.5, 1.0, 10.0, 30.0, 60.0, 300.0, 1500.0]"
1414# gitaly['auth_token'] = '<secret>'
1415# gitaly['auth_transitioning'] = false # When true, auth is logged to Prometheus but NOT enforced
1416# gitaly['ruby_max_rss'] = 300000000 # RSS threshold in bytes for triggering a gitaly-ruby restart
1417# gitaly['ruby_graceful_restart_timeout'] = '10m' # Grace time for a gitaly-ruby process to finish ongoing requests
1418# gitaly['ruby_restart_delay'] = '5m' # Period of sustained high RSS that needs to be observed before restarting gitaly-ruby
1419# gitaly['ruby_num_workers'] = 3 # Number of gitaly-ruby worker processes. Minimum 2, default 2.
1420# gitaly['storage'] = [
1421# {
1422# 'name' => 'default',
1423# 'path' => '/mnt/nfs-01/git-data/repositories'
1424# },
1425# {
1426# 'name' => 'secondary',
1427# 'path' => '/mnt/nfs-02/git-data/repositories'
1428# }
1429# ]
1430# gitaly['concurrency'] = [
1431# {
1432# 'rpc' => "/gitaly.SmartHTTPService/PostReceivePack",
1433# 'max_per_repo' => 20
1434# }, {
1435# 'rpc' => "/gitaly.SSHService/SSHUploadPack",
1436# 'max_per_repo' => 5
1437# }
1438# ]
1439
1440################################################################################
1441# Storage check
1442################################################################################
1443# storage_check['enable'] = false
1444# storage_check['target'] = 'unix:///var/opt/gitlab/gitlab-rails/sockets/gitlab.socket'
1445# storage_check['log_directory'] = '/var/log/gitlab/storage-check'
1446
1447################################################################################
1448# Let's Encrypt integration
1449################################################################################
1450# letsencrypt['enable'] = true
1451# letsencrypt['contact_emails'] = [] # This should be an array of email addresses to add as contacts
1452# letsencrypt['group'] = 'root'
1453# letsencrypt['key_size'] = 2048
1454# letsencrypt['owner'] = 'root'
1455# letsencrypt['wwwroot'] = '/var/opt/gitlab/nginx/www'
1456# See http://docs.gitlab.com/omnibus/settings/ssl.html#automatic-renewal for more on these sesttings
1457# letsencrypt['auto_renew'] = true
1458# letsencrypt['auto_renew_hour'] = 0
1459# letsencrypt['auto_renew_minute'] = nil # Should be a number or cron expression, if specified.
1460# letsencrypt['auto_renew_day_of_month'] = "*/4"
1461
1462################################################################################
1463################################################################################
1464## Configuration Settings for GitLab EE only ##
1465################################################################################
1466################################################################################
1467
1468
1469################################################################################
1470## Auxiliary cron jobs applicable to GitLab EE only
1471################################################################################
1472#
1473# gitlab_rails['geo_file_download_dispatch_worker_cron'] = "*/10 * * * *"
1474# gitlab_rails['geo_repository_sync_worker_cron'] = "*/5 * * * *"
1475# gitlab_rails['geo_prune_event_log_worker_cron'] = "0 */2 * * *"
1476# gitlab_rails['geo_repository_verification_primary_batch_worker_cron'] = "*/5 * * * *"
1477# gitlab_rails['geo_repository_verification_secondary_scheduler_worker_cron'] = "*/5 * * * *"
1478# gitlab_rails['geo_migrated_local_files_clean_up_worker_cron'] = "15 */6 * * *"
1479# gitlab_rails['ldap_sync_worker_cron'] = "30 1 * * *"
1480# gitlab_rails['ldap_group_sync_worker_cron'] = "0 * * * *"
1481# gitlab_rails['historical_data_worker_cron'] = "0 12 * * *"
1482# gitlab_rails['pseudonymizer_worker_cron'] = "0 23 * * *"
1483
1484################################################################################
1485## Kerberos (EE Only)
1486##! Docs: https://docs.gitlab.com/ee/integration/kerberos.html#http-git-access
1487################################################################################
1488
1489# gitlab_rails['kerberos_enabled'] = true
1490# gitlab_rails['kerberos_keytab'] = /etc/http.keytab
1491# gitlab_rails['kerberos_service_principal_name'] = HTTP/gitlab.example.com@EXAMPLE.COM
1492# gitlab_rails['kerberos_use_dedicated_port'] = true
1493# gitlab_rails['kerberos_port'] = 8443
1494# gitlab_rails['kerberos_https'] = true
1495
1496################################################################################
1497## Package repository (EE Only)
1498##! Docs: https://docs.gitlab.com/ee/administration/maven_packages.md
1499################################################################################
1500
1501# gitlab_rails['packages_enabled'] = true
1502# gitlab_rails['packages_storage_path'] = "/var/opt/gitlab/gitlab-rails/shared/packages"
1503# gitlab_rails['packages_object_store_enabled'] = false
1504# gitlab_rails['packages_object_store_direct_upload'] = false
1505# gitlab_rails['packages_object_store_background_upload'] = true
1506# gitlab_rails['packages_object_store_proxy_download'] = false
1507# gitlab_rails['packages_object_store_remote_directory'] = "packages"
1508# gitlab_rails['packages_object_store_connection'] = {
1509# 'provider' => 'AWS',
1510# 'region' => 'eu-west-1',
1511# 'aws_access_key_id' => 'AWS_ACCESS_KEY_ID',
1512# 'aws_secret_access_key' => 'AWS_SECRET_ACCESS_KEY',
1513# # # The below options configure an S3 compatible host instead of AWS
1514# # 'host' => 's3.amazonaws.com',
1515# # 'aws_signature_version' => 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
1516# # 'endpoint' => 'https://s3.amazonaws.com' # default: nil - Useful for S3 compliant services such as DigitalOcean Spaces
1517# # 'path_style' => false # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
1518# }
1519
1520################################################################################
1521## GitLab Sentinel (EE Only)
1522##! Docs: http://docs.gitlab.com/ce/administration/high_availability/redis.html#high-availability-with-sentinel
1523################################################################################
1524
1525##! **Make sure you configured all redis['master_*'] keys above before
1526##! continuing.**
1527
1528##! To enable Sentinel and disable all other services in this machine,
1529##! uncomment the line below (if you've enabled Redis role, it will keep it).
1530##! Docs: https://docs.gitlab.com/ce/administration/high_availability/redis.html
1531# redis_sentinel_role['enable'] = true
1532
1533# sentinel['enable'] = true
1534
1535##! Bind to all interfaces, uncomment to specify an IP and bind to a single one
1536# sentinel['bind'] = '0.0.0.0'
1537
1538##! Uncomment to change default port
1539# sentinel['port'] = 26379
1540
1541#### Support to run sentinels in a Docker or NAT environment
1542#####! Docs: https://redis.io/topics/sentinel#sentinel-docker-nat-and-possible-issues
1543# In an standard case, Sentinel will run in the same network service as Redis, so the same IP will be announce for Redis and Sentinel
1544# Only define these values if it is needed to announce for Sentinel a differen IP service than Redis
1545# sentinel['announce_ip'] = nil # If not defined, its value will be taken from redis['announce_ip'] or nil if not present
1546# sentinel['announce_port'] = nil # If not defined, its value will be taken from sentinel['port'] or nil if redis['announce_ip'] not present
1547
1548##! Quorum must reflect the amount of voting sentinels it take to start a
1549##! failover.
1550##! **Value must NOT be greater then the amount of sentinels.**
1551##! The quorum can be used to tune Sentinel in two ways:
1552##! 1. If a the quorum is set to a value smaller than the majority of Sentinels
1553##! we deploy, we are basically making Sentinel more sensible to master
1554##! failures, triggering a failover as soon as even just a minority of
1555##! Sentinels is no longer able to talk with the master.
1556##! 2. If a quorum is set to a value greater than the majority of Sentinels, we
1557##! are making Sentinel able to failover only when there are a very large
1558##! number (larger than majority) of well connected Sentinels which agree
1559##! about the master being down.
1560# sentinel['quorum'] = 1
1561
1562### Consider unresponsive server down after x amount of ms.
1563# sentinel['down_after_milliseconds'] = 10000
1564
1565### Specifies the failover timeout in milliseconds.
1566##! It is used in many ways:
1567##!
1568##! - The time needed to re-start a failover after a previous failover was
1569##! already tried against the same master by a given Sentinel, is two
1570##! times the failover timeout.
1571##!
1572##! - The time needed for a slave replicating to a wrong master according
1573##! to a Sentinel current configuration, to be forced to replicate
1574##! with the right master, is exactly the failover timeout (counting since
1575##! the moment a Sentinel detected the misconfiguration).
1576##!
1577##! - The time needed to cancel a failover that is already in progress but
1578##! did not produced any configuration change (SLAVEOF NO ONE yet not
1579##! acknowledged by the promoted slave).
1580##!
1581##! - The maximum time a failover in progress waits for all the slaves to be
1582##! reconfigured as slaves of the new master. However even after this time
1583##! the slaves will be reconfigured by the Sentinels anyway, but not with
1584##! the exact parallel-syncs progression as specified.
1585# sentinel['failover_timeout'] = 60000
1586
1587################################################################################
1588## GitLab Sidekiq Cluster (EE only)
1589################################################################################
1590
1591##! GitLab Enterprise Edition allows one to start an extra set of Sidekiq processes
1592##! besides the default one. These processes can be used to consume a dedicated set
1593##! of queues. This can be used to ensure certain queues always have dedicated
1594##! workers, no matter the amount of jobs that need to be processed.
1595
1596# sidekiq_cluster['enable'] = false
1597# sidekiq_cluster['ha'] = false
1598# sidekiq_cluster['log_directory'] = "/var/log/gitlab/sidekiq-cluster"
1599# sidekiq_cluster['interval'] = 5 # The number of seconds to wait between worker checks
1600# sidekiq_cluster['max_concurrency'] = 50 # The maximum number of threads each Sidekiq process should run
1601
1602##! Each entry in the queue_groups array denotes a group of queues that have to be processed by a
1603##! Sidekiq process. Multiple queues can be processed by the same process by
1604##! separating them with a comma within the group entry
1605
1606# sidekiq_cluster['queue_groups'] = [
1607# "process_commit,post_receive",
1608# "gitlab_shell"
1609# ]
1610#
1611
1612##! If negate is enabled then sidekiq-cluster will process all the queues that
1613##! don't match those in queue_groups.
1614
1615# sidekiq_cluster['negate'] = false
1616
1617################################################################################
1618## Additional Database Settings (EE only)
1619##! Docs: https://docs.gitlab.com/ee/administration/database_load_balancing.html
1620################################################################################
1621# gitlab_rails['db_load_balancing'] = { 'hosts' => ['secondary1.example.com'] }
1622
1623################################################################################
1624## GitLab Geo
1625##! Docs: https://docs.gitlab.com/ee/gitlab-geo
1626################################################################################
1627# geo_primary_role['enable'] = false
1628# geo_secondary_role['enable'] = false
1629
1630################################################################################
1631## GitLab Geo Secondary (EE only)
1632################################################################################
1633# geo_secondary['auto_migrate'] = true
1634# geo_secondary['db_adapter'] = "postgresql"
1635# geo_secondary['db_encoding'] = "unicode"
1636# geo_secondary['db_collation'] = nil
1637# geo_secondary['db_database'] = "gitlabhq_geo_production"
1638# geo_secondary['db_pool'] = 10
1639# geo_secondary['db_username'] = "gitlab_geo"
1640# geo_secondary['db_password'] = nil
1641# geo_secondary['db_host'] = "/var/opt/gitlab/geo-postgresql"
1642# geo_secondary['db_port'] = 5431
1643# geo_secondary['db_socket'] = nil
1644# geo_secondary['db_sslmode'] = nil
1645# geo_secondary['db_sslcompression'] = 0
1646# geo_secondary['db_sslrootcert'] = nil
1647# geo_secondary['db_sslca'] = nil
1648# geo_secondary['db_fdw'] = true
1649
1650################################################################################
1651## GitLab Geo Secondary Tracking Database (EE only)
1652################################################################################
1653
1654# geo_postgresql['enable'] = false
1655# geo_postgresql['ha'] = false
1656# geo_postgresql['dir'] = '/var/opt/gitlab/geo-postgresql'
1657# geo_postgresql['data_dir'] = '/var/opt/gitlab/geo-postgresql/data'
1658# geo_postgresql['pgbouncer_user'] = nil
1659# geo_postgresql['pgbouncer_user_password'] = nil
1660
1661################################################################################
1662# Pgbouncer (EE only)
1663# See [GitLab PgBouncer documentation](http://docs.gitlab.com/omnibus/settings/database.html#enabling-pgbouncer-ee-only)
1664# See the [PgBouncer page](https://pgbouncer.github.io/config.html) for details
1665################################################################################
1666# pgbouncer['enable'] = false
1667# pgbouncer['log_directory'] = '/var/log/gitlab/pgbouncer'
1668# pgbouncer['data_directory'] = '/var/opt/gitlab/pgbouncer'
1669# pgbouncer['listen_addr'] = '0.0.0.0'
1670# pgbouncer['listen_port'] = '6432'
1671# pgbouncer['pool_mode'] = 'transaction'
1672# pgbouncer['server_reset_query'] = 'DISCARD ALL'
1673# pgbouncer['application_name_add_host'] = '1'
1674# pgbouncer['max_client_conn'] = '2048'
1675# pgbouncer['default_pool_size'] = '100'
1676# pgbouncer['min_pool_size'] = '0'
1677# pgbouncer['reserve_pool_size'] = '5'
1678# pgbouncer['reserve_pool_timeout'] = '5.0'
1679# pgbouncer['server_round_robin'] = '0'
1680# pgbouncer['log_connections'] = '0'
1681# pgbouncer['server_idle_timeout'] = '30'
1682# pgbouncer['dns_max_ttl'] = '15.0'
1683# pgbouncer['dns_zone_check_period'] = '0'
1684# pgbouncer['dns_nxdomain_ttl'] = '15.0'
1685# pgbouncer['admin_users'] = %w(gitlab-psql postgres pgbouncer)
1686# pgbouncer['stats_users'] = %w(gitlab-psql postgres pgbouncer)
1687# pgbouncer['ignore_startup_parameters'] = 'extra_float_digits'
1688# pgbouncer['databases'] = {
1689# DATABASE_NAME: {
1690# host: HOSTNAME,
1691# port: PORT
1692# user: USERNAME,
1693# password: PASSWORD
1694###! generate this with `echo -n '$password + $username' | md5sum`
1695# }
1696# ...
1697# }
1698# pgbouncer['logfile'] = nil
1699# pgbouncer['unix_socket_dir'] = nil
1700# pgbouncer['unix_socket_mode'] = '0777'
1701# pgbouncer['unix_socket_group'] = nil
1702# pgbouncer['auth_type'] = 'md5'
1703# pgbouncer['auth_hba_file'] = nil
1704# pgbouncer['auth_query'] = 'SELECT username, password FROM public.pg_shadow_lookup($1)'
1705# pgbouncer['users'] = {
1706# {
1707# name: USERNAME,
1708# password: MD5_PASSWORD_HASH
1709# }
1710# }
1711# postgresql['pgbouncer_user'] = nil
1712# postgresql['pgbouncer_user_password'] = nil
1713# pgbouncer['server_reset_query_always'] = 0
1714# pgbouncer['server_check_query'] = 'select 1'
1715# pgbouncer['server_check_delay'] = 30
1716# pgbouncer['max_db_connections'] = nil
1717# pgbouncer['max_user_connections'] = nil
1718# pgbouncer['syslog'] = 0
1719# pgbouncer['syslog_facility'] = 'daemon'
1720# pgbouncer['syslog_ident'] = 'pgbouncer'
1721# pgbouncer['log_disconnections'] = 1
1722# pgbouncer['log_pooler_errors'] = 1
1723# pgbouncer['stats_period'] = 60
1724# pgbouncer['verbose'] = 0
1725# pgbouncer['server_lifetime'] = 3600
1726# pgbouncer['server_connect_timeout'] = 15
1727# pgbouncer['server_login_retry'] = 15
1728# pgbouncer['query_timeout'] = 0
1729# pgbouncer['query_wait_timeout'] = 120
1730# pgbouncer['client_idle_timeout'] = 0
1731# pgbouncer['client_login_timeout'] = 60
1732# pgbouncer['autodb_idle_timeout'] = 3600
1733# pgbouncer['suspend_timeout'] = 10
1734# pgbouncer['idle_transaction_timeout'] = 0
1735# pgbouncer['pkt_buf'] = 4096
1736# pgbouncer['listen_backlog'] = 128
1737# pgbouncer['sbuf_loopcnt'] = 5
1738# pgbouncer['max_packet_size'] = 2147483647
1739# pgbouncer['tcp_defer_accept'] = 0
1740# pgbouncer['tcp_socket_buffer'] = 0
1741# pgbouncer['tcp_keepalive'] = 1
1742# pgbouncer['tcp_keepcnt'] = 0
1743# pgbouncer['tcp_keepidle'] = 0
1744# pgbouncer['tcp_keepintvl'] = 0
1745# pgbouncer['disable_pqexec'] = 0
1746
1747## Pgbouncer client TLS options
1748# pgbouncer['client_tls_sslmode'] = 'disable'
1749# pgbouncer['client_tls_ca_file'] = nil
1750# pgbouncer['client_tls_key_file'] = nil
1751# pgbouncer['client_tls_cert_file'] = nil
1752# pgbouncer['client_tls_protocols'] = 'all'
1753# pgbouncer['client_tls_dheparams'] = 'auto'
1754# pgbouncer['client_tls_ecdhcurve'] = 'auto'
1755#
1756## Pgbouncer server TLS options
1757# pgbouncer['server_tls_sslmode'] = 'disable'
1758# pgbouncer['server_tls_ca_file'] = nil
1759# pgbouncer['server_tls_key_file'] = nil
1760# pgbouncer['server_tls_cert_file'] = nil
1761# pgbouncer['server_tls_protocols'] = 'all'
1762# pgbouncer['server_tls_ciphers'] = 'fast'
1763
1764################################################################################
1765# Repmgr (EE only)
1766################################################################################
1767# repmgr['enable'] = false
1768# repmgr['cluster'] = 'gitlab_cluster'
1769# repmgr['database'] = 'gitlab_repmgr'
1770# repmgr['host'] = nil
1771# repmgr['node_number'] = nil
1772# repmgr['port'] = 5432
1773# repmgr['trust_auth_cidr_addresses'] = []
1774# repmgr['user'] = 'gitlab_repmgr'
1775# repmgr['sslmode'] = 'prefer'
1776# repmgr['sslcompression'] = 0
1777# repmgr['failover'] = 'automatic'
1778# repmgr['log_directory'] = '/var/log/gitlab/repmgrd'
1779# repmgr['node_name'] = nil
1780# repmgr['pg_bindir'] = '/opt/gitlab/embedded/bin'
1781# repmgr['service_start_command'] = '/opt/gitlab/bin/gitlab-ctl start postgresql'
1782# repmgr['service_stop_command'] = '/opt/gitlab/bin/gitlab-ctl stop postgresql'
1783# repmgr['service_reload_command'] = '/opt/gitlab/bin/gitlab-ctl hup postgresql'
1784# repmgr['service_restart_command'] = '/opt/gitlab/bin/gitlab-ctl restart postgresql'
1785# repmgr['service_promote_command'] = nil
1786# repmgr['promote_command'] = '/opt/gitlab/embedded/bin/repmgr standby promote -f /var/opt/gitlab/postgresql/repmgr.conf'
1787# repmgr['follow_command'] = '/opt/gitlab/embedded/bin/repmgr standby follow -f /var/opt/gitlab/postgresql/repmgr.conf'
1788
1789# repmgr['upstream_node'] = nil
1790# repmgr['use_replication_slots'] = false
1791# repmgr['loglevel'] = 'INFO'
1792# repmgr['logfacility'] = 'STDERR'
1793# repmgr['logfile'] = nil
1794
1795# repmgr['event_notification_command'] = nil
1796# repmgr['event_notifications'] = nil
1797
1798# repmgr['rsync_options'] = nil
1799# repmgr['ssh_options'] = nil
1800# repmgr['priority'] = nil
1801#
1802# HA setting to specify if a node should attempt to be master on initialization
1803# repmgr['master_on_initialization'] = true
1804
1805# repmgr['retry_promote_interval_secs'] = 300
1806# repmgr['witness_repl_nodes_sync_interval_secs'] = 15
1807# repmgr['reconnect_attempts'] = 6
1808# repmgr['reconnect_interval'] = 10
1809# repmgr['monitor_interval_secs'] = 2
1810# repmgr['master_response_timeout'] = 60
1811# repmgr['daemon'] = true
1812# repmgrd['enable'] = true
1813
1814################################################################################
1815# Consul (EEP only)
1816################################################################################
1817# consul['enable'] = false
1818# consul['dir'] = '/var/opt/gitlab/consul'
1819# consul['user'] = 'gitlab-consul'
1820# consul['config_file'] = '/var/opt/gitlab/consul/config.json'
1821# consul['config_dir'] = '/var/opt/gitlab/consul/config.d'
1822# consul['data_dir'] = '/var/opt/gitlab/consul/data'
1823# consul['log_directory'] = '/var/log/gitlab/consul'
1824# consul['node_name'] = nil
1825# consul['script_directory'] = '/var/opt/gitlab/consul/scripts'
1826# consul['configuration'] = {
1827# 'client_addr' => nil,
1828# 'datacenter' => 'gitlab_consul',
1829# 'enable_script_checks' => true,
1830# 'server' => false
1831# }
1832# consul['services'] = []
1833# consul['service_config'] = {
1834# 'postgresql' => {
1835# 'service' => {
1836# 'name' => "postgresql",
1837# 'address' => '',
1838# 'port' => 5432,
1839# 'checks' => [
1840# {
1841# 'script' => "/var/opt/gitlab/consul/scripts/check_postgresql",
1842# 'interval' => "10s"
1843# }
1844# ]
1845# }
1846# }
1847# }
1848# consul['watchers'] = {
1849# 'postgresql' => {
1850# enable: false,
1851# handler: 'failover_pgbouncer'
1852# }
1853# }