gitlab.rb 配置文件详解
时间: 2023-11-11 20:55:44 浏览: 344
gitlab.rb 是 GitLab 的主要配置文件,它位于 GitLab 安装目录下的 /etc/gitlab/ 目录下。该文件包含 GitLab 的所有配置选项,如 SMTP 邮件设置、LDAP 集成、备份和恢复、CI/CD 构建、Git 存储、GitLab Pages 等。下面是一些常用配置选项的详细说明:
1. 外部 URL 配置
external_url 'http://gitlab.example.com'
该选项配置 GitLab 的外部 URL,即 GitLab 的访问地址。例如,如果您的 GitLab 安装在 http://gitlab.example.com,那么您需要设置该选项为 'http://gitlab.example.com'。
2. SMTP 邮件设置
gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = "smtp.gmail.com"
gitlab_rails['smtp_port'] = 587
gitlab_rails['smtp_user_name'] = "username@gmail.com"
gitlab_rails['smtp_password'] = "password"
gitlab_rails['smtp_domain'] = "smtp.gmail.com"
gitlab_rails['smtp_authentication'] = "login"
gitlab_rails['smtp_enable_starttls_auto'] = true
该选项配置 GitLab 发送邮件的 SMTP 服务器和认证信息。其中,smtp_enable 选项用于启用 SMTP 邮件功能,smtp_address 和 smtp_port 选项用于设置 SMTP 服务器的地址和端口号,smtp_user_name 和 smtp_password 选项用于设置 SMTP 认证用户名和密码,smtp_domain 选项用于设置 SMTP 域名,smtp_authentication 选项用于设置 SMTP 认证方式,smtp_enable_starttls_auto 选项用于启用 STARTTLS 加密。
3. LDAP 集成
gitlab_rails['ldap_enabled'] = true
gitlab_rails['ldap_servers'] = YAML.load <<-'EOS'
main: # 'main' 是您选择的标识符
label: 'LDAP'
host: 'ldap.example.com'
port: 389
uid: 'sAMAccountName'
bind_dn: 'CN=gitlabuser,OU=Users,DC=example,DC=com'
password: 'password'
encryption: 'plain' # "plain" 或 "ssl" 或 "start_tls"
verify_certificates: true
active_directory: true
allow_username_or_email_login: false
lowercase_usernames: false
EOS
该选项用于配置 GitLab 与 LDAP 目录集成。其中,ldap_enabled 选项用于启用 LDAP 集成,ldap_servers 选项用于配置 LDAP 服务器的连接参数,如 LDAP 服务器的地址、端口号、账号、密码、加密方式等。
4. 备份和恢复
gitlab_rails['backup_path'] = "/mnt/backups/gitlab"
gitlab_rails['backup_archive_permissions'] = 0644
gitlab_rails['backup_keep_time'] = 604800
gitlab_rails['backup_upload_connection'] = {
:provider => 'AWS',
:region => 'us-east-1',
:aws_access_key_id => 'AKIAKIAKIAKIAKIAKIA',
:aws_secret_access_key => '1234554321',
:bucket => 'gitlab-backups'
}
该选项用于配置 GitLab 的备份和恢复功能。其中,backup_path 选项用于设置备份文件的存储路径,backup_archive_permissions 选项用于设置备份文件的文件权限,backup_keep_time 选项用于设置备份文件的保留时间,backup_upload_connection 选项用于设置备份文件的上传目标,如 Amazon S3 云存储等。
5. CI/CD 构建
gitlab_ci['builds_directory'] = "/mnt/builds"
gitlab_ci['url'] = "http://gitlab.example.com/ci"
该选项用于配置 GitLab 的 CI/CD 构建功能。其中,builds_directory 选项用于设置构建文件的存储路径,url 选项用于设置 GitLab CI 的访问地址。
6. Git 存储
git_data_dir "/mnt/git-data"
该选项用于配置 Git 存储的路径。其中,git_data_dir 选项用于设置 Git 存储的根目录。
7. GitLab Pages
pages_external_url "http://gitlab.example.com"
gitlab_pages['access_control'] = true
该选项用于配置 GitLab Pages 功能。其中,pages_external_url 选项用于设置 GitLab Pages 的访问地址,access_control 选项用于启用 GitLab Pages 的访问控制和认证功能。
以上是 GitLab.rb 配置文件的常用选项,您可以根据需求进行配置。为了避免误操作,建议在修改配置文件之前备份原文件。
阅读全文