gitlab.yml.example 32.7 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 10
# If you change this file in a Merge Request, please also create       #
# a MR on https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests  #
11 12
########################################################################
#
13
#
14
# How to use:
15 16
# 1. Copy file as gitlab.yml
# 2. Update gitlab -> host with your fully qualified domain name
17
# 3. Update gitlab -> email_from
18
# 4. If you installed Git from source, change git -> bin_path to /usr/local/bin/git
19 20 21
#    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.
22
# 5. Review this configuration file for other settings you may want to adjust
23

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

  ## GitLab settings
  gitlab:
31
    ## Web server settings (note: host is the FQDN, do not include http://)
32
    host: localhost
33 34
    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
35

36 37 38 39 40
    # Uncommment this line below if your ssh host is different from HTTP/HTTPS one
    # (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

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

49 50 51 52 53 54 55 56 57
    # 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

58 59 60
    # Uncomment and customize if you can't use the default user to run GitLab (default: 'git')
    # user: git

61 62
    ## Date & Time settings
    # Uncomment and customize if you want to change the default time zone of GitLab application.
63
    # To see all available zones, run `bundle exec rake time:zones:all RAILS_ENV=production`
64 65
    # time_zone: 'UTC'

66 67 68 69 70 71 72
    ## 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
73
    email_subject_suffix: ''
74 75 76

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

77
    # default_can_create_group: false  # default: true
78
    # username_changing_enabled: false # default: true - User can change her username/namespace
79
    ## Default theme ID
80 81
    ##   1 - Indigo
    ##   2 - Dark
82 83 84
    ##   3 - Light
    ##   4 - Blue
    ##   5 - Green
85
    # default_theme: 1 # default: 1
Izaak Alpert's avatar
Izaak Alpert committed
86

87
    ## Automatic issue closing
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
88
    # 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
89
    # This happens when the commit is pushed or merged into the default branch of a project.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
90
    # When not specified the default issue_closing_pattern as specified below will be used.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
91
    # Tip: you can test your closing pattern at http://rubular.com.
92
    # issue_closing_pattern: '((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?|[Rr]esolv(?:e[sd]?|ing)|[Ii]mplement(?:s|ed|ing)?)(:?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?)|([A-Z][A-Z0-9_]+-\d+))+)'
93

94 95 96 97 98
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
99
      snippets: true
100
      builds: true
101
      container_registry: true
102

103 104 105 106
    ## Webhook settings
    # Number of seconds to wait for HTTP response after sending webhook HTTP POST request (default: 10)
    # webhook_timeout: 10

107 108
    ## Repository downloads directory
    # When a user clicks e.g. 'Download zip' on a project, a temporary zip file is created in the following directory.
109 110
    # The default is 'shared/cache/archive/' relative to the root of the Rails app.
    # repository_downloads_path: shared/cache/archive/
111

Douwe Maan's avatar
Douwe Maan committed
112
  ## Reply by email
Douwe Maan's avatar
Douwe Maan committed
113
  # Allow users to comment on issues and merge requests by replying to notification emails.
114
  # For documentation on how to set this up, see http://doc.gitlab.com/ce/administration/reply_by_email.html
115
  incoming_email:
Douwe Maan's avatar
Douwe Maan committed
116
    enabled: false
117 118

    # The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
119
    # The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    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"
140
    # The IDLE command timeout.
141
    idle_timeout: 60
Douwe Maan's avatar
Douwe Maan committed
142

Kamil Trzcinski's avatar
Kamil Trzcinski committed
143 144 145 146 147
  ## Build Artifacts
  artifacts:
    enabled: true
    # The location where build artifacts are stored (default: shared/artifacts).
    # path: shared/artifacts
148 149
    # object_store:
    #   enabled: false
150 151
    #   remote_directory: artifacts # The bucket name
    #   background_upload: false # Temporary option to limit automatic upload (Default: true)
152
    #   proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
153 154 155 156 157
    #   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: eu-central-1
Kamil Trzcinski's avatar
Kamil Trzcinski committed
158

Marin Jankovski's avatar
Marin Jankovski committed
159 160
  ## Git LFS
  lfs:
Marin Jankovski's avatar
Marin Jankovski committed
161
    enabled: true
Marin Jankovski's avatar
Marin Jankovski committed
162 163
    # The location where LFS objects are stored (default: shared/lfs-objects).
    # storage_path: shared/lfs-objects
164 165 166 167
    object_store:
      enabled: false
      remote_directory: lfs-objects # Bucket name
      # background_upload: false # Temporary option to limit automatic upload (Default: true)
168
      # proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
169 170 171 172 173 174 175 176 177
      connection:
        provider: AWS
        aws_access_key_id: AWS_ACCESS_KEY_ID
        aws_secret_access_key: AWS_SECRET_ACCESS_KEY
        region: eu-central-1
        # 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
        # path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
Marin Jankovski's avatar
Marin Jankovski committed
178

179 180 181 182 183 184
  ## Uploads (attachments, avatars, etc...)
  uploads:
    # The location where uploads objects are stored (default: public/).
    # storage_path: public/
    # base_dir: uploads/-/system
    object_store:
185 186 187 188 189 190 191 192 193 194 195 196
      enabled: false
    # remote_directory: uploads # Bucket name
    # 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: eu-central-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'
197

Kamil Trzcinski's avatar
Kamil Trzcinski committed
198 199 200 201 202 203 204 205 206
  ## GitLab Pages
  pages:
    enabled: false
    # 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
207
    host: example.com
208 209
    port: 80 # Set to 443 if you serve the pages with HTTPS
    https: false # Set to true if you serve the pages with HTTPS
210
    artifacts_server: true
211 212
    # 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
Kamil Trzcinski's avatar
Kamil Trzcinski committed
213

214 215 216 217 218 219
  ## Mattermost
  ## For enabling Add to Mattermost button
  mattermost:
    enabled: false
    host: 'https://mattermost.example.com'

220
  ## Gravatar
221 222 223
  ## 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
224
  gravatar:
225 226
    # Gravatar/Libravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username}
    # plain_url: "http://..."     # default: https://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
227
    # ssl_url:   "https://..."    # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
228

229 230 231 232
  ## Sidekiq
  sidekiq:
    log_format: default # (json is also supported)

233
  ## Auxiliary jobs
234
  # Periodically executed jobs, to self-heal GitLab, do external synchronizations, etc.
235 236
  # Please read here for more information: https://github.com/ondrejbartas/sidekiq-cron#adding-cron-job
  cron_jobs:
237 238
    # Flag stuck CI jobs as failed
    stuck_ci_jobs_worker:
239
      cron: "0 * * * *"
Shinya Maeda's avatar
Shinya Maeda committed
240
    # Execute scheduled triggers
241
    pipeline_schedule_worker:
242
      cron: "19 * * * *"
243 244
    # Remove expired build artifacts
    expire_build_artifacts_worker:
245
      cron: "50 * * * *"
Jacob Vosmaer's avatar
Jacob Vosmaer committed
246 247
    # Periodically run 'git fsck' on all repositories. If started more than
    # once per hour you will have concurrent 'git fsck' jobs.
248
    repository_check_worker:
Jacob Vosmaer's avatar
Jacob Vosmaer committed
249
      cron: "20 * * * *"
250
    # Send admin emails once a week
Jacob Vosmaer's avatar
Jacob Vosmaer committed
251
    admin_email_worker:
252
      cron: "0 0 * * 0"
253

254 255 256
    # Remove outdated repository archives
    repository_archive_cache_worker:
      cron: "0 * * * *"
257

258 259 260 261
    # Verify custom GitLab Pages domains
    pages_domain_verification_cron_worker:
      cron: "*/15 * * * *"

Kamil Trzcinski's avatar
Kamil Trzcinski committed
262 263
  registry:
    # enabled: true
264
    # host: registry.example.com
265 266
    # port: 5005
    # api_url: http://localhost:5000/ # internal address to the registry, will be used by GitLab to directly communicate with API
267
    # key: config/registry.key
268
    # path: shared/registry
269
    # issuer: gitlab-issuer
Kamil Trzcinski's avatar
Kamil Trzcinski committed
270

271
  #
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
  # 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
289 290 291
  # ==========================

  ## LDAP settings
292 293
  # You can test connections and inspect a sample of the LDAP users with login
  # access by running:
294
  #   bundle exec rake gitlab:ldap:check RAILS_ENV=production
295 296
  ldap:
    enabled: false
297
    servers:
298 299 300 301 302 303 304 305 306
      ##########################################################################
      #
      # 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'.
      #
      ##########################################################################
307
      main: # 'main' is the GitLab 'provider ID' of this LDAP server
308 309 310 311 312 313 314 315
        ## 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'

316
        # Example: 'ldap.mydomain.com'
317
        host: '_your_ldap_server'
318 319 320 321 322
        # 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'
323 324
        bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
        password: '_the_password_of_the_bind_user'
325

Michael Kozono's avatar
Michael Kozono committed
326 327 328 329 330 331 332 333 334 335 336
        # 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
337 338
        # "start_tls" or "simple_tls". Defaults to true.
        verify_certificates: true
Michael Kozono's avatar
Michael Kozono committed
339 340 341 342 343 344

        # 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'
        #
345
        ca_file: ''
Michael Kozono's avatar
Michael Kozono committed
346 347 348 349 350 351 352 353

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

354 355 356 357 358
        # 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

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
        # 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

375
        # To maintain tight control over the number of active users on your GitLab installation,
376
        # enable this setting to keep new users blocked until they have been cleared by the admin
377
        # (default: false).
378 379
        block_auto_created_users: false

380 381
        # Base where we can search for users
        #
382
        #   Ex. 'ou=People,dc=gitlab,dc=example' or 'DC=mydomain,DC=com'
383 384 385 386 387
        #
        base: ''

        # Filter LDAP users
        #
388
        #   Format: RFC 4515 https://tools.ietf.org/search/rfc4515
389 390 391 392
        #   Ex. (employeeType=developer)
        #
        #   Note: GitLab does not support omniauth-ldap's custom filter syntax.
        #
393 394 395
        #   Example for getting only specific users:
        #   '(&(objectclass=user)(|(samaccountname=momo)(samaccountname=toto)))'
        #
396
        user_filter: ''
397

398
        # LDAP attributes that GitLab will use to create an account for the LDAP user.
Douwe Maan's avatar
Douwe Maan committed
399 400
        # 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']).
401 402 403 404 405
        # 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`).
406
          # If the attribute specified for `username` contains an email address,
407 408 409 410 411
          # 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`,
412
          # the full name is determined using the attributes specified for
413 414 415 416 417
          # `first_name` and `last_name`.
          name:       'cn'
          first_name: 'givenName'
          last_name:  'sn'

418 419 420
        # If lowercase_usernames is enabled, GitLab will lower case the username.
        lowercase_usernames: false

421 422 423 424 425 426 427
      # 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:
      #   ....
428 429


430
  ## OmniAuth settings
431
  omniauth:
432
    # Allow login via Twitter, Google, etc. using OmniAuth providers
433 434
    enabled: false

435 436 437 438
    # 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

439 440 441
    # 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.
442
    # When authenticating using LDAP, the user's email is always synced.
443 444 445 446 447 448 449
    # 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
450

451
    # CAUTION!
452 453
    # 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.
454
    # User accounts will be created automatically when authentication was successful.
455 456
    allow_single_sign_on: ["saml"]

457
    # Locks down those users until they have been cleared by the admin (default: true).
458
    block_auto_created_users: true
459 460 461
    # 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
462

463 464 465 466 467
    # 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
468 469 470 471 472 473 474
    # 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: []

475
    ## Auth providers
476 477
    # 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
478
    # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations
479 480
    # 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
481
    # Documentation for this is available at http://doc.gitlab.com/ce/integration/omniauth.html
482
    providers:
tduehr's avatar
tduehr committed
483 484 485 486 487 488 489 490 491
      # 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'} }
492
      # - { name: 'authentiq',
493
      #     # for client credentials (client ID and secret), go to https://www.authentiq.com/developers
494 495 496 497
      #     app_id: 'YOUR_CLIENT_ID',
      #     app_secret: 'YOUR_CLIENT_SECRET',
      #     args: {
      #             scope: 'aq:name email~rs address aq:push'
498 499
      #             # callback_url parameter is optional except when 'gitlab.host' in this file is set to 'localhost'
      #             # callback_url: 'YOUR_CALLBACK_URL'
500 501
      #           }
      #   }
502 503
      # - { name: 'github',
      #     app_id: 'YOUR_APP_ID',
Douwe Maan's avatar
Douwe Maan committed
504
      #     app_secret: 'YOUR_APP_SECRET',
505 506
      #     url: "https://github.com/",
      #     verify_ssl: true,
507
      #     args: { scope: 'user:email' } }
Douwe Maan's avatar
Douwe Maan committed
508 509 510
      # - { name: 'bitbucket',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET' }
511 512
      # - { name: 'gitlab',
      #     app_id: 'YOUR_APP_ID',
Douwe Maan's avatar
Douwe Maan committed
513
      #     app_secret: 'YOUR_APP_SECRET',
514
      #     args: { scope: 'api' } }
Douwe Maan's avatar
Douwe Maan committed
515 516 517 518 519
      # - { name: 'google_oauth2',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET',
      #     args: { access_type: 'offline', approval_prompt: '' } }
      # - { name: 'facebook',
520
      #     app_id: 'YOUR_APP_ID',
521
      #     app_secret: 'YOUR_APP_SECRET' }
Douwe Maan's avatar
Douwe Maan committed
522 523 524
      # - { name: 'twitter',
      #     app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET' }
525 526 527 528 529 530 531 532 533 534 535
      # - { 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/',
      #             valid_within: nil,
      #           }
      #   }
536
      # - { name: 'saml',
537
      #     label: 'Our SAML Provider',
Patricio Cano's avatar
Patricio Cano committed
538 539
      #     groups_attribute: 'Groups',
      #     external_groups: ['Contractors', 'Freelancers'],
540 541 542 543 544 545 546
      #     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
547
      #
Valery Sizov's avatar
Valery Sizov committed
548 549 550 551 552
      # - { name: 'crowd',
      #     args: {
      #       crowd_server_url: 'CROWD SERVER URL',
      #       application_name: 'YOUR_APP_NAME',
      #       application_password: 'YOUR_APP_PASSWORD' } }
553 554 555 556 557 558
      #
      # - { name: 'auth0',
      #     args: {
      #       client_id: 'YOUR_AUTH0_CLIENT_ID',
      #       client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
      #       namespace: 'YOUR_AUTH0_DOMAIN' } }
559

tduehr's avatar
tduehr committed
560 561 562 563
    # SSO maximum session duration in seconds. Defaults to CAS default of 8 hours.
    # cas3:
    #   session_duration: 28800

564 565 566 567
  # Shared file storage settings
  shared:
    # path: /mnt/gitlab # Default: shared

568 569
  # Gitaly settings
  gitaly:
570
    # Path to the directory containing Gitaly client executables.
571
    client_path: /home/git/gitaly/bin
Jacob Vosmaer's avatar
Jacob Vosmaer committed
572 573 574 575
    # Default Gitaly authentication token. Can be overriden per storage. Can
    # be left blank when Gitaly is running locally on a Unix socket, which
    # is the normal way to deploy Gitaly.
    token:
576 577

  #
578
  # 4. Advanced settings
579 580
  # ==========================

581 582 583
  ## Repositories settings
  repositories:
    # Paths where repositories can be stored. Give the canonicalized absolute pathname.
Elan Ruusamäe's avatar
Elan Ruusamäe committed
584 585 586
    # 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.
587
    storages: # You must have at least a `default` storage path.
588 589
      default:
        path: /home/git/repositories/
590
        gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket # TCP connections are supported too (e.g. tcp://host:port)
591
        # gitaly_token: 'special token' # Optional: override global gitaly.token for this storage.
592

593 594 595
  ## Backup settings
  backup:
    path: "tmp/backups"   # Relative paths are relative to Rails.root (default: tmp/backups/)
596
    # archive_permissions: 0640 # Permissions for the resulting backup.tar file (default: 0600)
597
    # keep_time: 604800   # default: 0 (forever) (in seconds)
598
    # pg_schema: public     # default: nil, it means that all schemas will be backed up
599 600 601 602
    # upload:
    #   # Fog storage connection settings, see http://fog.io/storage/ .
    #   connection:
    #     provider: AWS
603
    #     region: eu-west-1
604 605 606 607
    #     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'
608 609 610
    #   # Use multipart uploads when file size reaches 100MB, see
    #   #  http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
    #   multipart_chunk_size: 104857600
611 612
    #   # Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional
    #   # encryption: 'AES256'
613 614
    #   # Specifies Amazon S3 storage class to use for backups, this is optional
    #   # storage_class: 'STANDARD'
615

616 617
  ## GitLab Shell settings
  gitlab_shell:
618
    path: /home/git/gitlab-shell/
619 620
    hooks_path: /home/git/gitlab-shell/hooks/

621 622 623 624
    # 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

625 626 627 628
    # Git over HTTP
    upload_pack: true
    receive_pack: true

629 630
    # Git import/fetch timeout, in seconds. Defaults to 3 hours.
    # git_timeout: 10800
631

632
    # If you use non-standard ssh port you need to specify it
633 634
    # ssh_port: 22

635 636 637 638 639
  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

640
  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
641
  # CAUTION!
642 643 644 645
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git

646 647 648 649 650 651 652 653 654 655
  ## 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

656 657 658
  ## Monitoring
  # Built in monitoring settings
  monitoring:
659 660
    # Time between sampling of unicorn socket metrics, in seconds
    # unicorn_sampler_interval: 10
661
    # IP whitelist to access monitoring endpoints
662 663
    ip_whitelist:
      - 127.0.0.0/8
664

665 666 667 668 669
    # Sidekiq exporter is webserver built in to Sidekiq to expose Prometheus metrics
    sidekiq_exporter:
    #  enabled: true
    #  address: localhost
    #  port: 3807
670

671
  #
672
  # 5. Extra customization
673 674
  # ==========================

675
  extra:
676 677 678
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

Sebastian Winkler's avatar
Sebastian Winkler committed
679 680 681 682
    ## Piwik analytics.
    # piwik_url: '_your_piwik_url'
    # piwik_site_id: '_your_piwik_site_id'

683 684
  rack_attack:
    git_basic_auth:
685 686 687
      # Rack Attack IP banning enabled
      # enabled: true
      #
688 689 690
      # Whitelist requests from 127.0.0.1 for web proxies (NGINX/Apache) with incorrect headers
      # ip_whitelist: ["127.0.0.1"]
      #
691 692 693 694 695 696 697 698 699
      # 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

700
development:
701
  <<: *base
702 703

test:
704
  <<: *base
705 706
  gravatar:
    enabled: true
Marin Jankovski's avatar
Marin Jankovski committed
707 708
  lfs:
    enabled: false
709 710 711 712 713 714 715 716 717
    # 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
718
        region: us-east-1
719
  artifacts:
720
    path: tmp/tests/artifacts
721 722 723 724 725 726
    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
727
      background_upload: false
728 729 730 731
      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
732
        region: us-east-1
733 734 735 736 737 738 739 740
  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
741
        region: us-east-1
742 743
  gitlab:
    host: localhost
744
    port: 80
745 746

    # When you run tests we clone and setup gitlab-shell
747
    # In order to setup it correctly you need to specify
748
    # your system username you use to run GitLab
749
    # user: YOUR_USERNAME
750 751
  pages:
    path: tmp/tests/pages
752 753
  repositories:
    storages:
754 755
      default:
        path: tmp/tests/repositories/
756
        gitaly_address: unix:tmp/tests/gitaly/gitaly.socket
757 758 759 760
      broken:
        path: tmp/tests/non-existent-repositories
        gitaly_address: unix:tmp/tests/gitaly/gitaly.socket

761
  gitaly:
762
    client_path: tmp/tests/gitaly
763
    token: secret
764
  backup:
765
    path: tmp/tests/backups
766 767 768
  gitlab_shell:
    path: tmp/tests/gitlab-shell/
    hooks_path: tmp/tests/gitlab-shell/hooks/
769 770
  issues_tracker:
    redmine:
771
      title: "Redmine"
772
      project_url: "http://redmine/projects/:issues_tracker_id"
773
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
774
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
775 776
    jira:
      title: "JIRA"
777
      url: https://sample_company.atlassian.net
778
      project_key: PROJECT
779 780 781 782 783 784 785 786 787

  omniauth:
    enabled: true
    allow_single_sign_on: true
    external_providers: []

    providers:
      - { name: 'cas3',
          label: 'cas3',
Timothy Andrew's avatar
Timothy Andrew committed
788
          args: { url: 'https://sso.example.com',
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
                  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' }
816 817 818 819 820 821 822 823 824 825 826
      - { 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/',
                  valid_within: nil,
                }
        }
827 828 829 830 831
      - { name: 'auth0',
          args: {
            client_id: 'YOUR_AUTH0_CLIENT_ID',
            client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
            namespace: 'YOUR_AUTH0_DOMAIN' } }
832 833 834 835
      - { name: 'authentiq',
          app_id: 'YOUR_CLIENT_ID',
          app_secret: 'YOUR_CLIENT_SECRET',
          args: { scope: 'aq:name email~rs address aq:push' } }
836 837 838
  ldap:
    enabled: false
    servers:
839
      main:
840 841 842 843
        label: ldap
        host: 127.0.0.1
        port: 3890
        uid: 'uid'
Michael Kozono's avatar
Michael Kozono committed
844
        encryption: 'plain' # "start_tls" or "simple_tls" or "plain"
845 846 847 848
        base: 'dc=example,dc=com'
        user_filter: ''
        group_base: 'ou=groups,dc=example,dc=com'
        admin_group: ''
849 850

staging:
851
  <<: *base