gitlab.yml.example 6.49 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
    # WARNING: This feature is no longer supported
22
    # Uncomment and customize to run in non-root path
23
    # Note that ENV['RAILS_RELATIVE_URL_ROOT'] in config/puma.rb may need to be changed
24 25 26 27 28 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
    email_from: gitlab@localhost

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

36
    ## User settings
37
    default_projects_limit: 10
38 39
    # default_can_create_group: false  # default: true
    # default_can_create_team: false   # default: true
40
    # username_changing_enabled: false # default: true - User can change her username/namespace
41

42
    ## Users management
43 44
    # signup_enabled: true          # default: false - Account passwords are not sent via the email if signup is enabled.

45 46 47 48 49
    ## Default project features settings
    default_projects_features:
      issues: true
      merge_requests: true
      wiki: true
50 51
      wall: false
      snippets: false
52 53

  ## External issues trackers
54
  issues_tracker:
55 56 57 58 59 60
    # redmine:
    #   ## 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"
61
    #
62 63 64 65 66 67
    #   ## 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"
68 69 70 71 72 73
    #
    #   ## 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"
74 75 76 77 78
    # 
    # jira:
    #   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"
79

80 81
  ## Gravatar
  gravatar:
82
    enabled: true                 # Use user avatar image from Gravatar.com (default: true)
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    # 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'

101
  ## OmniAuth settings
102
  omniauth:
103
    # Allow login via Twitter, Google, etc. using OmniAuth providers
104 105 106
    enabled: false

    # CAUTION!
107
    # This allows users to login without having a user account first (default: false).
108 109
    # User accounts will be created automatically when authentication was successful.
    allow_single_sign_on: false
110
    # Locks down those users until they have been cleared by the admin (default: true).
111 112 113
    block_auto_created_users: true

    ## Auth providers
114 115
    # 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:
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    # 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

154
    # If you use non-standard ssh port you need to specify it
155 156 157
    # ssh_port: 22

  ## Git settings
Riyad Preukschas's avatar
Riyad Preukschas committed
158
  # CAUTION!
159 160 161
  # Use the default values unless you really know what you are doing
  git:
    bin_path: /usr/bin/git
162 163
    # Max size of a git object (e.g. a commit), in bytes
    # This value can be increased if you have very large commits
164
    max_size: 5242880 # 5.megabytes
165
    # Git timeout to read a commit, in seconds
166 167
    timeout: 10

168 169 170 171
  #
  # 4. Extra customization
  # ==========================

172
  extra:
173 174 175 176
    ## Google analytics. Uncomment if you want it
    # google_analytics_id: '_your_tracking_id'

    ## Text under sign-in page (Markdown enabled)
177
    # sign_in_text: |
178 179 180
    #   ![Company Logo](http://www.companydomain.com/logo.png)
    #   [Learn more about CompanyName](http://www.companydomain.com/)

181
development:
182
  <<: *base
183 184

test:
185
  <<: *base
186 187
  issues_tracker:
    redmine:
188
      project_url: "http://redmine/projects/:issues_tracker_id"
189
      issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
190
      new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
191 192

staging:
193
  <<: *base