gitlab.yml.example 8.46 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 17 18 19 20
production: &base
  #
  # 1. GitLab app settings
  # ==========================

  ## GitLab settings
  gitlab:
    ## Web server settings
    host: localhost
    port: 80
    https: false
21

22
    # Uncomment and customize the last line to run in a non-root path
23
    # WARNING: We recommend creating a FQDN to host GitLab in a root path instead of this. 
24
    # Note that four settings need to be changed for this to work.
25 26
    # 1) In your application.rb file: config.relative_url_root = "/gitlab"
    # 2) In your gitlab.yml file: relative_url_root: /gitlab
27
    # 3) In your unicorn.rb: ENV['RAILS_RELATIVE_URL_ROOT'] = "/gitlab"
28 29
    # 4) In ../gitlab-shell/config.yml: gitlab_url: "http://127.0.0.1/gitlab"
    # To update the path, run: sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
30
    #
31 32 33 34 35 36 37 38 39 40 41 42
    # 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
    email_from: gitlab@localhost

    # Email address of your support contact (default: same as email_from)
    support_email: support@localhost

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

55

56
    ## Users management
57 58
    # default: false - Account passwords are not sent via the email if signup is enabled. 
    # signup_enabled: true
59

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

64
    ## Automatic issue closing
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
65
    # 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
66
    # This happens when the commit is pushed or merged into the default branch of a project.
Sytse Sijbrandij's avatar
Sytse Sijbrandij committed
67
    # When not specified the default issue_closing_pattern as specified below will be used.
68
    # issue_closing_pattern: '([Cc]lose[sd]|[Ff]ixe[sd]) +#\d+'
69

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

  ## External issues trackers
80
  issues_tracker:
81
    # redmine:
82
    #   title: "Redmine"
83 84 85 86 87
    #   ## 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"
88
    #
89 90 91 92 93 94
    #   ## 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"
95 96 97 98 99 100
    #
    #   ## If not nil, linkis to creating new issues will be replaced with this
    #   ## 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"
101 102
    # 
    # jira:
103
    #   title: "Atlassian Jira"
104 105 106
    #   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"
107

108 109
  ## Gravatar
  gravatar:
110
    enabled: true                 # Use user avatar image from Gravatar.com (default: true)
111 112 113 114 115 116 117 118
    # plain_url: "http://..."     # default: http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=mm
    # ssl_url:   "https://..."    # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=mm

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

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

141
  ## OmniAuth settings
142
  omniauth:
143
    # Allow login via Twitter, Google, etc. using OmniAuth providers
144 145 146
    enabled: false

    # CAUTION!
147
    # This allows users to login without having a user account first (default: false).
148 149
    # User accounts will be created automatically when authentication was successful.
    allow_single_sign_on: false
150
    # Locks down those users until they have been cleared by the admin (default: true).
151 152 153
    block_auto_created_users: true

    ## Auth providers
154 155
    # 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:
Julien Kirch's avatar
Julien Kirch committed
156
    # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Working-custom-omniauth-provider-configurations
157 158 159 160 161 162 163 164 165
    # 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.
    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',
166 167
      #     app_secret: 'YOUR APP SECRET',
      #     args: { scope: 'user:email' } }
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186



  #
  # 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:
187 188
    path: /home/git/gitlab-shell/

189 190 191 192 193 194 195 196
    # 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

197
    # If you use non-standard ssh port you need to specify it
198 199 200
    # ssh_port: 22

  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
201
  # CAUTION!
202 203 204
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git
205 206
    # Max size of a git object (e.g. a commit), in bytes
    # This value can be increased if you have very large commits
207
    max_size: 5242880 # 5.megabytes
208
    # Git timeout to read a commit, in seconds
209 210
    timeout: 10

211 212 213 214
  #
  # 4. Extra customization
  # ==========================

215
  extra:
216 217 218 219
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

    ## Text under sign-in page (Markdown enabled)
220
    # sign_in_text: |
221 222 223
    #   ![Company Logo](http://www.companydomain.com/logo.png)
    #   [Learn more about CompanyName](http://www.companydomain.com/)

224
development:
225
  <<: *base
226 227

test:
228
  <<: *base
229 230
  issues_tracker:
    redmine:
231
      title: "Redmine"
232
      project_url: "http://redmine/projects/:issues_tracker_id"
233
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
234
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
235 236

staging:
237
  <<: *base