gitlab.yml.example 9.44 KB
Newer Older
1
# # # # # # # # # # # # # # # # # #
2
# GitLab application config file  #
3
# # # # # # # # # # # # # # # # # #
4 5 6 7
#
# How to use:
# 1. copy file as gitlab.yml
# 2. Replace gitlab -> host with your domain
8
# 3. Replace gitlab -> email_from
9

10 11 12 13 14 15 16
production: &base
  #
  # 1. GitLab app settings
  # ==========================

  ## GitLab settings
  gitlab:
17
    ## Web server settings (note: host is the FQDN, do not include http://)
18 19 20
    host: localhost
    port: 80
    https: false
21

22 23 24 25 26
    # 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

27 28
    # WARNING: See config/application.rb under "Relative url support" for the list of
    # other files that need to be changed for relative url support
29 30 31 32 33 34 35
    # relative_url_root: /gitlab

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

    ## Email settings
    # Email address used in the "From" field in mails sent by GitLab
36
    email_from: example@example.com
37

38 39
    # Email server smtp settings are in [a separate file](initializers/smtp_settings.rb.sample).

40
    ## User settings
41
    default_projects_limit: 10
42
    # default_can_create_group: false  # default: true
43
    # username_changing_enabled: false # default: true - User can change her username/namespace
44 45 46 47 48 49
    ## Default theme
    ##   BASIC  = 1
    ##   MARS   = 2
    ##   MODERN = 3
    ##   GRAY   = 4
    ##   COLOR  = 5
Izaak Alpert's avatar
Izaak Alpert committed
50
    # default_theme: 2 # default: 2
51

52 53 54 55 56 57 58 59 60 61
    ## Users can create accounts
    # This also allows normal users to sign up for accounts themselves
    # default: false - By default GitLab administrators must create all new accounts
    # signup_enabled: true

    ## Standard login settings
    # The standard login can be disabled to force login via LDAP
    # default: true - If set to false the standard login form won't be shown on the sign-in page
    # signin_enabled: false

62 63 64 65
    # Restrict setting visibility levels for non-admin users.
    # The default is to allow all levels.
    #restricted_visibility_levels: [ "public" ]

66
    ## Automatic issue closing
67
    # If a commit message matches this regular expression, all issues referenced from the matched text will be closed.
68
    # This happens when the commit is pushed or merged into the default branch of a project.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
69
    # When not specified the default issue_closing_pattern as specified below will be used.
70
    # issue_closing_pattern: '([Cc]lose[sd]|[Ff]ixe[sd]) #(\d+)'
71

72 73 74 75 76
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
77
      snippets: false
78
      visibility_level: "private"  # can be "private" | "internal" | "public"
79

80 81
    ## Repository downloads directory
    # When a user clicks e.g. 'Download zip' on a project, a temporary zip file is created in the following directory.
82
    # The default is 'tmp/repositories' relative to the root of the Rails app.
83 84
    # repository_downloads_path: tmp/repositories

85
  ## External issues trackers
86
  issues_tracker:
87
    # redmine:
88
    #   title: "Redmine"
89 90 91 92 93
    #   ## If not nil, link 'Issues' on project page will be replaced with this
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   project_url: "http://redmine.sample/projects/:issues_tracker_id"
94
    #
95 96 97 98 99 100
    #   ## If not nil, links from /#\d/ entities from commit messages will replaced with this
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   ##  :id                - Issue id (from commit messages)
    #   issues_url: "http://redmine.sample/issues/:id"
101
    #
PhilZen <3's avatar
PhilZen <3 committed
102
    #   ## If not nil, links to creating new issues will be replaced with this
103 104 105 106
    #   ## Use placeholders:
    #   ##  :project_id        - GitLab project identifier
    #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
    #   new_issue_url: "http://redmine.sample/projects/:issues_tracker_id/issues/new"
107
    #
108
    # jira:
109
    #   title: "Atlassian Jira"
110 111 112
    #   project_url: "http://jira.sample/issues/?jql=project=:issues_tracker_id"
    #   issues_url: "http://jira.sample/browse/:id"
    #   new_issue_url: "http://jira.sample/secure/CreateIssue.jspa"
113

114 115
  ## Gravatar
  gravatar:
116
    enabled: true                 # Use user avatar image from Gravatar.com (default: true)
117
    # gravatar urls: possible placeholders: %{hash} %{size} %{email}
118 119
    # 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
120 121 122 123 124 125

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

  ## LDAP settings
126 127
  # You can inspect a sample of the LDAP users with login access by running:
  #   bundle exec rake gitlab:ldap:check RAILS_ENV=production
128 129 130 131 132
  ldap:
    enabled: false
    host: '_your_ldap_server'
    port: 636
    uid: 'sAMAccountName'
133
    method: 'ssl' # "tls" or "ssl" or "plain"
134 135
    bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
    password: '_the_password_of_the_bind_user'
136
    # If allow_username_or_email_login is enabled, GitLab will ignore everything
137
    # after the first '@' in the LDAP username submitted by the user on login.
138
    #
139 140 141
    # 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'.
142
    #
143 144
    # If you are using "uid: 'userPrincipalName'" on ActiveDirectory you need to
    # disable this setting, because the userPrincipalName contains an '@'.
145
    allow_username_or_email_login: true
146

147 148 149 150 151 152 153 154 155 156 157 158 159 160
    # Base where we can search for users
    #
    #   Ex. ou=People,dc=gitlab,dc=example
    #
    base: ''

    # Filter LDAP users
    #
    #   Format: RFC 4515
    #   Ex. (employeeType=developer)
    #
    user_filter: ''


161
  ## OmniAuth settings
162
  omniauth:
163
    # Allow login via Twitter, Google, etc. using OmniAuth providers
164 165 166
    enabled: false

    # CAUTION!
167
    # This allows users to login without having a user account first (default: false).
168 169
    # User accounts will be created automatically when authentication was successful.
    allow_single_sign_on: false
170
    # Locks down those users until they have been cleared by the admin (default: true).
171 172 173
    block_auto_created_users: true

    ## Auth providers
174 175
    # 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:
176
    # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations
177 178
    # 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.
Sid Sijbrandij's avatar
Sid Sijbrandij committed
179
    # Documentation for this is available at http://doc.gitlab.com/ce/integration/omniauth.html
180 181 182 183 184 185 186
    providers:
      # - { name: 'google_oauth2', app_id: 'YOUR APP ID',
      #     app_secret: 'YOUR APP SECRET',
      #     args: { access_type: 'offline', approval_prompt: '' } }
      # - { name: 'twitter', app_id: 'YOUR APP ID',
      #     app_secret: 'YOUR APP SECRET'}
      # - { name: 'github', app_id: 'YOUR APP ID',
187 188
      #     app_secret: 'YOUR APP SECRET',
      #     args: { scope: 'user:email' } }
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207



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

  # GitLab Satellites
  satellites:
    # Relative paths are relative to Rails.root (default: tmp/repo_satellites/)
    path: /home/git/gitlab-satellites/

  ## Backup settings
  backup:
    path: "tmp/backups"   # Relative paths are relative to Rails.root (default: tmp/backups/)
    # keep_time: 604800   # default: 0 (forever) (in seconds)

  ## GitLab Shell settings
  gitlab_shell:
208 209
    path: /home/git/gitlab-shell/

210 211 212 213 214 215 216 217
    # REPOS_PATH MUST NOT BE A SYMLINK!!!
    repos_path: /home/git/repositories/
    hooks_path: /home/git/gitlab-shell/hooks/

    # Git over HTTP
    upload_pack: true
    receive_pack: true

218
    # If you use non-standard ssh port you need to specify it
219 220 221
    # ssh_port: 22

  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
222
  # CAUTION!
223 224 225
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git
226 227 228
    # 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
229
    max_size: 20971520 # 20.megabytes
230
    # Git timeout to read a commit, in seconds
231 232
    timeout: 10

233 234 235 236
  #
  # 4. Extra customization
  # ==========================

237
  extra:
238 239 240
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

Sebastian Winkler's avatar
Sebastian Winkler committed
241 242 243 244
    ## Piwik analytics.
    # piwik_url: '_your_piwik_url'
    # piwik_site_id: '_your_piwik_site_id'

245
    ## Text under sign-in page (Markdown enabled)
246
    # sign_in_text: |
247 248 249
    #   ![Company Logo](http://www.companydomain.com/logo.png)
    #   [Learn more about CompanyName](http://www.companydomain.com/)

250
development:
251
  <<: *base
252 253

test:
254
  <<: *base
255 256 257 258 259
  gravatar:
    enabled: true
  gitlab:
    host: localhost
    port: 80
260 261
  issues_tracker:
    redmine:
262
      title: "Redmine"
263
      project_url: "http://redmine/projects/:issues_tracker_id"
264
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
265
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
266 267

staging:
268
  <<: *base