gitlab.yml.example 13.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 8 9 10
# that do not require application restart are being moved to           #
# ApplicationSetting model!                                            #
# 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 42
    # WARNING: See config/application.rb under "Relative url support" for the list of
    # other files that need to be changed for relative url support
43 44 45 46 47
    # relative_url_root: /gitlab

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

48 49
    ## Date & Time settings
    # Uncomment and customize if you want to change the default time zone of GitLab application.
50
    # To see all available zones, run `bundle exec rake time:zones:all RAILS_ENV=production`
51 52
    # time_zone: 'UTC'

53 54 55 56 57 58 59 60 61 62
    ## 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

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

63
    # default_can_create_group: false  # default: true
64
    # username_changing_enabled: false # default: true - User can change her username/namespace
Izaak Alpert's avatar
Izaak Alpert committed
65 66 67 68 69 70
    ## Default theme
    ##   BASIC  = 1
    ##   MARS   = 2
    ##   MODERN = 3
    ##   GRAY   = 4
    ##   COLOR  = 5
Izaak Alpert's avatar
Izaak Alpert committed
71
    # default_theme: 2 # default: 2
Izaak Alpert's avatar
Izaak Alpert committed
72

73
    ## Automatic issue closing
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
74
    # 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
75
    # This happens when the commit is pushed or merged into the default branch of a project.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
76
    # When not specified the default issue_closing_pattern as specified below will be used.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
77
    # Tip: you can test your closing pattern at http://rubular.com.
78
    # issue_closing_pattern: '((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?#\d+(?:(?:, *| +and +)?))+)'
79

80 81 82 83 84
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
85
      snippets: false
86

87 88 89 90
    ## Webhook settings
    # Number of seconds to wait for HTTP response after sending webhook HTTP POST request (default: 10)
    # webhook_timeout: 10

91 92
    ## Repository downloads directory
    # When a user clicks e.g. 'Download zip' on a project, a temporary zip file is created in the following directory.
93
    # The default is 'tmp/repositories' relative to the root of the Rails app.
94 95
    # repository_downloads_path: tmp/repositories

96
  ## Gravatar
97
  ## For Libravatar see: http://doc.gitlab.com/ce/customization/libravatar.html
98
  gravatar:
99
    enabled: true                 # Use user avatar image from Gravatar.com (default: true)
100
    # gravatar urls: possible placeholders: %{hash} %{size} %{email}
101 102
    # plain_url: "http://..."     # default: http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
    # ssl_url:   "https://..."    # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
103 104 105 106 107 108

  #
  # 2. Auth settings
  # ==========================

  ## LDAP settings
109 110
  # You can inspect a sample of the LDAP users with login access by running:
  #   bundle exec rake gitlab:ldap:check RAILS_ENV=production
111 112
  ldap:
    enabled: false
113
    servers:
114 115 116 117 118 119 120 121 122
      ##########################################################################
      #
      # 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'.
      #
      ##########################################################################
123
      main: # 'main' is the GitLab 'provider ID' of this LDAP server
124 125 126 127 128 129 130 131 132
        ## 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'

        host: '_your_ldap_server'
133
        port: 389
134
        uid: 'sAMAccountName'
135
        method: 'plain' # "tls" or "ssl" or "plain"
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
        bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
        password: '_the_password_of_the_bind_user'

        # 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

155
        # To maintain tight control over the number of active users on your GitLab installation,
156
        # enable this setting to keep new users blocked until they have been cleared by the admin
157
        # (default: false).
158 159
        block_auto_created_users: false

160 161 162 163 164 165 166 167 168 169 170 171 172 173
        # Base where we can search for users
        #
        #   Ex. ou=People,dc=gitlab,dc=example
        #
        base: ''

        # Filter LDAP users
        #
        #   Format: RFC 4515 http://tools.ietf.org/search/rfc4515
        #   Ex. (employeeType=developer)
        #
        #   Note: GitLab does not support omniauth-ldap's custom filter syntax.
        #
        user_filter: ''
174

175 176 177 178 179 180 181
      # 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:
      #   ....
182 183


184
  ## OmniAuth settings
185
  omniauth:
186
    # Allow login via Twitter, Google, etc. using OmniAuth providers
187 188
    enabled: false

189 190 191 192
    # 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

193
    # CAUTION!
194
    # This allows users to login without having a user account first (default: false).
195 196
    # User accounts will be created automatically when authentication was successful.
    allow_single_sign_on: false
197
    # Locks down those users until they have been cleared by the admin (default: true).
198
    block_auto_created_users: true
199 200 201
    # 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
202 203

    ## Auth providers
204 205
    # 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
206
    # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations
207 208
    # 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
209
    # Documentation for this is available at http://doc.gitlab.com/ce/integration/omniauth.html
210
    providers:
Douwe Maan's avatar
Douwe Maan committed
211 212
      # - { name: 'google_oauth2', app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET',
213
      #     args: { access_type: 'offline', approval_prompt: '' } }
Douwe Maan's avatar
Douwe Maan committed
214 215 216 217
      # - { name: 'twitter', app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET'}
      # - { name: 'github', app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET',
218
      #     args: { scope: 'user:email' } }
Douwe Maan's avatar
Douwe Maan committed
219 220
      # - { name: 'gitlab', app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET',
221
      #     args: { scope: 'api' } }
Douwe Maan's avatar
Douwe Maan committed
222 223
      # - { name: 'bitbucket', app_id: 'YOUR_APP_ID',
      #     app_secret: 'YOUR_APP_SECRET'}
224 225 226 227 228 229 230 231 232
      # - { name: 'saml',
      #     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'
      #           } }

233 234 235 236 237 238 239 240 241 242 243



  #
  # 3. Advanced settings
  # ==========================

  # GitLab Satellites
  satellites:
    # Relative paths are relative to Rails.root (default: tmp/repo_satellites/)
    path: /home/git/gitlab-satellites/
244
    timeout: 30
245 246 247 248 249

  ## Backup settings
  backup:
    path: "tmp/backups"   # Relative paths are relative to Rails.root (default: tmp/backups/)
    # keep_time: 604800   # default: 0 (forever) (in seconds)
250 251 252 253
    # upload:
    #   # Fog storage connection settings, see http://fog.io/storage/ .
    #   connection:
    #     provider: AWS
254
    #     region: eu-west-1
255 256 257 258
    #     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'
259 260 261 262
    #   # Use multipart uploads when file size reaches 100MB, see
    #   #  http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
    #   multipart_chunk_size: 104857600

263 264
  ## GitLab Shell settings
  gitlab_shell:
265 266
    path: /home/git/gitlab-shell/

267 268 269 270
    # REPOS_PATH MUST NOT BE A SYMLINK!!!
    repos_path: /home/git/repositories/
    hooks_path: /home/git/gitlab-shell/hooks/

271 272 273 274
    # 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

275 276 277 278
    # Git over HTTP
    upload_pack: true
    receive_pack: true

279
    # If you use non-standard ssh port you need to specify it
280 281 282
    # ssh_port: 22

  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
283
  # CAUTION!
284 285 286
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git
dosire's avatar
dosire committed
287 288 289
    # The next value is the maximum memory size grit can use
    # Given in number of bytes per git object (e.g. a commit)
    # This value can be increased if you have very large commits
290
    max_size: 20971520 # 20.megabytes
291
    # Git timeout to read a commit, in seconds
292 293
    timeout: 10

294 295 296 297
  #
  # 4. Extra customization
  # ==========================

298
  extra:
299 300 301
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

Sebastian Winkler's avatar
Sebastian Winkler committed
302 303 304 305
    ## Piwik analytics.
    # piwik_url: '_your_piwik_url'
    # piwik_site_id: '_your_piwik_site_id'

306 307
  rack_attack:
    git_basic_auth:
308 309 310
      # Rack Attack IP banning enabled
      # enabled: true
      #
311 312 313
      # Whitelist requests from 127.0.0.1 for web proxies (NGINX/Apache) with incorrect headers
      # ip_whitelist: ["127.0.0.1"]
      #
314 315 316 317 318 319 320 321 322
      # 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

323
development:
324
  <<: *base
325 326

test:
327
  <<: *base
328 329 330 331
  gravatar:
    enabled: true
  gitlab:
    host: localhost
332
    port: 80
333 334

    # When you run tests we clone and setup gitlab-shell
335
    # In order to setup it correctly you need to specify
336
    # your system username you use to run GitLab
337
    # user: YOUR_USERNAME
338 339 340 341 342 343
  satellites:
    path: tmp/tests/gitlab-satellites/
  gitlab_shell:
    path: tmp/tests/gitlab-shell/
    repos_path: tmp/tests/repositories/
    hooks_path: tmp/tests/gitlab-shell/hooks/
344 345
  issues_tracker:
    redmine:
346
      title: "Redmine"
347
      project_url: "http://redmine/projects/:issues_tracker_id"
348
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
349
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
350 351 352
  ldap:
    enabled: false
    servers:
353
      main:
354 355 356 357 358 359 360 361 362 363
        label: ldap
        host: 127.0.0.1
        port: 3890
        uid: 'uid'
        method: 'plain' # "tls" or "ssl" or "plain"
        base: 'dc=example,dc=com'
        user_filter: ''
        group_base: 'ou=groups,dc=example,dc=com'
        admin_group: ''
        sync_ssh_keys: false
364 365

staging:
366
  <<: *base