gitlab.yml.example 49.9 KB
Newer Older
1
# # # # # # # # # # # # # # # # # #
2
# GitLab application config file  #
3
# # # # # # # # # # # # # # # # # #
4
#
5 6
###########################  NOTE  #####################################
# This file should not receive new settings. All configuration options #
7
# * are being moved to ApplicationSetting model!                       #
8
# If a setting requires an application restart say so in that screen.  #
9
# If you change this file in a Merge Request, please also create       #
10 11
# a MR on https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests. #
# For more details see https://gitlab.com/gitlab-org/omnibus-gitlab/blob/0928cfb09f43993fd9454b0b14dbd1924b1407bc/doc/settings/gitlab.yml.md #
12 13
########################################################################
#
14
#
15
# How to use:
16 17
# 1. Copy file as gitlab.yml
# 2. Update gitlab -> host with your fully qualified domain name
18
# 3. Update gitlab -> email_from
19
# 4. If you installed Git from source, change git -> bin_path to /usr/local/bin/git
20 21 22
#    IMPORTANT: If Git was installed in a different location use that instead.
#    You can check with `which git`. If a wrong path of Git is specified, it will
#     result in various issues such as failures of GitLab CI builds.
23
# 5. Review this configuration file for other settings you may want to adjust
24

25 26 27 28 29 30 31
production: &base
  #
  # 1. GitLab app settings
  # ==========================

  ## GitLab settings
  gitlab:
32
    ## Web server settings (note: host is the FQDN, do not include http://)
33
    host: localhost
34 35
    port: 80 # Set to 443 if using HTTPS, see installation.md#using-https for additional HTTPS configuration details
    https: false # Set to true if using HTTPS, see installation.md#using-https for additional HTTPS configuration details
36

37
    # Uncomment this line below if your ssh host is different from HTTP/HTTPS one
38 39 40 41
    # (you'd obviously need to replace ssh.host_example.com with your own host).
    # Otherwise, ssh host will be set to the `host:` value above
    # ssh_host: ssh.host_example.com

42
    # Relative URL support
43 44
    # WARNING: We recommend using an FQDN to host GitLab in a root path instead
    # of using a relative URL.
45 46 47
    # Documentation: http://doc.gitlab.com/ce/install/relative_url.html
    # Uncomment and customize the following line to run in a non-root path
    #
48 49
    # relative_url_root: /gitlab

50 51 52
    # Content Security Policy
    # See https://guides.rubyonrails.org/security.html#content-security-policy
    content_security_policy:
53
      enabled: true
54 55 56 57
      report_only: false
      directives:
        base_uri:
        child_src:
58
        connect_src: "'self' http://localhost:* ws://localhost:* wss://localhost:*"
59 60 61 62 63
        default_src: "'self'"
        font_src:
        form_action:
        frame_ancestors: "'self'"
        frame_src: "'self' https://www.google.com/recaptcha/ https://www.recaptcha.net/ https://content.googleapis.com https://content-compute.googleapis.com https://content-cloudbilling.googleapis.com https://content-cloudresourcemanager.googleapis.com"
64
        img_src: "* data: blob:"
65 66
        manifest_src:
        media_src:
67 68
        object_src: "'none'"
        script_src: "'self' 'unsafe-eval' http://localhost:* https://www.google.com/recaptcha/ https://www.recaptcha.net/ https://www.gstatic.com/recaptcha/ https://apis.google.com"
69
        style_src: "'self' 'unsafe-inline'"
70
        worker_src: "'self' blob:"
71 72
        report_uri:

73 74 75 76 77 78 79 80 81
    # Trusted Proxies
    # Customize if you have GitLab behind a reverse proxy which is running on a different machine.
    # Add the IP address for your reverse proxy to the list, otherwise users will appear signed in from that address.
    trusted_proxies:
      # Examples:
      #- 192.168.1.0/24
      #- 192.168.2.1
      #- 2001:0db8::/32

82 83 84
    # Uncomment and customize if you can't use the default user to run GitLab (default: 'git')
    # user: git

85 86
    ## Date & Time settings
    # Uncomment and customize if you want to change the default time zone of GitLab application.
87
    # To see all available zones, run `bundle exec rake time:zones:all RAILS_ENV=production`
88 89
    # time_zone: 'UTC'

90 91 92 93 94 95 96
    ## Email settings
    # Uncomment and set to false if you need to disable email sending from GitLab (default: true)
    # email_enabled: true
    # Email address used in the "From" field in mails sent by GitLab
    email_from: example@example.com
    email_display_name: GitLab
    email_reply_to: noreply@example.com
97
    email_subject_suffix: ''
98 99 100 101 102 103 104 105 106
    email_smime:
      # Uncomment and set to true if you need to enable email S/MIME signing (default: false)
      # enabled: false
      # S/MIME private key file in PEM format, unencrypted
      # Default is '.gitlab_smime_key' relative to Rails.root (i.e. root of the GitLab app).
      # key_file: /home/git/gitlab/.gitlab_smime_key
      # S/MIME public certificate key in PEM format, will be attached to signed messages
      # Default is '.gitlab_smime_cert' relative to Rails.root (i.e. root of the GitLab app).
      # cert_file: /home/git/gitlab/.gitlab_smime_cert
107 108 109

    # Email server smtp settings are in config/initializers/smtp_settings.rb.sample

110
    # default_can_create_group: false  # default: true
111
    # username_changing_enabled: false # default: true - User can change her username/namespace
112
    ## Default theme ID
113
    ##   1 - Indigo
114 115 116
    ##   2 - Dark
    ##   3 - Light
    ##   4 - Blue
117
    ##   5 - Green
118 119 120 121 122
    ##   6 - Light Indigo
    ##   7 - Light Blue
    ##   8 - Light Green
    ##   9 - Red
    ##   10 - Light Red
123
    # default_theme: 1 # default: 1
Izaak Alpert's avatar
Izaak Alpert committed
124

125
    ## Automatic issue closing
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
126
    # If a commit message matches this regular expression, all issues referenced from the matched text will be closed.
Julien Kirch's avatar
Julien Kirch committed
127
    # This happens when the commit is pushed or merged into the default branch of a project.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
128
    # When not specified the default issue_closing_pattern as specified below will be used.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
129
    # Tip: you can test your closing pattern at http://rubular.com.
130
    # 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+))+)'
131

132 133 134 135 136
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
137
      snippets: true
138
      builds: true
139
      container_registry: true
140

141 142 143 144
    ## Webhook settings
    # Number of seconds to wait for HTTP response after sending webhook HTTP POST request (default: 10)
    # webhook_timeout: 10

145 146
    ## Repository downloads directory
    # When a user clicks e.g. 'Download zip' on a project, a temporary zip file is created in the following directory.
147 148
    # The default is 'shared/cache/archive/' relative to the root of the Rails app.
    # repository_downloads_path: shared/cache/archive/
149

150 151 152
    ## Impersonation settings
    impersonation_enabled: true

Douwe Maan's avatar
Douwe Maan committed
153
  ## Reply by email
Douwe Maan's avatar
Douwe Maan committed
154
  # Allow users to comment on issues and merge requests by replying to notification emails.
155
  # For documentation on how to set this up, see http://doc.gitlab.com/ce/administration/reply_by_email.html
156
  incoming_email:
Douwe Maan's avatar
Douwe Maan committed
157
    enabled: false
158 159

    # The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
160
    # The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    address: "gitlab-incoming+%{key}@gmail.com"

    # Email account username
    # With third party providers, this is usually the full email address.
    # With self-hosted email servers, this is usually the user part of the email address.
    user: "gitlab-incoming@gmail.com"
    # Email account password
    password: "[REDACTED]"

    # IMAP server host
    host: "imap.gmail.com"
    # IMAP server port
    port: 993
    # Whether the IMAP server uses SSL
    ssl: true
    # Whether the IMAP server uses StartTLS
    start_tls: false

    # The mailbox where incoming mail will end up. Usually "inbox".
    mailbox: "inbox"
181
    # The IDLE command timeout.
182
    idle_timeout: 60
Douwe Maan's avatar
Douwe Maan committed
183

Kamil Trzcinski's avatar
Kamil Trzcinski committed
184 185 186 187 188
  ## Build Artifacts
  artifacts:
    enabled: true
    # The location where build artifacts are stored (default: shared/artifacts).
    # path: shared/artifacts
189 190
    # object_store:
    #   enabled: false
191 192
    #   remote_directory: artifacts # The bucket name
    #   background_upload: false # Temporary option to limit automatic upload (Default: true)
193
    #   proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
194 195 196 197
    #   connection:
    #     provider: AWS # Only AWS supported at the moment
    #     aws_access_key_id: AWS_ACCESS_KEY_ID
    #     aws_secret_access_key: AWS_SECRET_ACCESS_KEY
198
    #     region: us-east-1
199
    #     aws_signature_version: 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
200
    #     endpoint: 'https://s3.amazonaws.com' # default: nil - Useful for S3 compliant services such as DigitalOcean Spaces
201

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  ## Merge request external diff storage
  external_diffs:
    # If disabled (the default), the diffs are in-database. Otherwise, they can
    # be stored on disk, or in object storage
    enabled: false
    # The location where external diffs are stored (default: shared/lfs-external-diffs).
    # storage_path: shared/external-diffs
    # object_store:
    #   enabled: false
    #   remote_directory: external-diffs
    #   background_upload: false
    #   proxy_download: false
    #   connection:
    #     provider: AWS
    #     aws_access_key_id: AWS_ACCESS_KEY_ID
    #     aws_secret_access_key: AWS_SECRET_ACCESS_KEY
    #     region: us-east-1
Kamil Trzcinski's avatar
Kamil Trzcinski committed
219

Marin Jankovski's avatar
Marin Jankovski committed
220 221
  ## Git LFS
  lfs:
Marin Jankovski's avatar
Marin Jankovski committed
222
    enabled: true
Marin Jankovski's avatar
Marin Jankovski committed
223 224
    # The location where LFS objects are stored (default: shared/lfs-objects).
    # storage_path: shared/lfs-objects
225 226 227
    object_store:
      enabled: false
      remote_directory: lfs-objects # Bucket name
228
      # direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
229
      # background_upload: false # Temporary option to limit automatic upload (Default: true)
230
      # proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
231 232 233 234
      connection:
        provider: AWS
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
235
        region: us-east-1
236 237 238
        # Use the following options to configure an AWS compatible host
        # host: 'localhost' # default: s3.amazonaws.com
        # endpoint: 'http://127.0.0.1:9000' # default: nil
239
        # aws_signature_version: 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
240
        # path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
Marin Jankovski's avatar
Marin Jankovski committed
241

242 243 244 245 246 247
  ## Uploads (attachments, avatars, etc...)
  uploads:
    # The location where uploads objects are stored (default: public/).
    # storage_path: public/
    # base_dir: uploads/-/system
    object_store:
248
      enabled: false
249
      remote_directory: uploads # Bucket name
250 251 252
      # direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
      # background_upload: false # Temporary option to limit automatic upload (Default: true)
      # proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
253 254 255 256
      connection:
        provider: AWS
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
257
        aws_signature_version: 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
258 259 260 261
        region: us-east-1
        # host: 'localhost' # default: s3.amazonaws.com
        # endpoint: 'http://127.0.0.1:9000' # default: nil
        # path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
262

263
  ## Packages (maven repository, npm registry, etc...)
264
  packages:
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
    enabled: true
    # The location where build packages are stored (default: shared/packages).
    # storage_path: shared/packages
    object_store:
      enabled: false
      remote_directory: packages # The bucket name
      # direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
      # background_upload: false # Temporary option to limit automatic upload (Default: true)
      # proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
      connection:
        provider: AWS
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
        region: us-east-1
        # host: 'localhost' # default: s3.amazonaws.com
        # endpoint: 'http://127.0.0.1:9000' # default: nil
        # aws_signature_version: 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
        # path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'

  ## Dependency Proxy
  dependency_proxy:
    enabled: true
    # The location where build packages are stored (default: shared/dependency_proxy).
    # storage_path: shared/dependency_proxy
    object_store:
      enabled: false
      remote_directory: dependency_proxy # The bucket name
      # direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
      # background_upload: false # Temporary option to limit automatic upload (Default: true)
      # proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
      connection:
        provider: AWS
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
        region: us-east-1
        # host: 'localhost' # default: s3.amazonaws.com
        # endpoint: 'http://127.0.0.1:9000' # default: nil
        # aws_signature_version: 4 # For creation of signed URLs. Set to 2 if provider does not support v4.
        # path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
304

Kamil Trzcinski's avatar
Kamil Trzcinski committed
305 306 307
  ## GitLab Pages
  pages:
    enabled: false
308
    access_control: false
Kamil Trzcinski's avatar
Kamil Trzcinski committed
309 310 311 312 313 314
    # The location where pages are stored (default: shared/pages).
    # path: shared/pages

    # The domain under which the pages are served:
    # http://group.example.com/project
    # or project path can be a group page: group.example.com
315
    host: example.com
316 317
    port: 80 # Set to 443 if you serve the pages with HTTPS
    https: false # Set to true if you serve the pages with HTTPS
318
    artifacts_server: true # Set to false if you want to disable online view of HTML artifacts
319 320
    # external_http: ["1.1.1.1:80", "[2001::1]:80"] # If defined, enables custom domain support in GitLab Pages
    # external_https: ["1.1.1.1:443", "[2001::1]:443"] # If defined, enables custom domain and certificate support in GitLab Pages
321 322
    admin:
      address: unix:/home/git/gitlab/tmp/sockets/private/pages-admin.socket # TCP connections are supported too (e.g. tcp://host:port)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
323

324 325 326 327 328 329
  ## Mattermost
  ## For enabling Add to Mattermost button
  mattermost:
    enabled: false
    host: 'https://mattermost.example.com'

330
  ## Gravatar
331 332 333
  ## If using gravatar.com, there's nothing to change here. For Libravatar
  ## you'll need to provide the custom URLs. For more information,
  ## see: https://docs.gitlab.com/ee/customization/libravatar.html
334
  gravatar:
335 336
    # Gravatar/Libravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username}
    # plain_url: "http://..."     # default: https://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
337
    # ssl_url:   "https://..."    # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
338

339 340 341 342
  ## Sidekiq
  sidekiq:
    log_format: default # (json is also supported)

343
  ## Auxiliary jobs
344
  # Periodically executed jobs, to self-heal GitLab, do external synchronizations, etc.
345 346
  # Please read here for more information: https://github.com/ondrejbartas/sidekiq-cron#adding-cron-job
  cron_jobs:
347 348
    # Flag stuck CI jobs as failed
    stuck_ci_jobs_worker:
349
      cron: "0 * * * *"
Shinya Maeda's avatar
Shinya Maeda committed
350
    # Execute scheduled triggers
351
    pipeline_schedule_worker:
352
      cron: "19 * * * *"
353 354
    # Remove expired build artifacts
    expire_build_artifacts_worker:
355
      cron: "50 * * * *"
Jacob Vosmaer's avatar
Jacob Vosmaer committed
356 357
    # Periodically run 'git fsck' on all repositories. If started more than
    # once per hour you will have concurrent 'git fsck' jobs.
358
    repository_check_worker:
Jacob Vosmaer's avatar
Jacob Vosmaer committed
359
      cron: "20 * * * *"
360 361 362
    # Archive live traces which have not been archived yet
    ci_archive_traces_cron_worker:
      cron: "17 * * * *"
363
    # Send admin emails once a week
Jacob Vosmaer's avatar
Jacob Vosmaer committed
364
    admin_email_worker:
365
      cron: "0 0 * * 0"
366

367 368 369
    # Remove outdated repository archives
    repository_archive_cache_worker:
      cron: "0 * * * *"
370

371 372 373 374
    # Verify custom GitLab Pages domains
    pages_domain_verification_cron_worker:
      cron: "*/15 * * * *"

375 376 377 378
    # Periodically migrate diffs from the database to external storage
    schedule_migrate_external_diffs_worker:
      cron: "15 * * * *"

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  # GitLab EE only jobs. These jobs are automatically enabled for an EE
  # installation, and ignored for a CE installation.
  ee_cron_jobs:
    # Snapshot active users statistics
    historical_data_worker:
      cron: "0 12 * * *"

    # In addition to refreshing users when they log in,
    # periodically refresh LDAP users membership.
    # NOTE: This will only take effect if LDAP is enabled
    ldap_sync_worker:
      cron: "30 1 * * *"

    # Periodically refresh LDAP groups membership.
    # NOTE: This will only take effect if LDAP is enabled
    ldap_group_sync_worker:
      cron: "0 * * * *"

    # GitLab Geo metrics update worker
    # NOTE: This will only take effect if Geo is enabled
    geo_metrics_update_worker:
      cron: "*/1 * * * *"

    # GitLab Geo prune event log worker
    # NOTE: This will only take effect if Geo is enabled (primary node only)
    geo_prune_event_log_worker:
      cron: "*/5 * * * *"

    # GitLab Geo repository sync worker
    # NOTE: This will only take effect if Geo is enabled (secondary nodes only)
    geo_repository_sync_worker:
      cron: "*/1 * * * *"

    # GitLab Geo file download dispatch worker
    # NOTE: This will only take effect if Geo is enabled (secondary nodes only)
    geo_file_download_dispatch_worker:
      cron: "*/1 * * * *"

    # GitLab Geo migrated local files clean up worker
    # NOTE: This will only take effect if Geo is enabled (secondary nodes only)
    geo_migrated_local_files_clean_up_worker:
      cron: "15 */6 * * *"

    # Export pseudonymized data in CSV format for analysis
    pseudonymizer_worker:
      cron: "0 * * * *"

Kamil Trzcinski's avatar
Kamil Trzcinski committed
426 427
  registry:
    # enabled: true
428
    # host: registry.example.com
429 430
    # port: 5005
    # api_url: http://localhost:5000/ # internal address to the registry, will be used by GitLab to directly communicate with API
431
    # key: config/registry.key
432
    # path: shared/registry
433
    # issuer: gitlab-issuer
Kamil Trzcinski's avatar
Kamil Trzcinski committed
434

435 436 437 438 439 440 441 442 443
    # Add notification settings if you plan to use Geo Replication for the registry
    # notifications:
    # - name: geo_event
    #   url: https://example.com/api/v4/container_registry_event/events
    #   timeout: 2s
    #   threshold: 5
    #   backoff: 1s
    #   headers:
    #     Authorization: secret_phrase
444 445 446 447 448

  ## Error Reporting and Logging with Sentry
  sentry:
    # enabled: false
    # dsn: https://<key>@sentry.io/<project>
449
    # clientside_dsn: https://<key>@sentry.io/<project>
450 451
    # environment: 'production' # e.g. development, staging, production

452 453 454 455 456 457 458 459 460 461
  ## Geo
  # NOTE: These settings will only take effect if Geo is enabled
  geo:
    # This is an optional identifier which Geo nodes can use to identify themselves.
    # For example, if external_url is the same for two secondaries, you must specify
    # a unique Geo node name for those secondaries.
    #
    # If it is blank, it defaults to external_url.
    node_name: ''

462 463 464 465 466
    registry_replication:
      # enabled: true
      # primary_api_url: http://localhost:5000/ # internal address to the primary registry, will be used by GitLab to directly communicate with primary registry API


467
  #
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  # 2. GitLab CI settings
  # ==========================

  gitlab_ci:
    # Default project notifications settings:
    #
    # Send emails only on broken builds (default: true)
    # all_broken_builds: true
    #
    # Add pusher to recipients list (default: false)
    # add_pusher: true

    # The location where build traces are stored (default: builds/). Relative paths are relative to Rails.root
    # builds_path: builds/

  #
  # 3. Auth settings
485 486 487
  # ==========================

  ## LDAP settings
488 489
  # You can test connections and inspect a sample of the LDAP users with login
  # access by running:
490
  #   bundle exec rake gitlab:ldap:check RAILS_ENV=production
491 492
  ldap:
    enabled: false
493 494 495 496 497 498 499 500 501 502 503 504 505

    # This setting controls the number of seconds between LDAP permission checks
    # for each user. After this time has expired for a given user, their next
    # interaction with GitLab (a click in the web UI, a git pull, etc.) will be
    # slower because the LDAP permission check is being performed. How much
    # slower depends on your LDAP setup, but it is not uncommon for this check
    # to add seconds of waiting time. The default value is to have a "slow
    # click" once every 3600 seconds (i.e., once per hour).
    #
    # Warning: if you set this value too low, every click in GitLab will be a
    # "slow click" for all of your LDAP users.
    # sync_time: 3600

506
    servers:
507 508 509 510 511 512 513 514 515
      ##########################################################################
      #
      # Since GitLab 7.4, LDAP servers get ID's (below the ID is 'main'). GitLab
      # Enterprise Edition now supports connecting to multiple LDAP servers.
      #
      # If you are updating from the old (pre-7.4) syntax, you MUST give your
      # old server the ID 'main'.
      #
      ##########################################################################
516
      main: # 'main' is the GitLab 'provider ID' of this LDAP server
517 518 519 520 521 522 523 524
        ## label
        #
        # A human-friendly name for your LDAP server. It is OK to change the label later,
        # for instance if you find out it is too large to fit on the web page.
        #
        # Example: 'Paris' or 'Acme, Ltd.'
        label: 'LDAP'

525
        # Example: 'ldap.mydomain.com'
526
        host: '_your_ldap_server'
527 528 529 530 531
        # This port is an example, it is sometimes different but it is always an integer and not a string
        port: 389 # usually 636 for SSL
        uid: 'sAMAccountName' # This should be the attribute, not the value that maps to uid.

        # Examples: 'america\\momo' or 'CN=Gitlab Git,CN=Users,DC=mydomain,DC=com'
532 533
        bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
        password: '_the_password_of_the_bind_user'
534

Michael Kozono's avatar
Michael Kozono committed
535 536 537 538 539 540 541 542 543 544 545
        # Encryption method. The "method" key is deprecated in favor of
        # "encryption".
        #
        #   Examples: "start_tls" or "simple_tls" or "plain"
        #
        #   Deprecated values: "tls" was replaced with "start_tls" and "ssl" was
        #   replaced with "simple_tls".
        #
        encryption: 'plain'

        # Enables SSL certificate verification if encryption method is
546 547
        # "start_tls" or "simple_tls". Defaults to true.
        verify_certificates: true
Michael Kozono's avatar
Michael Kozono committed
548

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
        # OpenSSL::SSL::SSLContext options.
        tls_options:
          # Specifies the path to a file containing a PEM-format CA certificate,
          # e.g. if you need to use an internal CA.
          #
          #   Example: '/etc/ca.pem'
          #
          ca_file: ''

          # Specifies the SSL version for OpenSSL to use, if the OpenSSL default
          # is not appropriate.
          #
          #   Example: 'TLSv1_1'
          #
          ssl_version: ''

          # Specific SSL ciphers to use in communication with LDAP servers.
          #
          # Example: 'ALL:!EXPORT:!LOW:!aNULL:!eNULL:!SSLv2'
          ciphers: ''

          # Client certificate
          #
          # Example:
          #   cert: |
          #     -----BEGIN CERTIFICATE-----
          #     MIIDbDCCAlSgAwIBAgIGAWkJxLmKMA0GCSqGSIb3DQEBCwUAMHcxFDASBgNVBAoTC0dvb2dsZSBJ
          #     bmMuMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQDEwtMREFQIENsaWVudDEPMA0GA1UE
          #     CxMGR1N1aXRlMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTAeFw0xOTAyMjAwNzE4
          #     rntnF4d+0dd7zP3jrWkbdtoqjLDT/5D7NYRmVCD5vizV98FJ5//PIHbD1gL3a9b2MPAc6k7NV8tl
          #     ...
          #     4SbuJPAiJxC1LQ0t39dR6oMCAMab3hXQqhL56LrR6cRBp6Mtlphv7alu9xb/x51y2x+g2zWtsf80
          #     Jrv/vKMsIh/sAyuogb7hqMtp55ecnKxceg==
          #     -----END CERTIFICATE -----
          cert: ''

          # Client private key
          #   key: |
          #     -----BEGIN PRIVATE KEY-----
          #     MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC3DmJtLRmJGY4xU1QtI3yjvxO6
          #     bNuyE4z1NF6Xn7VSbcAaQtavWQ6GZi5uukMo+W5DHVtEkgDwh92ySZMuJdJogFbNvJvHAayheCdN
          #     7mCQ2UUT9jGXIbmksUn9QMeJVXTZjgJWJzPXToeUdinx9G7+lpVa62UATEd1gaI3oyL72WmpDy/C
          #     rntnF4d+0dd7zP3jrWkbdtoqjLDT/5D7NYRmVCD5vizV98FJ5//PIHbD1gL3a9b2MPAc6k7NV8tl
          #     ...
          #     +9IhSYX+XIg7BZOVDeYqlPfxRvQh8vy3qjt/KUihmEPioAjLaGiihs1Fk5ctLk9A2hIUyP+sEQv9
          #     l6RG+a/mW+0rCWn8JAd464Ps9hE=
          #     -----END PRIVATE KEY-----
          key: ''
Michael Kozono's avatar
Michael Kozono committed
597

598 599 600 601 602
        # Set a timeout, in seconds, for LDAP queries. This helps avoid blocking
        # a request if the LDAP server becomes unresponsive.
        # A value of 0 means there is no timeout.
        timeout: 10

603 604 605 606
        # Enable smartcard authentication against the LDAP server. Valid values
        # are "false", "optional", and "required".
        smartcard_auth: false

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
        # This setting specifies if LDAP server is Active Directory LDAP server.
        # For non AD servers it skips the AD specific queries.
        # If your LDAP server is not AD, set this to false.
        active_directory: true

        # If allow_username_or_email_login is enabled, GitLab will ignore everything
        # after the first '@' in the LDAP username submitted by the user on login.
        #
        # Example:
        # - the user enters 'jane.doe@example.com' and 'p@ssw0rd' as LDAP credentials;
        # - GitLab queries the LDAP server with 'jane.doe' and 'p@ssw0rd'.
        #
        # If you are using "uid: 'userPrincipalName'" on ActiveDirectory you need to
        # disable this setting, because the userPrincipalName contains an '@'.
        allow_username_or_email_login: false

623
        # To maintain tight control over the number of active users on your GitLab installation,
624
        # enable this setting to keep new users blocked until they have been cleared by the admin
625
        # (default: false).
626 627
        block_auto_created_users: false

628 629
        # Base where we can search for users
        #
630
        #   Ex. 'ou=People,dc=gitlab,dc=example' or 'DC=mydomain,DC=com'
631 632 633 634 635
        #
        base: ''

        # Filter LDAP users
        #
636
        #   Format: RFC 4515 https://tools.ietf.org/search/rfc4515
637 638 639 640
        #   Ex. (employeeType=developer)
        #
        #   Note: GitLab does not support omniauth-ldap's custom filter syntax.
        #
641 642 643
        #   Example for getting only specific users:
        #   '(&(objectclass=user)(|(samaccountname=momo)(samaccountname=toto)))'
        #
644
        user_filter: ''
645

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
        # Base where we can search for groups
        #
        #   Ex. ou=Groups,dc=gitlab,dc=example
        #
        group_base: ''

        # LDAP group of users who should be admins in GitLab
        #
        #   Ex. GLAdmins
        #
        admin_group: ''

        # LDAP group of users who should be marked as external users in GitLab
        #
        #   Ex. ['Contractors', 'Interns']
        #
        external_groups: []

        # Name of attribute which holds a ssh public key of the user object.
        # If false or nil, SSH key syncronisation will be disabled.
        #
        #   Ex. sshpublickey
        #
        sync_ssh_keys: false

671
        # LDAP attributes that GitLab will use to create an account for the LDAP user.
Douwe Maan's avatar
Douwe Maan committed
672 673
        # The specified attribute can either be the attribute name as a string (e.g. 'mail'),
        # or an array of attribute names to try in order (e.g. ['mail', 'email']).
674 675 676 677 678
        # Note that the user's LDAP login will always be the attribute specified as `uid` above.
        attributes:
          # The username will be used in paths for the user's own projects
          # (like `gitlab.example.com/username/project`) and when mentioning
          # them in issues, merge request and comments (like `@username`).
679
          # If the attribute specified for `username` contains an email address,
680 681 682 683 684
          # the GitLab username will be the part of the email address before the '@'.
          username: ['uid', 'userid', 'sAMAccountName']
          email:    ['mail', 'email', 'userPrincipalName']

          # If no full name could be found at the attribute specified for `name`,
685
          # the full name is determined using the attributes specified for
686 687 688 689 690
          # `first_name` and `last_name`.
          name:       'cn'
          first_name: 'givenName'
          last_name:  'sn'

691 692 693
        # If lowercase_usernames is enabled, GitLab will lower case the username.
        lowercase_usernames: false

694 695 696 697 698 699 700
      # GitLab EE only: add more LDAP servers
      # Choose an ID made of a-z and 0-9 . This ID will be stored in the database
      # so that GitLab can remember which LDAP server a user belongs to.
      # uswest2:
      #   label:
      #   host:
      #   ....
701

702 703 704 705 706 707 708 709 710 711 712
  ## Smartcard authentication settings
  smartcard:
    # Allow smartcard authentication
    enabled: false

    # Path to a file containing a CA certificate
    ca_file: '/etc/ssl/certs/CA.pem'

    # Port where the client side certificate is requested by the webserver (NGINX/Apache)
    # client_certificate_required_port: 3444

713 714 715
    # Browser session with smartcard sign-in is required for Git access
    # required_for_git_access: false

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
  ## Kerberos settings
  kerberos:
    # Allow the HTTP Negotiate authentication method for Git clients
    enabled: false

    # Kerberos 5 keytab file. The keytab file must be readable by the GitLab user,
    # and should be different from other keytabs in the system.
    # (default: use default keytab from Krb5 config)
    # keytab: /etc/http.keytab

    # The Kerberos service name to be used by GitLab.
    # (default: accept any service name in keytab file)
    # service_principal_name: HTTP/gitlab.example.com@EXAMPLE.COM

    # Dedicated port: Git before 2.4 does not fall back to Basic authentication if Negotiate fails.
    # To support both Basic and Negotiate methods with older versions of Git, configure
    # nginx to proxy GitLab on an extra port (e.g. 8443) and uncomment the following lines
    # to dedicate this port to Kerberos authentication. (default: false)
    # use_dedicated_port: true
    # port: 8443
    # https: true
737

738
  ## OmniAuth settings
739
  omniauth:
740
    # Allow login via Twitter, Google, etc. using OmniAuth providers
Nick Thomas's avatar
Nick Thomas committed
741
    # enabled: true
742

743 744 745 746
    # Uncomment this to automatically sign in with a specific omniauth provider's without
    # showing GitLab's sign-in page (default: show the GitLab sign-in page)
    # auto_sign_in_with_provider: saml

747 748 749
    # Sync user's profile from the specified Omniauth providers every time the user logs in (default: empty).
    # Define the allowed providers using an array, e.g. ["cas3", "saml", "twitter"],
    # or as true/false to allow all providers or none.
750
    # When authenticating using LDAP, the user's email is always synced.
751 752 753 754 755 756 757
    # sync_profile_from_provider: []

    # Select which info to sync from the providers above. (default: email).
    # Define the synced profile info using an array. Available options are "name", "email" and "location"
    # e.g. ["name", "email", "location"] or as true to sync all available.
    # This consequently will make the selected attributes read-only.
    # sync_profile_attributes: true
758

759
    # CAUTION!
760 761
    # This allows users to login without having a user account first. Define the allowed providers
    # using an array, e.g. ["saml", "twitter"], or as true/false to allow all providers or none.
762
    # User accounts will be created automatically when authentication was successful.
763 764
    allow_single_sign_on: ["saml"]

765
    # Locks down those users until they have been cleared by the admin (default: true).
766
    block_auto_created_users: true
767 768 769
    # Look up new users in LDAP servers. If a match is found (same uid), automatically
    # link the omniauth identity with the LDAP account. (default: false)
    auto_link_ldap_user: false
770

771 772 773 774 775
    # Allow users with existing accounts to login and auto link their account via SAML
    # login, without having to do a manual login first and manually add SAML
    # (default: false)
    auto_link_saml_user: false

Patricio Cano's avatar
Patricio Cano committed
776 777 778 779 780 781 782
    # Set different Omniauth providers as external so that all users creating accounts
    # via these providers will not be able to have access to internal projects. You
    # will need to use the full name of the provider, like `google_oauth2` for Google.
    # Refer to the examples below for the full names of the supported providers.
    # (default: [])
    external_providers: []

783 784 785 786 787 788 789 790
    # CAUTION!
    # This allows users to login with the specified providers without two factor. Define the allowed providers
    # using an array, e.g. ["twitter", 'google_oauth2'], or as true/false to allow all providers or none.
    # This option should only be configured for providers which already have two factor. 
    # This configration dose not apply to SAML.
    # (default: false)
    allow_bypass_two_factor: ["twitter", 'google_oauth2']

791
    ## Auth providers
792 793
    # Uncomment the following lines and fill in the data of the auth provider you want to use
    # If your favorite auth provider is not listed you can use others:
Drew Blessing's avatar
Drew Blessing committed
794
    # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations
795 796
    # The 'app_id' and 'app_secret' parameters are always passed as the first two
    # arguments, followed by optional 'args' which can be either a hash or an array.
dosire's avatar
dosire committed
797
    # Documentation for this is available at http://doc.gitlab.com/ce/integration/omniauth.html
798
    providers:
tduehr's avatar
tduehr committed
799 800 801 802 803 804 805 806 807
      # See omniauth-cas3 for more configuration details
      # - { name: 'cas3',
      #     label: 'cas3',
      #     args: {
      #             url: 'https://sso.example.com',
      #             disable_ssl_verification: false,
      #             login_url: '/cas/login',
      #             service_validate_url: '/cas/p3/serviceValidate',
      #             logout_url: '/cas/logout'} }
808
      # - { name: 'authentiq',
809
      #     # for client credentials (client ID and secret), go to https://www.authentiq.com/developers
810 811 812 813
      #     app_id: 'YOUR_CLIENT_ID',
      #     app_secret: 'YOUR_CLIENT_SECRET',
      #     args: {
      #             scope: 'aq:name email~rs address aq:push'
814 815
      #             # callback_url parameter is optional except when 'gitlab.host' in this file is set to 'localhost'
      #             # callback_url: 'YOUR_CALLBACK_URL'
816 817
      #           }
      #   }
818 819
      # - { name: 'github',
      #     app_id: 'YOUR_APP_ID',
Douwe Maan's avatar
Douwe Maan committed
820
      #     app_secret: 'YOUR_APP_SECRET',
821 822
      #     url: "https://github.com/",
      #     verify_ssl: true,
823
      #     args: { scope: 'user:email' } }
Douwe Maan's avatar
Douwe Maan committed
824 825 826
      # - { name: 'bitbucket',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET' }
827 828
      # - { name: 'gitlab',
      #     app_id: 'YOUR_APP_ID',
Douwe Maan's avatar
Douwe Maan committed
829
      #     app_secret: 'YOUR_APP_SECRET',
830
      #     args: { scope: 'api' } }
Douwe Maan's avatar
Douwe Maan committed
831 832 833 834 835
      # - { name: 'google_oauth2',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET',
      #     args: { access_type: 'offline', approval_prompt: '' } }
      # - { name: 'facebook',
836
      #     app_id: 'YOUR_APP_ID',
837
      #     app_secret: 'YOUR_APP_SECRET' }
Douwe Maan's avatar
Douwe Maan committed
838 839 840
      # - { name: 'twitter',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET' }
841 842
      # - { name: 'jwt',
      #     args: {
843 844 845 846 847 848 849 850
      #       secret: 'YOUR_APP_SECRET',
      #       algorithm: 'HS256', # Supported algorithms: 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512'
      #       uid_claim: 'email',
      #       required_claims: ['name', 'email'],
      #       info_map: { name: 'name', email: 'email' },
      #       auth_url: 'https://example.com/',
      #       valid_within: 3600 # 1 hour
      #     }
851
      #   }
852
      # - { name: 'saml',
853
      #     label: 'Our SAML Provider',
Patricio Cano's avatar
Patricio Cano committed
854 855
      #     groups_attribute: 'Groups',
      #     external_groups: ['Contractors', 'Freelancers'],
856 857 858 859 860 861 862
      #     args: {
      #             assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback',
      #             idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8',
      #             idp_sso_target_url: 'https://login.example.com/idp',
      #             issuer: 'https://gitlab.example.com',
      #             name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
      #           } }
Patricio Cano's avatar
Patricio Cano committed
863
      #
864 865
      # - { name: 'group_saml' }
      #
Valery Sizov's avatar
Valery Sizov committed
866 867 868 869 870
      # - { name: 'crowd',
      #     args: {
      #       crowd_server_url: 'CROWD SERVER URL',
      #       application_name: 'YOUR_APP_NAME',
      #       application_password: 'YOUR_APP_PASSWORD' } }
871 872 873 874 875 876
      #
      # - { name: 'auth0',
      #     args: {
      #       client_id: 'YOUR_AUTH0_CLIENT_ID',
      #       client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
      #       namespace: 'YOUR_AUTH0_DOMAIN' } }
877

tduehr's avatar
tduehr committed
878 879 880 881
    # SSO maximum session duration in seconds. Defaults to CAS default of 8 hours.
    # cas3:
    #   session_duration: 28800

882 883 884 885
  # Shared file storage settings
  shared:
    # path: /mnt/gitlab # Default: shared

886 887
  # Gitaly settings
  gitaly:
888
    # Path to the directory containing Gitaly client executables.
889
    client_path: /home/git/gitaly/bin
890
    # Default Gitaly authentication token. Can be overridden per storage. Can
Jacob Vosmaer's avatar
Jacob Vosmaer committed
891 892 893
    # be left blank when Gitaly is running locally on a Unix socket, which
    # is the normal way to deploy Gitaly.
    token:
894 895

  #
896
  # 4. Advanced settings
897 898
  # ==========================

899 900 901
  ## Repositories settings
  repositories:
    # Paths where repositories can be stored. Give the canonicalized absolute pathname.
Elan Ruusamäe's avatar
Elan Ruusamäe committed
902 903 904
    # IMPORTANT: None of the path components may be symlink, because
    # gitlab-shell invokes Dir.pwd inside the repository path and that results
    # real path not the symlink.
905
    storages: # You must have at least a `default` storage path.
906 907
      default:
        path: /home/git/repositories/
908
        gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket # TCP connections are supported too (e.g. tcp://host:port). TLS connections are also supported using the system certificate pool (eg: tls://host:port).
909
        # gitaly_token: 'special token' # Optional: override global gitaly.token for this storage.
910

911 912 913
  ## Backup settings
  backup:
    path: "tmp/backups"   # Relative paths are relative to Rails.root (default: tmp/backups/)
914
    # archive_permissions: 0640 # Permissions for the resulting backup.tar file (default: 0600)
915
    # keep_time: 604800   # default: 0 (forever) (in seconds)
916
    # pg_schema: public     # default: nil, it means that all schemas will be backed up
917 918 919 920
    # upload:
    #   # Fog storage connection settings, see http://fog.io/storage/ .
    #   connection:
    #     provider: AWS
921
    #     region: eu-west-1
922 923 924 925
    #     aws_access_key_id: AKIAKIAKI
    #     aws_secret_access_key: 'secret123'
    #   # The remote 'directory' to store your backups. For S3, this would be the bucket name.
    #   remote_directory: 'my.s3.bucket'
926 927 928
    #   # Use multipart uploads when file size reaches 100MB, see
    #   #  http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
    #   multipart_chunk_size: 104857600
929 930
    #   # Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional
    #   # encryption: 'AES256'
931
    #   # Turns on AWS Server-Side Encryption with Amazon Customer-Provided Encryption Keys for backups, this is optional
932 933
    #   #   This should be set to the 256-bit, base64-encoded encryption key for Amazon S3 to use to encrypt or decrypt your data.
    #   #   'encryption' must also be set in order for this to have any effect.
934
    #   # encryption_key: '<base64 key>'
935 936
    #   # Specifies Amazon S3 storage class to use for backups, this is optional
    #   # storage_class: 'STANDARD'
937

938 939 940 941 942 943 944 945 946 947 948 949 950 951
  ## Pseudonymizer exporter
  pseudonymizer:
    # Tables manifest that specifies the fields to extract and pseudonymize.
    manifest: config/pseudonymizer.yml
    upload:
      remote_directory: 'gitlab-elt'
      # Fog storage connection settings, see http://fog.io/storage/ .
      connection:
      #   provider: AWS
      #   region: eu-west-1
      #   aws_access_key_id: AKIAKIAKI
      #   aws_secret_access_key: 'secret123'
      #   # The remote 'directory' to store the CSV files. For S3, this would be the bucket name.

952 953
  ## GitLab Shell settings
  gitlab_shell:
954
    path: /home/git/gitlab-shell/
955
    authorized_keys_file: /home/git/.ssh/authorized_keys
956

957 958 959 960
    # File that contains the secret key for verifying access for gitlab-shell.
    # Default is '.gitlab_shell_secret' relative to Rails.root (i.e. root of the GitLab app).
    # secret_file: /home/git/gitlab/.gitlab_shell_secret

961 962 963 964
    # Git over HTTP
    upload_pack: true
    receive_pack: true

965 966
    # Git import/fetch timeout, in seconds. Defaults to 3 hours.
    # git_timeout: 10800
967

968
    # If you use non-standard ssh port you need to specify it
969 970
    # ssh_port: 22

971 972 973 974 975
  workhorse:
    # File that contains the secret key for verifying access for gitlab-workhorse.
    # Default is '.gitlab_workhorse_secret' relative to Rails.root (i.e. root of the GitLab app).
    # secret_file: /home/git/gitlab/.gitlab_workhorse_secret

976
  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
977
  # CAUTION!
978 979 980 981
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git

982 983 984 985 986 987 988 989 990 991
  ## Webpack settings
  # If enabled, this will tell rails to serve frontend assets from the webpack-dev-server running
  # on a given port instead of serving directly from /assets/webpack. This is only indended for use
  # in development.
  webpack:
    # dev_server:
    #   enabled: true
    #   host: localhost
    #   port: 3808

992 993 994
  ## Monitoring
  # Built in monitoring settings
  monitoring:
995 996
    # Time between sampling of unicorn socket metrics, in seconds
    # unicorn_sampler_interval: 10
Jan Provaznik's avatar
Jan Provaznik committed
997 998
    # Time between sampling of Puma metrics, in seconds
    # puma_sampler_interval: 5
999
    # IP whitelist to access monitoring endpoints
1000 1001
    ip_whitelist:
      - 127.0.0.0/8
1002

1003 1004 1005 1006 1007
    # Sidekiq exporter is webserver built in to Sidekiq to expose Prometheus metrics
    sidekiq_exporter:
    #  enabled: true
    #  address: localhost
    #  port: 3807
1008

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
  ## Prometheus settings
  # Do not modify these settings here. They should be modified in /etc/gitlab/gitlab.rb
  # if you installed GitLab via Omnibus.
  # If you installed from source, you need to install and configure Prometheus
  # yourself, and then update the values here.
  # https://docs.gitlab.com/ee/administration/monitoring/prometheus/
  prometheus:
    # enable: true
    # listen_address: 'localhost:9090'

1019
  #
1020
  # 5. Extra customization
1021 1022
  # ==========================

1023
  extra:
1024 1025 1026
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

Sebastian Winkler's avatar
Sebastian Winkler committed
1027 1028 1029 1030
    ## Piwik analytics.
    # piwik_url: '_your_piwik_url'
    # piwik_site_id: '_your_piwik_site_id'

1031 1032
  rack_attack:
    git_basic_auth:
1033 1034 1035
      # Rack Attack IP banning enabled
      # enabled: true
      #
1036 1037 1038
      # Whitelist requests from 127.0.0.1 for web proxies (NGINX/Apache) with incorrect headers
      # ip_whitelist: ["127.0.0.1"]
      #
1039 1040 1041 1042 1043 1044 1045 1046 1047
      # Limit the number of Git HTTP authentication attempts per IP
      # maxretry: 10
      #
      # Reset the auth attempt counter per IP after 60 seconds
      # findtime: 60
      #
      # Ban an IP for one hour (3600s) after too many auth attempts
      # bantime: 3600

1048
development:
1049
  <<: *base
1050 1051

test:
1052
  <<: *base
1053 1054
  gravatar:
    enabled: true
1055 1056
  external_diffs:
    enabled: false
1057 1058 1059 1060
    # Diffs may be `always` external (the default), or they can be made external
    # after they have become `outdated` (i.e., the MR is closed or a new version
    # has been pushed).
    # when: always
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    # The location where external diffs are stored (default: shared/external-diffs).
    # storage_path: shared/external-diffs
    object_store:
      enabled: false
      remote_directory: external-diffs # The bucket name
      connection:
        provider: AWS # Only AWS supported at the moment
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
        region: us-east-1
Marin Jankovski's avatar
Marin Jankovski committed
1071 1072
  lfs:
    enabled: false
1073 1074 1075 1076 1077 1078 1079 1080 1081
    # The location where LFS objects are stored (default: shared/lfs-objects).
    # storage_path: shared/lfs-objects
    object_store:
      enabled: false
      remote_directory: lfs-objects # The bucket name
      connection:
        provider: AWS # Only AWS supported at the moment
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
1082
        region: us-east-1
1083
  artifacts:
1084
    path: tmp/tests/artifacts
1085 1086 1087 1088 1089 1090
    enabled: true
    # The location where build artifacts are stored (default: shared/artifacts).
    # path: shared/artifacts
    object_store:
      enabled: false
      remote_directory: artifacts # The bucket name
1091
      background_upload: false
1092 1093 1094 1095
      connection:
        provider: AWS # Only AWS supported at the moment
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
1096
        region: us-east-1
1097 1098 1099 1100 1101 1102 1103 1104
  uploads:
    storage_path: tmp/tests/public
    object_store:
      enabled: false
      connection:
        provider: AWS # Only AWS supported at the moment
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
1105
        region: us-east-1
1106 1107
  gitlab:
    host: localhost
1108
    port: 80
1109

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
    content_security_policy:
      enabled: true
      report_only: false
      directives:
        base_uri:
        child_src:
        connect_src:
        default_src: "'self'"
        font_src:
        form_action:
        frame_ancestors: "'self'"
        frame_src: "'self' https://www.google.com/recaptcha/ https://www.recaptcha.net/ https://content.googleapis.com https://content-compute.googleapis.com https://content-cloudbilling.googleapis.com https://content-cloudresourcemanager.googleapis.com"
        img_src: "* data: blob:"
        manifest_src:
        media_src:
        object_src: "'none'"
        script_src: "'self' 'unsafe-eval' http://localhost:* https://www.google.com/recaptcha/ https://www.recaptcha.net/ https://www.gstatic.com/recaptcha/ https://apis.google.com"
        style_src: "'self' 'unsafe-inline'"
        worker_src: "'self' blob:"
        report_uri:

1131 1132
    # When you run tests we clone and set up gitlab-shell
    # In order to set it up correctly you need to specify
1133
    # your system username you use to run GitLab
1134
    # user: YOUR_USERNAME
1135 1136
  pages:
    path: tmp/tests/pages
1137 1138
  repositories:
    storages:
1139 1140
      default:
        path: tmp/tests/repositories/
1141
        gitaly_address: unix:tmp/tests/gitaly/gitaly.socket
1142

1143
  gitaly:
1144
    client_path: tmp/tests/gitaly
1145
    token: secret
1146
  backup:
1147
    path: tmp/tests/backups
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
  pseudonymizer:
    manifest: config/pseudonymizer.yml
    upload:
      # The remote 'directory' to store the CSV files. For S3, this would be the bucket name.
      remote_directory: gitlab-elt.test
      # Fog storage connection settings, see http://fog.io/storage/
      connection:
        provider: AWS # Only AWS supported at the moment
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
        region: us-east-1
1159 1160
  gitlab_shell:
    path: tmp/tests/gitlab-shell/
1161
    authorized_keys_file: tmp/tests/authorized_keys
1162 1163
  issues_tracker:
    redmine:
1164
      title: "Redmine"
1165
      project_url: "http://redmine/projects/:issues_tracker_id"
1166
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
1167
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
1168
    jira:
1169
      title: "Jira"
1170
      url: https://sample_company.atlassian.net
1171
      project_key: PROJECT
1172 1173

  omniauth:
Nick Thomas's avatar
Nick Thomas committed
1174
    # enabled: true
1175 1176 1177 1178 1179 1180
    allow_single_sign_on: true
    external_providers: []

    providers:
      - { name: 'cas3',
          label: 'cas3',
Timothy Andrew's avatar
Timothy Andrew committed
1181
          args: { url: 'https://sso.example.com',
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
                  disable_ssl_verification: false,
                  login_url: '/cas/login',
                  service_validate_url: '/cas/p3/serviceValidate',
                  logout_url: '/cas/logout'} }
      - { name: 'github',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET',
          url: "https://github.com/",
          verify_ssl: false,
          args: { scope: 'user:email' } }
      - { name: 'bitbucket',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET' }
      - { name: 'gitlab',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET',
          args: { scope: 'api' } }
      - { name: 'google_oauth2',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET',
          args: { access_type: 'offline', approval_prompt: '' } }
      - { name: 'facebook',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET' }
      - { name: 'twitter',
          app_id: 'YOUR_APP_ID',
          app_secret: 'YOUR_APP_SECRET' }
1209 1210 1211 1212 1213 1214 1215 1216
      - { name: 'jwt',
          app_secret: 'YOUR_APP_SECRET',
          args: {
                  algorithm: 'HS256',
                  uid_claim: 'email',
                  required_claims: ["name", "email"],
                  info_map: { name: "name", email: "email" },
                  auth_url: 'https://example.com/',
1217
                  valid_within: null,
1218 1219
                }
        }
1220 1221 1222 1223 1224
      - { name: 'auth0',
          args: {
            client_id: 'YOUR_AUTH0_CLIENT_ID',
            client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
            namespace: 'YOUR_AUTH0_DOMAIN' } }
1225 1226 1227 1228
      - { name: 'authentiq',
          app_id: 'YOUR_CLIENT_ID',
          app_secret: 'YOUR_CLIENT_SECRET',
          args: { scope: 'aq:name email~rs address aq:push' } }
1229 1230 1231 1232
      - { name: 'salesforce',
          app_id: 'YOUR_CLIENT_ID',
          app_secret: 'YOUR_CLIENT_SECRET'
        }
1233 1234 1235
  ldap:
    enabled: false
    servers:
1236
      main:
1237 1238 1239 1240
        label: ldap
        host: 127.0.0.1
        port: 3890
        uid: 'uid'
Michael Kozono's avatar
Michael Kozono committed
1241
        encryption: 'plain' # "start_tls" or "simple_tls" or "plain"
1242 1243 1244 1245
        base: 'dc=example,dc=com'
        user_filter: ''
        group_base: 'ou=groups,dc=example,dc=com'
        admin_group: ''
1246 1247 1248
  prometheus:
    enable: true
    listen_address: 'localhost:9090'
1249 1250

staging:
1251
  <<: *base