debian-mirror-gitlab/config/gitlab.yml.example

856 lines
33 KiB
Text
Raw Normal View History

2014-09-02 18:07:02 +05:30
# # # # # # # # # # # # # # # # # #
# GitLab application config file #
# # # # # # # # # # # # # # # # # #
#
2015-04-26 12:48:37 +05:30
########################### NOTE #####################################
# This file should not receive new settings. All configuration options #
# * are being moved to ApplicationSetting model! #
# If a setting requires an application restart say so in that screen. #
2015-09-11 14:41:01 +05:30
# If you change this file in a Merge Request, please also create #
# a MR on https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests #
2015-04-26 12:48:37 +05:30
########################################################################
#
2015-09-11 14:41:01 +05:30
#
2014-09-02 18:07:02 +05:30
# How to use:
2015-04-26 12:48:37 +05:30
# 1. Copy file as gitlab.yml
# 2. Update gitlab -> host with your fully qualified domain name
# 3. Update gitlab -> email_from
# 4. If you installed Git from source, change git -> bin_path to /usr/local/bin/git
2015-09-11 14:41:01 +05:30
# IMPORTANT: If Git was installed in a different location use that instead.
# You can check with `which git`. If a wrong path of Git is specified, it will
# result in various issues such as failures of GitLab CI builds.
2015-04-26 12:48:37 +05:30
# 5. Review this configuration file for other settings you may want to adjust
2014-09-02 18:07:02 +05:30
production: &base
#
# 1. GitLab app settings
# ==========================
## GitLab settings
gitlab:
## Web server settings (note: host is the FQDN, do not include http://)
host: localhost
2015-04-26 12:48:37 +05:30
port: 80 # Set to 443 if using HTTPS, see installation.md#using-https for additional HTTPS configuration details
https: false # Set to true if using HTTPS, see installation.md#using-https for additional HTTPS configuration details
2014-09-02 18:07:02 +05:30
# Uncommment this line below if your ssh host is different from HTTP/HTTPS one
# (you'd obviously need to replace ssh.host_example.com with your own host).
# Otherwise, ssh host will be set to the `host:` value above
# ssh_host: ssh.host_example.com
2016-04-02 18:10:28 +05:30
# Relative URL support
# WARNING: We recommend using an FQDN to host GitLab in a root path instead
# of using a relative URL.
# Documentation: http://doc.gitlab.com/ce/install/relative_url.html
# Uncomment and customize the following line to run in a non-root path
#
2014-09-02 18:07:02 +05:30
# relative_url_root: /gitlab
2016-06-02 11:05:42 +05:30
# Trusted Proxies
# Customize if you have GitLab behind a reverse proxy which is running on a different machine.
# Add the IP address for your reverse proxy to the list, otherwise users will appear signed in from that address.
trusted_proxies:
# Examples:
#- 192.168.1.0/24
#- 192.168.2.1
#- 2001:0db8::/32
2014-09-02 18:07:02 +05:30
# Uncomment and customize if you can't use the default user to run GitLab (default: 'git')
# user: git
2015-04-26 12:48:37 +05:30
## Date & Time settings
# Uncomment and customize if you want to change the default time zone of GitLab application.
# To see all available zones, run `bundle exec rake time:zones:all RAILS_ENV=production`
# time_zone: 'UTC'
2014-09-02 18:07:02 +05:30
## Email settings
2015-04-26 12:48:37 +05:30
# Uncomment and set to false if you need to disable email sending from GitLab (default: true)
# email_enabled: true
2014-09-02 18:07:02 +05:30
# Email address used in the "From" field in mails sent by GitLab
email_from: example@example.com
2015-04-26 12:48:37 +05:30
email_display_name: GitLab
email_reply_to: noreply@example.com
2016-11-03 12:29:30 +05:30
email_subject_suffix: ''
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
# Email server smtp settings are in config/initializers/smtp_settings.rb.sample
2014-09-02 18:07:02 +05:30
# default_can_create_group: false # default: true
# username_changing_enabled: false # default: true - User can change her username/namespace
2018-03-17 18:26:18 +05:30
## Default theme ID
## 1 - Indigo
## 2 - Dark
## 3 - Light
## 4 - Blue
## 5 - Green
# default_theme: 1 # default: 1
2014-09-02 18:07:02 +05:30
## Automatic issue closing
# If a commit message matches this regular expression, all issues referenced from the matched text will be closed.
# This happens 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.
2015-04-26 12:48:37 +05:30
# Tip: you can test your closing pattern at http://rubular.com.
2018-03-17 18:26:18 +05:30
# issue_closing_pattern: '((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?|[Rr]esolv(?:e[sd]?|ing)|[Ii]mplement(?:s|ed|ing)?)(:?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?)|([A-Z][A-Z0-9_]+-\d+))+)'
2014-09-02 18:07:02 +05:30
## Default project features settings
default_projects_features:
issues: true
merge_requests: true
wiki: true
2017-08-17 22:00:37 +05:30
snippets: true
2015-11-26 14:37:03 +05:30
builds: true
2016-06-02 11:05:42 +05:30
container_registry: true
2014-09-02 18:07:02 +05:30
2015-04-26 12:48:37 +05:30
## Webhook settings
# Number of seconds to wait for HTTP response after sending webhook HTTP POST request (default: 10)
# webhook_timeout: 10
2014-09-02 18:07:02 +05:30
## Repository downloads directory
# When a user clicks e.g. 'Download zip' on a project, a temporary zip file is created in the following directory.
2016-08-24 12:49:21 +05:30
# The default is 'shared/cache/archive/' relative to the root of the Rails app.
# repository_downloads_path: shared/cache/archive/
2014-09-02 18:07:02 +05:30
2015-09-25 12:07:36 +05:30
## Reply by email
# Allow users to comment on issues and merge requests by replying to notification emails.
2016-11-03 12:29:30 +05:30
# For documentation on how to set this up, see http://doc.gitlab.com/ce/administration/reply_by_email.html
2015-09-25 12:07:36 +05:30
incoming_email:
enabled: false
2015-10-24 18:46:33 +05:30
# The email address including the `%{key}` placeholder that will be replaced to reference the item being replied to.
2016-06-02 11:05:42 +05:30
# The placeholder can be omitted but if present, it must appear in the "user" part of the address (before the `@`).
2015-10-24 18:46:33 +05:30
address: "gitlab-incoming+%{key}@gmail.com"
# Email account username
# With third party providers, this is usually the full email address.
# With self-hosted email servers, this is usually the user part of the email address.
user: "gitlab-incoming@gmail.com"
# Email account password
password: "[REDACTED]"
# IMAP server host
host: "imap.gmail.com"
# IMAP server port
port: 993
# Whether the IMAP server uses SSL
ssl: true
# Whether the IMAP server uses StartTLS
start_tls: false
# The mailbox where incoming mail will end up. Usually "inbox".
mailbox: "inbox"
2017-08-17 22:00:37 +05:30
# The IDLE command timeout.
idle_timeout: 60
2015-09-25 12:07:36 +05:30
2015-11-26 14:37:03 +05:30
## Build Artifacts
artifacts:
enabled: true
# The location where build artifacts are stored (default: shared/artifacts).
# path: shared/artifacts
2018-05-09 12:01:36 +05:30
# object_store:
# enabled: false
# remote_directory: artifacts # The bucket name
# background_upload: false # Temporary option to limit automatic upload (Default: true)
# proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
# connection:
# provider: AWS # Only AWS supported at the moment
# aws_access_key_id: AWS_ACCESS_KEY_ID
# aws_secret_access_key: AWS_SECRET_ACCESS_KEY
# region: us-east-1
2015-11-26 14:37:03 +05:30
## Git LFS
lfs:
enabled: true
# The location where LFS objects are stored (default: shared/lfs-objects).
# storage_path: shared/lfs-objects
2018-05-09 12:01:36 +05:30
object_store:
enabled: false
remote_directory: lfs-objects # Bucket name
# direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
# background_upload: false # Temporary option to limit automatic upload (Default: true)
# proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
connection:
provider: AWS
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
region: us-east-1
# Use the following options to configure an AWS compatible host
# host: 'localhost' # default: s3.amazonaws.com
# endpoint: 'http://127.0.0.1:9000' # default: nil
# path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
2015-11-26 14:37:03 +05:30
2018-03-17 18:26:18 +05:30
## Uploads (attachments, avatars, etc...)
uploads:
# The location where uploads objects are stored (default: public/).
# storage_path: public/
# base_dir: uploads/-/system
2018-05-09 12:01:36 +05:30
object_store:
enabled: false
2018-10-15 14:42:47 +05:30
remote_directory: uploads # Bucket name
2018-05-09 12:01:36 +05:30
# direct_upload: false # Use Object Storage directly for uploads instead of background uploads if enabled (Default: false)
# background_upload: false # Temporary option to limit automatic upload (Default: true)
# proxy_download: false # Passthrough all downloads via GitLab instead of using Redirects to Object Storage
2018-10-15 14:42:47 +05:30
connection:
provider: AWS
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
region: us-east-1
# host: 'localhost' # default: s3.amazonaws.com
# endpoint: 'http://127.0.0.1:9000' # default: nil
# path_style: true # Use 'host/bucket_name/object' instead of 'bucket_name.host/object'
2018-03-17 18:26:18 +05:30
2017-08-17 22:00:37 +05:30
## GitLab Pages
pages:
enabled: false
# The location where pages are stored (default: shared/pages).
# path: shared/pages
# The domain under which the pages are served:
# http://group.example.com/project
# or project path can be a group page: group.example.com
host: example.com
port: 80 # Set to 443 if you serve the pages with HTTPS
https: false # Set to true if you serve the pages with HTTPS
2018-03-17 18:26:18 +05:30
artifacts_server: true
2017-08-17 22:00:37 +05:30
# external_http: ["1.1.1.1:80", "[2001::1]:80"] # If defined, enables custom domain support in GitLab Pages
# external_https: ["1.1.1.1:443", "[2001::1]:443"] # If defined, enables custom domain and certificate support in GitLab Pages
2018-10-15 14:42:47 +05:30
admin:
address: unix:/home/git/gitlab/tmp/sockets/private/pages-admin.socket # TCP connections are supported too (e.g. tcp://host:port)
2017-08-17 22:00:37 +05:30
## Mattermost
## For enabling Add to Mattermost button
mattermost:
enabled: false
host: 'https://mattermost.example.com'
2014-09-02 18:07:02 +05:30
## Gravatar
2018-03-17 18:26:18 +05:30
## If using gravatar.com, there's nothing to change here. For Libravatar
## you'll need to provide the custom URLs. For more information,
## see: https://docs.gitlab.com/ee/customization/libravatar.html
2014-09-02 18:07:02 +05:30
gravatar:
2018-03-17 18:26:18 +05:30
# Gravatar/Libravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username}
# plain_url: "http://..." # default: https://www.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
2014-09-02 18:07:02 +05:30
# ssl_url: "https://..." # default: https://secure.gravatar.com/avatar/%{hash}?s=%{size}&d=identicon
2018-05-09 12:01:36 +05:30
## Sidekiq
sidekiq:
log_format: default # (json is also supported)
## Auxiliary jobs
2018-03-17 18:26:18 +05:30
# Periodically executed jobs, to self-heal GitLab, do external synchronizations, etc.
# Please read here for more information: https://github.com/ondrejbartas/sidekiq-cron#adding-cron-job
cron_jobs:
2017-08-17 22:00:37 +05:30
# Flag stuck CI jobs as failed
stuck_ci_jobs_worker:
cron: "0 * * * *"
# Execute scheduled triggers
pipeline_schedule_worker:
2017-09-10 17:25:29 +05:30
cron: "19 * * * *"
# Remove expired build artifacts
expire_build_artifacts_worker:
cron: "50 * * * *"
2016-06-02 11:05:42 +05:30
# Periodically run 'git fsck' on all repositories. If started more than
# once per hour you will have concurrent 'git fsck' jobs.
repository_check_worker:
cron: "20 * * * *"
# Send admin emails once a week
admin_email_worker:
cron: "0 0 * * 0"
# Remove outdated repository archives
repository_archive_cache_worker:
cron: "0 * * * *"
2018-03-17 18:26:18 +05:30
# Verify custom GitLab Pages domains
pages_domain_verification_cron_worker:
cron: "*/15 * * * *"
2016-06-02 11:05:42 +05:30
registry:
# enabled: true
# host: registry.example.com
# port: 5005
# api_url: http://localhost:5000/ # internal address to the registry, will be used by GitLab to directly communicate with API
# key: config/registry.key
2016-06-02 11:05:42 +05:30
# path: shared/registry
# issuer: gitlab-issuer
2014-09-02 18:07:02 +05:30
#
2015-09-25 12:07:36 +05:30
# 2. GitLab CI settings
# ==========================
gitlab_ci:
# Default project notifications settings:
#
# Send emails only on broken builds (default: true)
# all_broken_builds: true
#
# Add pusher to recipients list (default: false)
# add_pusher: true
# The location where build traces are stored (default: builds/). Relative paths are relative to Rails.root
# builds_path: builds/
#
# 3. Auth settings
2014-09-02 18:07:02 +05:30
# ==========================
## LDAP settings
2017-09-10 17:25:29 +05:30
# You can test connections and inspect a sample of the LDAP users with login
# access by running:
2014-09-02 18:07:02 +05:30
# bundle exec rake gitlab:ldap:check RAILS_ENV=production
ldap:
enabled: false
2015-04-26 12:48:37 +05:30
servers:
##########################################################################
#
# Since GitLab 7.4, LDAP servers get ID's (below the ID is 'main'). GitLab
# Enterprise Edition now supports connecting to multiple LDAP servers.
#
# If you are updating from the old (pre-7.4) syntax, you MUST give your
# old server the ID 'main'.
#
##########################################################################
main: # 'main' is the GitLab 'provider ID' of this LDAP server
## label
#
# A human-friendly name for your LDAP server. It is OK to change the label later,
# for instance if you find out it is too large to fit on the web page.
#
# Example: 'Paris' or 'Acme, Ltd.'
label: 'LDAP'
2017-09-10 17:25:29 +05:30
# Example: 'ldap.mydomain.com'
2015-04-26 12:48:37 +05:30
host: '_your_ldap_server'
2017-09-10 17:25:29 +05:30
# This port is an example, it is sometimes different but it is always an integer and not a string
port: 389 # usually 636 for SSL
uid: 'sAMAccountName' # This should be the attribute, not the value that maps to uid.
# Examples: 'america\\momo' or 'CN=Gitlab Git,CN=Users,DC=mydomain,DC=com'
2015-04-26 12:48:37 +05:30
bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
password: '_the_password_of_the_bind_user'
2015-10-24 18:46:33 +05:30
2017-09-10 17:25:29 +05:30
# Encryption method. The "method" key is deprecated in favor of
# "encryption".
#
# Examples: "start_tls" or "simple_tls" or "plain"
#
# Deprecated values: "tls" was replaced with "start_tls" and "ssl" was
# replaced with "simple_tls".
#
encryption: 'plain'
# Enables SSL certificate verification if encryption method is
2018-03-17 18:26:18 +05:30
# "start_tls" or "simple_tls". Defaults to true.
verify_certificates: true
2017-09-10 17:25:29 +05:30
# Specifies the path to a file containing a PEM-format CA certificate,
# e.g. if you need to use an internal CA.
#
# Example: '/etc/ca.pem'
#
ca_file: ''
# Specifies the SSL version for OpenSSL to use, if the OpenSSL default
# is not appropriate.
#
# Example: 'TLSv1_1'
#
ssl_version: ''
# Set a timeout, in seconds, for LDAP queries. This helps avoid blocking
# a request if the LDAP server becomes unresponsive.
# A value of 0 means there is no timeout.
timeout: 10
2015-04-26 12:48:37 +05:30
# This setting specifies if LDAP server is Active Directory LDAP server.
# For non AD servers it skips the AD specific queries.
# If your LDAP server is not AD, set this to false.
active_directory: true
# If allow_username_or_email_login is enabled, GitLab will ignore everything
# after the first '@' in the LDAP username submitted by the user on login.
#
# 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'.
#
# If you are using "uid: 'userPrincipalName'" on ActiveDirectory you need to
# disable this setting, because the userPrincipalName contains an '@'.
allow_username_or_email_login: false
# To maintain tight control over the number of active users on your GitLab installation,
2015-09-11 14:41:01 +05:30
# enable this setting to keep new users blocked until they have been cleared by the admin
2015-04-26 12:48:37 +05:30
# (default: false).
block_auto_created_users: false
# Base where we can search for users
#
2017-09-10 17:25:29 +05:30
# Ex. 'ou=People,dc=gitlab,dc=example' or 'DC=mydomain,DC=com'
2015-04-26 12:48:37 +05:30
#
base: ''
# Filter LDAP users
#
2017-09-10 17:25:29 +05:30
# Format: RFC 4515 https://tools.ietf.org/search/rfc4515
2015-04-26 12:48:37 +05:30
# Ex. (employeeType=developer)
#
# Note: GitLab does not support omniauth-ldap's custom filter syntax.
#
2017-09-10 17:25:29 +05:30
# Example for getting only specific users:
# '(&(objectclass=user)(|(samaccountname=momo)(samaccountname=toto)))'
#
2015-04-26 12:48:37 +05:30
user_filter: ''
2015-09-25 12:07:36 +05:30
# LDAP attributes that GitLab will use to create an account for the LDAP user.
# The specified attribute can either be the attribute name as a string (e.g. 'mail'),
# or an array of attribute names to try in order (e.g. ['mail', 'email']).
# Note that the user's LDAP login will always be the attribute specified as `uid` above.
attributes:
# The username will be used in paths for the user's own projects
# (like `gitlab.example.com/username/project`) and when mentioning
# them in issues, merge request and comments (like `@username`).
2015-10-24 18:46:33 +05:30
# If the attribute specified for `username` contains an email address,
2015-09-25 12:07:36 +05:30
# the GitLab username will be the part of the email address before the '@'.
username: ['uid', 'userid', 'sAMAccountName']
email: ['mail', 'email', 'userPrincipalName']
# If no full name could be found at the attribute specified for `name`,
2015-10-24 18:46:33 +05:30
# the full name is determined using the attributes specified for
2015-09-25 12:07:36 +05:30
# `first_name` and `last_name`.
name: 'cn'
first_name: 'givenName'
last_name: 'sn'
2018-03-17 18:26:18 +05:30
# If lowercase_usernames is enabled, GitLab will lower case the username.
lowercase_usernames: false
2015-04-26 12:48:37 +05:30
# GitLab EE only: add more LDAP servers
# Choose an ID made of a-z and 0-9 . This ID will be stored in the database
# so that GitLab can remember which LDAP server a user belongs to.
# uswest2:
# label:
# host:
# ....
2014-09-02 18:07:02 +05:30
## OmniAuth settings
omniauth:
# Allow login via Twitter, Google, etc. using OmniAuth providers
enabled: false
2015-09-11 14:41:01 +05:30
# Uncomment this to automatically sign in with a specific omniauth provider's without
# showing GitLab's sign-in page (default: show the GitLab sign-in page)
# auto_sign_in_with_provider: saml
2018-03-17 18:26:18 +05:30
# Sync user's profile from the specified Omniauth providers every time the user logs in (default: empty).
# Define the allowed providers using an array, e.g. ["cas3", "saml", "twitter"],
# or as true/false to allow all providers or none.
# When authenticating using LDAP, the user's email is always synced.
# sync_profile_from_provider: []
# Select which info to sync from the providers above. (default: email).
# Define the synced profile info using an array. Available options are "name", "email" and "location"
# e.g. ["name", "email", "location"] or as true to sync all available.
# This consequently will make the selected attributes read-only.
# sync_profile_attributes: true
2017-09-10 17:25:29 +05:30
2014-09-02 18:07:02 +05:30
# CAUTION!
2016-04-02 18:10:28 +05:30
# This allows users to login without having a user account first. Define the allowed providers
# using an array, e.g. ["saml", "twitter"], or as true/false to allow all providers or none.
2014-09-02 18:07:02 +05:30
# User accounts will be created automatically when authentication was successful.
2016-04-02 18:10:28 +05:30
allow_single_sign_on: ["saml"]
2014-09-02 18:07:02 +05:30
# Locks down those users until they have been cleared by the admin (default: true).
block_auto_created_users: true
2015-09-11 14:41:01 +05:30
# Look up new users in LDAP servers. If a match is found (same uid), automatically
# link the omniauth identity with the LDAP account. (default: false)
auto_link_ldap_user: false
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
# Allow users with existing accounts to login and auto link their account via SAML
# login, without having to do a manual login first and manually add SAML
# (default: false)
auto_link_saml_user: false
2016-06-02 11:05:42 +05:30
# Set different Omniauth providers as external so that all users creating accounts
# via these providers will not be able to have access to internal projects. You
# will need to use the full name of the provider, like `google_oauth2` for Google.
# Refer to the examples below for the full names of the supported providers.
# (default: [])
external_providers: []
2014-09-02 18:07:02 +05:30
## Auth providers
# 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:
# see https://github.com/gitlabhq/gitlab-public-wiki/wiki/Custom-omniauth-provider-configurations
# 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.
# Documentation for this is available at http://doc.gitlab.com/ce/integration/omniauth.html
providers:
# See omniauth-cas3 for more configuration details
# - { name: 'cas3',
# label: 'cas3',
# args: {
# url: 'https://sso.example.com',
# disable_ssl_verification: false,
# login_url: '/cas/login',
# service_validate_url: '/cas/p3/serviceValidate',
# logout_url: '/cas/logout'} }
2017-08-17 22:00:37 +05:30
# - { name: 'authentiq',
2017-09-10 17:25:29 +05:30
# # for client credentials (client ID and secret), go to https://www.authentiq.com/developers
2017-08-17 22:00:37 +05:30
# app_id: 'YOUR_CLIENT_ID',
# app_secret: 'YOUR_CLIENT_SECRET',
# args: {
# scope: 'aq:name email~rs address aq:push'
2017-09-10 17:25:29 +05:30
# # callback_url parameter is optional except when 'gitlab.host' in this file is set to 'localhost'
# # callback_url: 'YOUR_CALLBACK_URL'
2017-08-17 22:00:37 +05:30
# }
# }
2015-10-24 18:46:33 +05:30
# - { name: 'github',
# app_id: 'YOUR_APP_ID',
2015-04-26 12:48:37 +05:30
# app_secret: 'YOUR_APP_SECRET',
2016-06-02 11:05:42 +05:30
# url: "https://github.com/",
# verify_ssl: true,
2014-09-02 18:07:02 +05:30
# args: { scope: 'user:email' } }
2015-11-26 14:37:03 +05:30
# - { name: 'bitbucket',
# app_id: 'YOUR_APP_ID',
# app_secret: 'YOUR_APP_SECRET' }
2015-10-24 18:46:33 +05:30
# - { name: 'gitlab',
# app_id: 'YOUR_APP_ID',
2015-04-26 12:48:37 +05:30
# app_secret: 'YOUR_APP_SECRET',
# args: { scope: 'api' } }
2015-11-26 14:37:03 +05:30
# - { name: 'google_oauth2',
# app_id: 'YOUR_APP_ID',
# app_secret: 'YOUR_APP_SECRET',
# args: { access_type: 'offline', approval_prompt: '' } }
# - { name: 'facebook',
2015-10-24 18:46:33 +05:30
# app_id: 'YOUR_APP_ID',
2015-09-11 14:41:01 +05:30
# app_secret: 'YOUR_APP_SECRET' }
2015-11-26 14:37:03 +05:30
# - { name: 'twitter',
# app_id: 'YOUR_APP_ID',
# app_secret: 'YOUR_APP_SECRET' }
2018-05-09 12:01:36 +05:30
# - { name: 'jwt',
# app_secret: 'YOUR_APP_SECRET',
# args: {
# algorithm: 'HS256',
# uid_claim: 'email',
# required_claims: ["name", "email"],
# info_map: { name: "name", email: "email" },
# auth_url: 'https://example.com/',
# valid_within: null,
# }
# }
2015-10-24 18:46:33 +05:30
# - { name: 'saml',
2015-09-11 14:41:01 +05:30
# label: 'Our SAML Provider',
2016-06-02 11:05:42 +05:30
# groups_attribute: 'Groups',
# external_groups: ['Contractors', 'Freelancers'],
2015-09-11 14:41:01 +05:30
# args: {
# assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback',
# idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8',
# idp_sso_target_url: 'https://login.example.com/idp',
# issuer: 'https://gitlab.example.com',
# name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'
# } }
2016-06-02 11:05:42 +05:30
#
2015-09-25 12:07:36 +05:30
# - { name: 'crowd',
# args: {
# crowd_server_url: 'CROWD SERVER URL',
# application_name: 'YOUR_APP_NAME',
# application_password: 'YOUR_APP_PASSWORD' } }
2016-06-02 11:05:42 +05:30
#
# - { name: 'auth0',
# args: {
# client_id: 'YOUR_AUTH0_CLIENT_ID',
# client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
# namespace: 'YOUR_AUTH0_DOMAIN' } }
2015-09-11 14:41:01 +05:30
# SSO maximum session duration in seconds. Defaults to CAS default of 8 hours.
# cas3:
# session_duration: 28800
2015-11-26 14:37:03 +05:30
# Shared file storage settings
shared:
# path: /mnt/gitlab # Default: shared
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
# Gitaly settings
gitaly:
2018-03-17 18:26:18 +05:30
# Path to the directory containing Gitaly client executables.
client_path: /home/git/gitaly/bin
2017-09-10 17:25:29 +05:30
# Default Gitaly authentication token. Can be overriden per storage. Can
# be left blank when Gitaly is running locally on a Unix socket, which
# is the normal way to deploy Gitaly.
token:
2014-09-02 18:07:02 +05:30
#
2015-09-25 12:07:36 +05:30
# 4. Advanced settings
2014-09-02 18:07:02 +05:30
# ==========================
2016-08-24 12:49:21 +05:30
## Repositories settings
repositories:
# Paths where repositories can be stored. Give the canonicalized absolute pathname.
2017-08-17 22:00:37 +05:30
# IMPORTANT: None of the path components may be symlink, because
# gitlab-shell invokes Dir.pwd inside the repository path and that results
# real path not the symlink.
2016-08-24 12:49:21 +05:30
storages: # You must have at least a `default` storage path.
2017-08-17 22:00:37 +05:30
default:
path: /home/git/repositories/
gitaly_address: unix:/home/git/gitlab/tmp/sockets/private/gitaly.socket # TCP connections are supported too (e.g. tcp://host:port)
2017-09-10 17:25:29 +05:30
# gitaly_token: 'special token' # Optional: override global gitaly.token for this storage.
2016-08-24 12:49:21 +05:30
2014-09-02 18:07:02 +05:30
## Backup settings
backup:
path: "tmp/backups" # Relative paths are relative to Rails.root (default: tmp/backups/)
2015-09-11 14:41:01 +05:30
# archive_permissions: 0640 # Permissions for the resulting backup.tar file (default: 0600)
2014-09-02 18:07:02 +05:30
# keep_time: 604800 # default: 0 (forever) (in seconds)
2015-09-25 12:07:36 +05:30
# pg_schema: public # default: nil, it means that all schemas will be backed up
2015-04-26 12:48:37 +05:30
# upload:
# # Fog storage connection settings, see http://fog.io/storage/ .
# connection:
# provider: AWS
# region: eu-west-1
# aws_access_key_id: AKIAKIAKI
# aws_secret_access_key: 'secret123'
# # The remote 'directory' to store your backups. For S3, this would be the bucket name.
# remote_directory: 'my.s3.bucket'
2015-09-11 14:41:01 +05:30
# # Use multipart uploads when file size reaches 100MB, see
# # http://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
# multipart_chunk_size: 104857600
2015-10-24 18:46:33 +05:30
# # Turns on AWS Server-Side Encryption with Amazon S3-Managed Keys for backups, this is optional
# # encryption: 'AES256'
2017-08-17 22:00:37 +05:30
# # Specifies Amazon S3 storage class to use for backups, this is optional
# # storage_class: 'STANDARD'
2014-09-02 18:07:02 +05:30
## GitLab Shell settings
gitlab_shell:
path: /home/git/gitlab-shell/
hooks_path: /home/git/gitlab-shell/hooks/
2015-09-11 14:41:01 +05:30
# File that contains the secret key for verifying access for gitlab-shell.
# Default is '.gitlab_shell_secret' relative to Rails.root (i.e. root of the GitLab app).
# secret_file: /home/git/gitlab/.gitlab_shell_secret
2014-09-02 18:07:02 +05:30
# Git over HTTP
upload_pack: true
receive_pack: true
2018-03-17 18:26:18 +05:30
# Git import/fetch timeout, in seconds. Defaults to 3 hours.
# git_timeout: 10800
2017-08-17 22:00:37 +05:30
2014-09-02 18:07:02 +05:30
# If you use non-standard ssh port you need to specify it
# ssh_port: 22
2017-08-17 22:00:37 +05:30
workhorse:
# File that contains the secret key for verifying access for gitlab-workhorse.
# Default is '.gitlab_workhorse_secret' relative to Rails.root (i.e. root of the GitLab app).
# secret_file: /home/git/gitlab/.gitlab_workhorse_secret
2014-09-02 18:07:02 +05:30
## Git settings
# CAUTION!
# Use the default values unless you really know what you are doing
git:
bin_path: /usr/bin/git
2017-08-17 22:00:37 +05:30
## Webpack settings
# If enabled, this will tell rails to serve frontend assets from the webpack-dev-server running
# on a given port instead of serving directly from /assets/webpack. This is only indended for use
# in development.
webpack:
# dev_server:
# enabled: true
# host: localhost
# port: 3808
2017-09-10 17:25:29 +05:30
## Monitoring
# Built in monitoring settings
monitoring:
# Time between sampling of unicorn socket metrics, in seconds
# unicorn_sampler_interval: 10
# IP whitelist to access monitoring endpoints
ip_whitelist:
- 127.0.0.0/8
# Sidekiq exporter is webserver built in to Sidekiq to expose Prometheus metrics
sidekiq_exporter:
# enabled: true
# address: localhost
# port: 3807
2014-09-02 18:07:02 +05:30
#
2015-09-25 12:07:36 +05:30
# 5. Extra customization
2014-09-02 18:07:02 +05:30
# ==========================
extra:
## Google analytics. Uncomment if you want it
# google_analytics_id: '_your_tracking_id'
## Piwik analytics.
# piwik_url: '_your_piwik_url'
# piwik_site_id: '_your_piwik_site_id'
2015-04-26 12:48:37 +05:30
rack_attack:
git_basic_auth:
# Rack Attack IP banning enabled
# enabled: true
#
# Whitelist requests from 127.0.0.1 for web proxies (NGINX/Apache) with incorrect headers
# ip_whitelist: ["127.0.0.1"]
#
# Limit the number of Git HTTP authentication attempts per IP
# maxretry: 10
#
# Reset the auth attempt counter per IP after 60 seconds
# findtime: 60
#
# Ban an IP for one hour (3600s) after too many auth attempts
# bantime: 3600
2014-09-02 18:07:02 +05:30
development:
<<: *base
test:
<<: *base
gravatar:
enabled: true
2015-11-26 14:37:03 +05:30
lfs:
enabled: false
2018-05-09 12:01:36 +05:30
# The location where LFS objects are stored (default: shared/lfs-objects).
# storage_path: shared/lfs-objects
object_store:
enabled: false
remote_directory: lfs-objects # The bucket name
connection:
provider: AWS # Only AWS supported at the moment
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
region: us-east-1
2018-03-17 18:26:18 +05:30
artifacts:
path: tmp/tests/artifacts
2018-05-09 12:01:36 +05:30
enabled: true
# The location where build artifacts are stored (default: shared/artifacts).
# path: shared/artifacts
object_store:
enabled: false
remote_directory: artifacts # The bucket name
background_upload: false
connection:
provider: AWS # Only AWS supported at the moment
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
region: us-east-1
2018-03-17 18:26:18 +05:30
uploads:
storage_path: tmp/tests/public
2018-05-09 12:01:36 +05:30
object_store:
enabled: false
connection:
provider: AWS # Only AWS supported at the moment
aws_access_key_id: AWS_ACCESS_KEY_ID
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
region: us-east-1
2014-09-02 18:07:02 +05:30
gitlab:
host: localhost
port: 80
# When you run tests we clone and setup gitlab-shell
2015-04-26 12:48:37 +05:30
# In order to setup it correctly you need to specify
2014-09-02 18:07:02 +05:30
# your system username you use to run GitLab
2015-04-26 12:48:37 +05:30
# user: YOUR_USERNAME
2017-08-17 22:00:37 +05:30
pages:
path: tmp/tests/pages
2016-08-24 12:49:21 +05:30
repositories:
storages:
2017-08-17 22:00:37 +05:30
default:
path: tmp/tests/repositories/
gitaly_address: unix:tmp/tests/gitaly/gitaly.socket
2017-09-10 17:25:29 +05:30
broken:
path: tmp/tests/non-existent-repositories
gitaly_address: unix:tmp/tests/gitaly/gitaly.socket
2017-08-17 22:00:37 +05:30
gitaly:
2018-03-17 18:26:18 +05:30
client_path: tmp/tests/gitaly
2017-09-10 17:25:29 +05:30
token: secret
2015-09-11 14:41:01 +05:30
backup:
path: tmp/tests/backups
2014-09-02 18:07:02 +05:30
gitlab_shell:
path: tmp/tests/gitlab-shell/
hooks_path: tmp/tests/gitlab-shell/hooks/
issues_tracker:
redmine:
title: "Redmine"
project_url: "http://redmine/projects/:issues_tracker_id"
issues_url: "http://redmine/:project_id/:issues_tracker_id/:id"
new_issue_url: "http://redmine/projects/:issues_tracker_id/issues/new"
2017-08-17 22:00:37 +05:30
jira:
title: "JIRA"
url: https://sample_company.atlassian.net
project_key: PROJECT
2017-09-10 17:25:29 +05:30
omniauth:
enabled: true
allow_single_sign_on: true
external_providers: []
providers:
- { name: 'cas3',
label: 'cas3',
args: { url: 'https://sso.example.com',
disable_ssl_verification: false,
login_url: '/cas/login',
service_validate_url: '/cas/p3/serviceValidate',
logout_url: '/cas/logout'} }
- { name: 'github',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
url: "https://github.com/",
verify_ssl: false,
args: { scope: 'user:email' } }
- { name: 'bitbucket',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET' }
- { name: 'gitlab',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { scope: 'api' } }
- { name: 'google_oauth2',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { access_type: 'offline', approval_prompt: '' } }
- { name: 'facebook',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET' }
- { name: 'twitter',
app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET' }
2018-05-09 12:01:36 +05:30
- { name: 'jwt',
app_secret: 'YOUR_APP_SECRET',
args: {
algorithm: 'HS256',
uid_claim: 'email',
required_claims: ["name", "email"],
info_map: { name: "name", email: "email" },
auth_url: 'https://example.com/',
valid_within: null,
}
}
2017-09-10 17:25:29 +05:30
- { name: 'auth0',
args: {
client_id: 'YOUR_AUTH0_CLIENT_ID',
client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
namespace: 'YOUR_AUTH0_DOMAIN' } }
- { name: 'authentiq',
app_id: 'YOUR_CLIENT_ID',
app_secret: 'YOUR_CLIENT_SECRET',
args: { scope: 'aq:name email~rs address aq:push' } }
2015-04-26 12:48:37 +05:30
ldap:
enabled: false
servers:
main:
label: ldap
host: 127.0.0.1
port: 3890
uid: 'uid'
2017-09-10 17:25:29 +05:30
encryption: 'plain' # "start_tls" or "simple_tls" or "plain"
2015-04-26 12:48:37 +05:30
base: 'dc=example,dc=com'
user_filter: ''
group_base: 'ou=groups,dc=example,dc=com'
admin_group: ''
2014-09-02 18:07:02 +05:30
staging:
<<: *base