Commit 4496903950f56dde684d4cf603358f5a9535cdb5
1 parent
9bc315bb
Exists in
master
and in
4 other branches
Rename config options
Showing
1 changed file
with
49 additions
and
37 deletions
Show diff stats
config/gitlab.yml.example
| 1 | -# # # # # # # # # # # # # # # # # # | |
| 2 | -# Gitlab application config file # | |
| 3 | -# # # # # # # # # # # # # # # # # # | |
| 4 | 1 | |
| 5 | 2 | # |
| 6 | -# 1. Common settings | |
| 3 | +# 1. GitLab app settings | |
| 7 | 4 | # ========================== |
| 8 | 5 | |
| 9 | -# Web application specific settings | |
| 10 | -web: | |
| 6 | +## GitLab settings | |
| 7 | +gitlab: | |
| 8 | + ## Web server settings | |
| 11 | 9 | host: localhost |
| 12 | 10 | port: 80 |
| 13 | 11 | https: false |
| 14 | 12 | |
| 15 | -# Email used for notification | |
| 16 | -# about new issues, comments | |
| 17 | -email: | |
| 18 | - from: notify@localhost | |
| 13 | + ## Email settings | |
| 14 | + # Email address used in the "From" field in mails sent by GitLab | |
| 15 | + email_from: gitlab@localhost | |
| 19 | 16 | |
| 20 | -# Application specific settings | |
| 21 | -# Like default project limit for user etc | |
| 22 | -app: | |
| 17 | + ## Project settings | |
| 23 | 18 | default_projects_limit: 10 |
| 24 | - # backup_path: "/vol/backups" # default: Rails.root + backups/ | |
| 25 | - # backup_keep_time: 604800 # default: 0 (forever) (in seconds) | |
| 26 | - # disable_gravatar: true # default: false - Disable user avatars from Gravatar.com | |
| 27 | - # gravatar_url: "http://" # default: http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=mm | |
| 28 | - # gravatar_ssl_url: "https://" # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=mm | |
| 19 | + | |
| 20 | +## Gravatar | |
| 21 | +gravatar: | |
| 22 | + enabled: true # Use user avatar images from Gravatar.com (default: true) | |
| 23 | + # plain_url: "http://..." # default: http://www.gravatar.com/avatar/%{hash}?s=%{size}&d=mm | |
| 24 | + # ssl_url: "https://..." # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=mm | |
| 25 | + | |
| 29 | 26 | |
| 30 | 27 | |
| 31 | 28 | # |
| 32 | 29 | # 2. Auth settings |
| 33 | 30 | # ========================== |
| 34 | -ldap: | |
| 31 | + | |
| 32 | +## LDAP settings | |
| 33 | +ldap: | |
| 35 | 34 | enabled: false |
| 36 | 35 | host: '_your_ldap_server' |
| 37 | 36 | base: '_the_base_where_you_search_for_users' |
| 38 | 37 | port: 636 |
| 39 | 38 | uid: 'sAMAccountName' |
| 40 | - method: 'ssl' # plain | |
| 39 | + method: 'ssl' # "ssl" or "plain" | |
| 41 | 40 | bind_dn: '_the_full_dn_of_the_user_you_will_bind_with' |
| 42 | 41 | password: '_the_password_of_the_bind_user' |
| 43 | 42 | |
| 43 | +## Omniauth settings | |
| 44 | 44 | omniauth: |
| 45 | 45 | # Enable ability for users |
| 46 | - # to login via twitter, google .. | |
| 46 | + # Allow logging in via Twitter, Google, etc. using Omniauth providers | |
| 47 | 47 | enabled: false |
| 48 | 48 | |
| 49 | - # IMPORTANT! | |
| 50 | - # It allows user to login without having user account | |
| 49 | + # CAUTION! | |
| 50 | + # This allows users to login without having a user account first (default: false) | |
| 51 | + # User accounts will be created automatically when authentication was successful. | |
| 51 | 52 | allow_single_sign_on: false |
| 53 | + # Locks down those users until they have been cleared by the admin (default: true) | |
| 52 | 54 | block_auto_created_users: true |
| 53 | 55 | |
| 54 | - # Auth providers | |
| 56 | + ## Auth providers | |
| 57 | + # Uncomment the lines and fill in the data of the auth provider you want to use | |
| 58 | + # If your favorite auth provider is not listed you can user others: | |
| 59 | + # see https://github.com/gitlabhq/gitlabhq/wiki/Using-Custom-Omniauth-Providers | |
| 55 | 60 | providers: |
| 56 | 61 | # - { name: 'google_oauth2', app_id: 'YOUR APP ID', |
| 57 | 62 | # app_secret: 'YOUR APP SECRET', |
| ... | ... | @@ -62,29 +67,36 @@ omniauth: |
| 62 | 67 | # app_secret: 'YOUR APP SECRET' } |
| 63 | 68 | |
| 64 | 69 | |
| 70 | + | |
| 65 | 71 | # |
| 66 | -# 3. Advanced settings: | |
| 72 | +# 3. Advanced settings | |
| 67 | 73 | # ========================== |
| 68 | 74 | |
| 69 | -# Git Hosting configuration | |
| 70 | -git_host: | |
| 75 | +## Backup settings | |
| 76 | +backup: | |
| 77 | + path: "tmp/backups" # Relative paths are relative to Rails.root (default: tmp/backups/) | |
| 78 | + # keep_time: 604800 # default: 0 (forever) (in seconds) | |
| 79 | + | |
| 80 | +## Gitolite settings | |
| 81 | +gitolite: | |
| 71 | 82 | admin_uri: git@localhost:gitolite-admin |
| 72 | - base_path: /home/git/repositories/ | |
| 83 | + repos_path: /home/git/repositories/ | |
| 73 | 84 | hooks_path: /home/git/.gitolite/hooks/ |
| 74 | - gitolite_admin_key: gitlab | |
| 75 | - git_user: git | |
| 85 | + admin_key: gitlab | |
| 76 | 86 | upload_pack: true |
| 77 | 87 | receive_pack: true |
| 78 | - # host: localhost | |
| 88 | + ssh_user: git | |
| 89 | + ssh_host: localhost | |
| 90 | + # ssh_port: 22 | |
| 79 | 91 | # config_file: gitolite.conf |
| 80 | - # port: 22 | |
| 81 | 92 | |
| 82 | -# Git settings | |
| 83 | -# Use default values unless you understand it | |
| 93 | +## Git settings | |
| 94 | +# CAUTION! | |
| 95 | +# Use the default values unless you really know what you are doing | |
| 84 | 96 | git: |
| 85 | - path: /usr/bin/git | |
| 97 | + bin_path: /usr/bin/git | |
| 86 | 98 | # Max size of git object like commit, in bytes |
| 87 | 99 | # This value can be increased if you have a very large commits |
| 88 | - git_max_size: 5242880 # 5.megabytes | |
| 100 | + max_size: 5242880 # 5.megabytes | |
| 89 | 101 | # Git timeout to read commit, in seconds |
| 90 | - git_timeout: 10 | |
| 102 | + timeout: 10 | ... | ... |