gitlab.yml.example 7.3 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: This feature is known to work, but unsupported
24 25 26
    # Note that three settings need to be changed for this to work.
    # 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 30 31 32 33 34 35 36 37 38 39 40
    # 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

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

53

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

58
    ## Automatic issue closing
S
Sytse Sijbrandij 已提交
59
    # If a commit message matches this regular expression, all issues referenced from the matched text will be closed.
S
Sytse Sijbrandij 已提交
60 61 62
    # This  happends when the commit is pushed or merged into the default branch of a project.
    # When not specified the default issue_closing_pattern as specified below will be used.
    # issue_closing_pattern: ([Cc]loses|[Ff]ixes) +#\d+
63

64 65 66 67 68
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
69 70
      wall: false
      snippets: false
71
      public: false
72 73

  ## External issues trackers
74
  issues_tracker:
75
    # redmine:
76
    #   title: "Redmine"
77 78 79 80 81
    #   ## 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"
82
    #
83 84 85 86 87 88
    #   ## 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"
89 90 91 92 93 94
    #
    #   ## 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"
95 96
    # 
    # jira:
97
    #   title: "Atlassian Jira"
98 99 100
    #   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"
101

102 103
  ## Gravatar
  gravatar:
104
    enabled: true                 # Use user avatar image from Gravatar.com (default: true)
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    # 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
  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'
122
    allow_username_or_email_login: true
123

124
  ## OmniAuth settings
125
  omniauth:
126
    # Allow login via Twitter, Google, etc. using OmniAuth providers
127 128 129
    enabled: false

    # CAUTION!
130
    # This allows users to login without having a user account first (default: false).
131 132
    # User accounts will be created automatically when authentication was successful.
    allow_single_sign_on: false
133
    # Locks down those users until they have been cleared by the admin (default: true).
134 135 136
    block_auto_created_users: true

    ## Auth providers
137 138
    # 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:
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    # see https://github.com/gitlabhq/gitlabhq/wiki/Using-Custom-Omniauth-Providers
    # 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',
      #     app_secret: 'YOUR APP SECRET' }



  #
  # 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:
    # 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

177
    # If you use non-standard ssh port you need to specify it
178 179 180
    # ssh_port: 22

  ## Git settings
R
Riyad Preukschas 已提交
181
  # CAUTION!
182 183 184
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git
185 186
    # Max size of a git object (e.g. a commit), in bytes
    # This value can be increased if you have very large commits
187
    max_size: 5242880 # 5.megabytes
188
    # Git timeout to read a commit, in seconds
189 190
    timeout: 10

191 192 193 194
  #
  # 4. Extra customization
  # ==========================

195
  extra:
196 197 198 199
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

    ## Text under sign-in page (Markdown enabled)
200
    # sign_in_text: |
201 202 203
    #   ![Company Logo](http://www.companydomain.com/logo.png)
    #   [Learn more about CompanyName](http://www.companydomain.com/)

204
development:
A
Andrew8xx8 已提交
205
  <<: *base
206 207

test:
A
Andrew8xx8 已提交
208
  <<: *base
209 210
  issues_tracker:
    redmine:
211
      title: "Redmine"
212
      project_url: "http://redmine/projects/:issues_tracker_id"
213
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
A
Axilleas Pipinellis 已提交
214
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
215 216

staging:
A
Andrew8xx8 已提交
217
  <<: *base