Назначение каждого параметра описано на странице «Обзор». Здесь для каждого типа установки указано место, в котором записываются параметры, общие параметры OmniAuth и способ применения изменений. Записи провайдеров и серверов приведены на страницах OpenID Connect, SAML и LDAP.
Где хранится конфигурация
Пакет для ОС Linux. Параметры задаются ключами файла /etc/gitlab/gitlab.rb.
Omnibus Docker. Контейнер читает те же ключи gitlab.rb. Они попадают в него из переменной окружения GITLAB_OMNIBUS_CONFIG, которая вычисляется при каждом запуске, и из файла /etc/gitlab/gitlab.rb на томе конфигурации, который читается после переменной. Ключ, записанный в файле, переопределяет тот же ключ в переменной. Переменная задаётся при создании контейнера:
docker run -d --name code \
--shm-size 256m \
-p 80:80 -p 443:443 -p 22:22 \
-e GITLAB_OMNIBUS_CONFIG="external_url 'https://<HOSTNAME>'; gitlab_rails['omniauth_enabled'] = true; gitlab_rails['omniauth_allow_single_sign_on'] = ['openid_connect']; gitlab_rails['omniauth_auto_link_ldap_user'] = true" \
-v /srv/code/config:/etc/gitlab \
-v /srv/code/logs:/var/log/gitlab \
-v /srv/code/data:/var/opt/gitlab \
<REGISTRY>/<FLAVOR>:<VERSION>Переменная фиксируется при создании контейнера, поэтому её изменение означает удаление контейнера и создание нового с теми же томами. Записи провайдеров и LDAP-серверов занимают несколько строк, а том конфигурации сохраняет их при замене контейнера. С томами из быстрого старта файл /etc/gitlab/gitlab.rb внутри контейнера — это /srv/code/config/gitlab.rb на хосте, и редактируется он на хосте:
sudo vi /srv/code/config/gitlab.rbHelm-чарт. Параметры задаются значениями чарта в файле values.yaml релиза.
Модуль Deckhouse Platform. Параметры задаются в ресурсе CodeInstance, описанном на страницах «Настройка OmniAuth и LDAP» и Custom Resources в документации модуля.
Общие параметры OmniAuth
Параметры и их действие описаны в разделе «Общие параметры OmniAuth».
- Пакет для ОС Linux
- Omnibus Docker
- Helm-чарт
- Модуль Deckhouse Platform
У каждого общего параметра OmniAuth собственный ключ в gitlab.rb:
| Параметр | Ключ в gitlab.rb |
|---|---|
enabled | gitlab_rails['omniauth_enabled'] |
providers | gitlab_rails['omniauth_providers'] |
allow_single_sign_on | gitlab_rails['omniauth_allow_single_sign_on'] |
block_auto_created_users | gitlab_rails['omniauth_block_auto_created_users'] |
auto_link_ldap_user | gitlab_rails['omniauth_auto_link_ldap_user'] |
auto_link_user | gitlab_rails['omniauth_auto_link_user'] |
auto_sign_in_with_provider | gitlab_rails['omniauth_auto_sign_in_with_provider'] |
external_providers | gitlab_rails['omniauth_external_providers'] |
allow_bypass_two_factor | gitlab_rails['omniauth_allow_bypass_two_factor'] |
sync_profile_from_provider | gitlab_rails['omniauth_sync_profile_from_provider'] |
sync_profile_attributes | gitlab_rails['omniauth_sync_profile_attributes'] |
gitlab_rails['omniauth_enabled'] = true
gitlab_rails['omniauth_allow_single_sign_on'] = ['openid_connect']
gitlab_rails['omniauth_block_auto_created_users'] = true
gitlab_rails['omniauth_auto_link_ldap_user'] = true
gitlab_rails['omniauth_sync_profile_attributes'] = ['email']GITLAB_OMNIBUS_CONFIG и отделяется от следующего символом ;, как в команде docker run выше; ключ, значение которого занимает несколько строк, записывается в файл /srv/code/config/gitlab.rb.Общие параметры — это значения в секции global.appConfig.omniauth:
global:
appConfig:
omniauth:
enabled: true
allowSingleSignOn: ['openid_connect']
blockAutoCreatedUsers: true
autoLinkLdapUser: true
syncProfileAttributes: ['email']Общие параметры задаются в секции spec.appConfig.omniauth, а провайдеры перечисляются в её параметре providers:
enabled: true
allowSingleSignOn: ['openid_connect']
blockAutoCreatedUsers: true
autoLinkLdapUser: true
syncProfileAttributes: ['email']