Gitlab Server
Installation
With Docker
mkdir /mygitlab
docker run --detach \
--hostname mygit.example.com\
--publish 80:80 \
--name gitlab \
--restart always \
--volume /mygitlab/config:/etc/gitlab \
--volume /mygitlab/logs:/var/log/gitlab \
--volume /mygitlab/data:/var/opt/gitlab \
--privileged \
gitlab/gitlab-ce:17.11.7-ce.0
Config
- 主設定檔:
/etc/gitlab/gitlab.rb
Custom port
1- docker command
- 使用非標準埠時,host 與 container 必須使用相同埠號。
- 如果只修改 docker 啟動參數的外部 port,而不修改 gitlab.rb,服務可以正常啟動,首頁與帳號登入也正常,不過網頁上的專案 URL 位址會不正確。
docker run --detach \
--hostname 10.4.1.76 \
--publish 6080:6080 \
--name gitlab \
--volume /myapp/gitlab/config:/etc/gitlab \
--volume /myapp/gitlab/logs:/var/log/gitlab \
--volume /myapp/gitlab/data:/var/opt/gitlab \
...
2- Edit gitlab.rb
- 變更 port 會影響 container 的通訊埠,且必須與 docker 啟動參數的內部 port 相同。
nginx['listen_port'] = 6080
external_url 'http://10.4.1.76:6080'
gitlab-ctl commands
# Check the services
> gitlab-ctl status
run: alertmanager: (pid 820) 3073s; run: log: (pid 619) 3108s
run: gitaly: (pid 291) 3170s; run: log: (pid 309) 3169s
run: gitlab-exporter: (pid 799) 3075s; run: log: (pid 567) 3126s
run: gitlab-kas: (pid 452) 3158s; run: log: (pid 464) 3155s
run: gitlab-workhorse: (pid 791) 3075s; run: log: (pid 513) 3138s
run: logrotate: (pid 260) 3182s; run: log: (pid 268) 3181s
run: nginx: (pid 540) 3133s; run: log: (pid 550) 3132s
run: postgres-exporter: (pid 828) 3073s; run: log: (pid 738) 3100s
run: postgresql: (pid 316) 3164s; run: log: (pid 449) 3161s
run: prometheus: (pid 809) 3074s; run: log: (pid 606) 3112s
run: puma: (pid 467) 3152s; run: log: (pid 475) 3148s
run: redis: (pid 272) 3176s; run: log: (pid 288) 3173s
run: redis-exporter: (pid 801) 3074s; run: log: (pid 588) 3120s
run: sidekiq: (pid 479) 3145s; run: log: (pid 488) 3144s
run: sshd: (pid 36) 3192s; run: log: (pid 35) 3192s
> gitlab-ctl status postgresql
run: postgresql: (pid 316) 3748s; run: log: (pid 449) 3745s
# Reload the configuration
> gitlab-ctl reconfigure
# Restart the service puma
> gitlab-ctl restart puma
# Restart all services
> gitlab-ctl restart
Backup & Restore
With Docker
- 備份檔 (
編號_日期_版本_gitlab_backup.tar) 要先複製到 container 的目錄/var/opt/gitlab/backups(預設)
# Backup
docker exec -it <container-name> gitlab-backup create
# Backup DB only
docker exec -it <container-name> gitlab-backup create SKIP=artifacts,repositories,registry,uploads,builds,pages,lfs,packages,terraform_state
# Verify the backup file
docker exec -it <container-name> ls /var/opt/gitlab/backups
# Restore
docker exec -it <container-name> bash
> gitlab-ctl stop puma
> gitlab-ctl stop sidekiq
> gitlab-ctl status
> gitlab-backup restore BACKUP=1704810663_2024_01_09_17.11.1
# Restore DB only
> gitlab-backup restore BACKUP=1704810663_2024_01_09_17.11.1 SKIP=artifacts,repositories,registry,uploads,builds,pages,lfs,packages,terraform_state
> gitlab-ctl restart
> gitlab-rake gitlab:check SANITIZE=true
> gitlab-rake gitlab:artifacts:check
> gitlab-rake gitlab:lfs:check
> gitlab-rake gitlab:uploads:check
# Restart the container
docker restart <container-name>
Upgrade & Patch
- Upgrade 17.11 to 18: https://docs.gitlab.com/update/versions/gitlab_18_changes/
Pre-upgrade and post-upgrade checks
1- Check the general configuration:
# With Docker
docker exec -it <container-name> gitlab-rake gitlab:check | tee mylogs/check.250916.out
2- Confirm that encrypted database values can be decrypted:
如果出現任何 failures 將會影響 Gitlab 的管理功能,請確定 gitlab-secrets.json 是最初的那一個,檔案內含相關的密鑰,如果遺失,雖然系統回復完成後,一般用戶可以正常 pull/push 專案,但管理員將沒有權限操作部分的管理功能。但管理員將沒有權限操作大部分的管理功能。
# With Docker
docker exec -it <container-name> gitlab-rake gitlab:doctor:secrets | tee mylogs/doctor_secrets.250916.out
3- Check the status of all background database migrations.
gitlab-psql -c "SELECT job_class_name, table_name, column_name, job_arguments FROM batched_background_migrations WHERE status NOT IN(3, 6);"
# With Docker
docker exec -it <container-name> gitlab-psql -c "SELECT job_class_name, table_name, column_name, job_arguments FROM batched_background_migrations WHERE status NOT IN(3, 6);"
4- In GitLab UI, check that:
- Users can sign in.
- The project list is visible.
- Project issues and merge requests are accessible.
- Users can clone repositories from GitLab.
- Users can push commits to GitLab.
Post-installation
Disable Gravatar Service (optional)
Enter Admin Mode > Settings > General > Account and limit
- Gravatar enabled: 不勾選
Troubleshooting
HTTP 502
- 記憶體至少需要 4GB,如果不足可能無法初始化所有服務。
- 通訊埠衝突,檢查 host 與 container 是否有相同 port 衝突。Gitlab 內建多個服務,啟動會開啟相應的 port,例如 puma 預設使用 8080。要檢查不同內建服務的預設 port 號,可以檢視
gitlab.rb。