config/gitlab.yml.example

   1 # # # # # # # # # # # # # # # # # #
   2 # GitLab application config file  #
   3 # # # # # # # # # # # # # # # # # #
   4 #
   5 # How to use:
   6 # 1. copy file as gitlab.yml
   7 # 2. Replace gitlab -> host with your domain
   8 # 3. Replace gitlab -> email_from
   9
  10 production: &base
  11   #
  12   # 1. GitLab app settings
  13   # ==========================
  14
  15   ## GitLab settings
  16   gitlab:
  17     ## Web server settings
  18     host: localhost
  19     port: 80
  20     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     # Note that three settings need to be changed for this to work.
  25     # 1) In your application.rb file: config.relative_url_root = "/gitlab"
  26     # 2) In your gitlab.yml file: relative_url_root: /gitlab
  27     # 3) In your unicorn.rb: ENV['RAILS_RELATIVE_URL_ROOT'] = "/gitlab"
  28     #
  29     # relative_url_root: /gitlab
  30
  31     # Uncomment and customize if you can't use the default user to run GitLab (default: 'git')
  32     # user: git
  33
  34     ## Email settings
  35     # Email address used in the "From" field in mails sent by GitLab
  36     email_from: gitlab@localhost
  37
  38     # Email address of your support contact (default: same as email_from)
  39     support_email: support@localhost
  40
  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
  45     ## Default theme
  46     ##   BASIC  = 1
  47     ##   MARS   = 2
  48     ##   MODERN = 3
  49     ##   GRAY   = 4
  50     ##   COLOR  = 5
  51     # default_theme: 2 # default: 2
  52
  53
  54     ## Users management
  55     # default: false - Account passwords are not sent via the email if signup is enabled.
  56     # signup_enabled: true
  57
  58     ## Automatic issue closing
  59     # If a commit message matches this regular expression, all issues referenced from the matched text will be closed.
  60     # This  happends when the commit is pushed or merged into the default branch of a project.
  61     # When not specified the default issue_closing_pattern as specified below will be used.
  62     # issue_closing_pattern: ([Cc]lose[sd]|[Ff]ixe[sd]) +#\d+
  63
  64     ## Default project features settings
  65     default_projects_features:
  66       issues: true
  67       merge_requests: true
  68       wiki: true
  69       wall: false
  70       snippets: false
  71       public: false
  72
  73   ## External issues trackers
  74   issues_tracker:
  75     # redmine:
  76     #   title: "Redmine"
  77     #   ## If not nil, link 'Issues' on project page will be replaced with this
  78     #   ## Use placeholders:
  79     #   ##  :project_id        - GitLab project identifier
  80     #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
  81     #   project_url: "http://redmine.sample/projects/:issues_tracker_id"
  82     #
  83     #   ## If not nil, links from /#\d/ entities from commit messages will replaced with this
  84     #   ## Use placeholders:
  85     #   ##  :project_id        - GitLab project identifier
  86     #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
  87     #   ##  :id                - Issue id (from commit messages)
  88     #   issues_url: "http://redmine.sample/issues/:id"
  89     #
  90     #   ## If not nil, linkis to creating new issues will be replaced with this
  91     #   ## Use placeholders:
  92     #   ##  :project_id        - GitLab project identifier
  93     #   ##  :issues_tracker_id - Project Name or Id in external issue tracker
  94     #   new_issue_url: "http://redmine.sample/projects/:issues_tracker_id/issues/new"
  95     #
  96     # jira:
  97     #   title: "Atlassian Jira"
  98     #   project_url: "http://jira.sample/issues/?jql=project=:issues_tracker_id"
  99     #   issues_url: "http://jira.sample/browse/:id"
 100     #   new_issue_url: "http://jira.sample/secure/CreateIssue.jspa"
 101
 102   ## Gravatar
 103   gravatar:
 104     enabled: true                 # Use user avatar image from Gravatar.com (default: true)
 105     # plain_url: "http://..."     # default: http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=mm
 106     # ssl_url:   "https://..."    # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=mm
 107
 108   #
 109   # 2. Auth settings
 110   # ==========================
 111
 112   ## LDAP settings
 113   ldap:
 114     enabled: false
 115     host: '_your_ldap_server'
 116     base: '_the_base_where_you_search_for_users'
 117     port: 636
 118     uid: 'sAMAccountName'
 119     method: 'ssl' # "ssl" or "plain"
 120     bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
 121     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     enabled: false
 128
 129     # CAUTION!
 130     # This allows users to login without having a user account first (default: false).
 131     # User accounts will be created automatically when authentication was successful.
 132     allow_single_sign_on: false
 133     # Locks down those users until they have been cleared by the admin (default: true).
 134     block_auto_created_users: true
 135
 136     ## Auth providers
 137     # Uncomment the following lines and fill in the data of the auth provider you want to use
 138     # If your favorite auth provider is not listed you can use others:
 139     # see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Working-custom-omniauth-provider-configurations
 140     # The 'app_id' and 'app_secret' parameters are always passed as the first two
 141     # arguments, followed by optional 'args' which can be either a hash or an array.
 142     providers:
 143       # - { name: 'google_oauth2', app_id: 'YOUR APP ID',
 144       #     app_secret: 'YOUR APP SECRET',
 145       #     args: { access_type: 'offline', approval_prompt: '' } }
 146       # - { name: 'twitter', app_id: 'YOUR APP ID',
 147       #     app_secret: 'YOUR APP SECRET'}
 148       # - { name: 'github', app_id: 'YOUR APP ID',
 149       #     app_secret: 'YOUR APP SECRET' }
 150
 151
 152
 153   #
 154   # 3. Advanced settings
 155   # ==========================
 156
 157   # GitLab Satellites
 158   satellites:
 159     # Relative paths are relative to Rails.root (default: tmp/repo_satellites/)
 160     path: /home/git/gitlab-satellites/
 161
 162   ## Backup settings
 163   backup:
 164     path: "tmp/backups"   # Relative paths are relative to Rails.root (default: tmp/backups/)
 165     # keep_time: 604800   # default: 0 (forever) (in seconds)
 166
 167   ## GitLab Shell settings
 168   gitlab_shell:
 169     # REPOS_PATH MUST NOT BE A SYMLINK!!!
 170     repos_path: /home/git/repositories/
 171     hooks_path: /home/git/gitlab-shell/hooks/
 172
 173     # Git over HTTP
 174     upload_pack: true
 175     receive_pack: true
 176
 177     # If you use non-standard ssh port you need to specify it
 178     # ssh_port: 22
 179
 180   ## Git settings
 181   # CAUTION!
 182   # Use the default values unless you really know what you are doing
 183   git:
 184     bin_path: /usr/bin/git
 185     # Max size of a git object (e.g. a commit), in bytes
 186     # 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     timeout: 10
 190
 191   #
 192   # 4. Extra customization
 193   # ==========================
 194
 195   extra:
 196     ## Google analytics. Uncomment if you want it
 197     # google_analytics_id: '_your_tracking_id'
 198
 199     ## Text under sign-in page (Markdown enabled)
 200     # sign_in_text: |
 201     #   ![Company Logo](http://www.companydomain.com/logo.png)
 202     #   [Learn more about CompanyName](http://www.companydomain.com/)
 203
 204 development:
 205   <<: *base
 206
 207 test:
 208   <<: *base
 209   issues_tracker:
 210     redmine:
 211       title: "Redmine"
 212       project_url: "http://redmine/projects/:issues_tracker_id"
 213       issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
 214       new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
 215
 216 staging:
 217   <<: *base