您现在的位置是:首页 >学无止境 >Docker搭建配置Gitlab网站首页学无止境

Docker搭建配置Gitlab

西木Qi 2023-06-28 20:00:03
简介Docker搭建配置Gitlab

1 参考文档

参考1:Gitlab 仓库搭建(详细版)
参考2:搭建 gitlab 私有仓库

2 Gitlab相关介绍

2.1 Gitlab

Gitlab是一个用于仓库管理系统的开源项目,使用Git作为代码管理工具,并在此基础上搭建起来的web服务。Gitlab有乌克兰程序员DmitriyZaporozhetsValerySizov开发,它由Ruby写成。后来,一些部分用Go语言重写,现今并在国内外大中型互联网公司广泛使用。gitlab-ce是它的社区版gitlab-ee是企业版,是收费的

2.2 Git和SVN的区别

Git是一个开源的分布式版本控制系统,用于敏捷高效地处理任何或小或大的项目。Git 是 Linus Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。

它没有中央服务器,每个人的电脑就是一个完整的版本库,这样工作的时候就不需要联网了,因为版本都是在自己的电脑上。既然每个人的电脑都有一个完整的版本库,那多个人如何协作呢?比如说自己在电脑上改了文件A,其他人也在电脑上改了文件A,这时,你们两之间只需把各自的修改推送给对方,就可以互相看到对方的修改了。

SVN:是一个开放源代码的版本控制系统,通过采用分支管理系统的高效管理,简而言之就是用于多个人共同开发同一个项目,实现共享资源,实现最终集中式的管理。集中管理方式在一定程度上看到其他开发人员在干什么,而管理员也可以很轻松掌握每个人的开发权限。

但是相较于其优点而言,集中式版本控制工具缺点很明显:

  • 服务器单点故障
  • 容错性差

2.3 Git、Gitlab、GitHub的简单区别

  1. Git是一种基于命令的版本控制系统,全命令操作,没有可视化界面。
  2. Gitlab是一个基于Git实现的在线代码仓库软件,提供web可视化管理界面,通常用于企业团队内部协作开发。
  3. Github是一个基于Git实现的在线代码托管仓库,亦提供可视化管理界面,同时免费账户和提供付费账户,提供开放和私有的仓库,大部分的开源项目都选择Github作为代码托管仓库。

GitlabGitHub的区别

相同点:

  • 二者都是基于web的Git仓库,在很大程度上Gitlab是仿照GitHub来做的;
  • 它们都提供了分享开源项目的平台,为开发团队提供了存储、分享、发布和合作开发项目的中心化云存储的场所。

不同点:

  • GitHub如果要使用私有仓库,是需要付费的【现已免费】。Gitlab可以在上面创建私人的免费仓库。

Gitlab可以让开发团队对他们的代码仓库拥有更多的控制,相比于GitHub,它有不少的特色:

  • 允许免费设置仓库权限;
  • 允许用户选择分享一个project的部分代码;
  • 允许用户设置project的获取权限,进一步的提升安全性;
  • 可以设置获取到团队整体的改进进度;
  • 通过innersourceing让不在权限范围内的人访问不到该资源。
  • 从代码私有性方面来看有时公司并不希望员工获取到全部的代码,这个时候Gitlab无疑是更好的选择。但是对于开源项目而言,GitHub依然是代码托管的首选。

3 搭建Gitlab仓库

使用docker方式安装配置Gitlab。前面2.1介绍了gitlab-ceGitlab的社区版,所以安装也是以gitlab-ce为准。

3.1 拉取镜像

docker pull gitlab/gitlab-ce

3.2 启动容器

docker run -itd  
 -p 9980:80 
 -p 9922:22 
 -v /opt/soft/docker/gitlab/etc:/etc/gitlab  
 -v /opt/soft/docker/gitlab/log:/var/log/gitlab 
 -v /opt/soft/docker/gitlab/opt:/var/opt/gitlab 
 --restart always 
 --privileged=true 
 --name gitlab 
 gitlab/gitlab-ce

命令解释:

-i	 以交互模式运行容器,通常与 -t 同时使用命令解释
-t	 为容器重新分配一个伪输入终端,通常与 -i 同时使用
-d	 后台运行容器,并返回容器ID
-p 9980:80	将容器内80端口映射至宿主机9980端口,这是访问gitlab的端口
-p 9922:22	将容器内22端口映射至宿主机9922端口,这是访问ssh的端口
-v /opt/soft/docker/gitlab/etc:/etc/gitlab	将容器/etc/gitlab目录挂载到宿主机/opt/soft/docker/gitlab/etc目录下,若宿主机内此目录不存在将会自动创建,其他两个挂载同这个一样
--restart always	容器自启动
--privileged=true	让容器获取宿主机root权限
--name gitlab	设置容器名称为gitlab
gitlab/gitlab-ce	镜像的名称,这里也可以写镜像ID

3.3 修改配置文件

以下操作均在容器中执行

  1. 进入容器
docker exec -it gitlab /bin/bash
  1. 修改配置文件
vi /etc/gitlab/gitlab.rb

在开头加入一下内容:

#gitlab访问地址,可以写域名。如果端口不写的话默认为80端口
external_url 'http://192.168.254.220'
#ssh主机ip
gitlab_rails['gitlab_ssh_host'] = '192.168.254.220'
#ssh连接端口
gitlab_rails['gitlab_shell_ssh_port'] = 9922
#时区
gitlab_rails['time_zone'] = 'Asia/Shanghai'
#开启备份功能
gitlab_rails['manage_backup_path'] = true
#备份文件的权限
gitlab_rails['backup_archive_permissions'] = 0644
#保存备份 180 天
gitlab_rails['backup_keep_time'] = 15552000

在这里插入图片描述

  1. 让配置生效
gitlab-ctl reconfigure

输入命令后,会执行一系列操作,直到最后出现:gitlab Reconfigured!

  1. 修改gitlab.yaml 文件
vi /opt/gitlab/embedded/service/gitlab-rails/config/gitlab.yml

默认为80端口,修改端口号为之前配置的端口
在这里插入图片描述
5. 重启gitlab服务

gitlab-ctl restart
  1. 退出容器
exit
  1. 开放服务器端口
firewall-cmd --zone=public --add-port=9980/tcp --permanent
firewall-cmd --zone=public --add-port=9922/tcp --permanent
  1. 重启防火墙
firewall-cmd --reload
  1. 查询有哪些端口是开启的
firewall-cmd --list-port

4 管理员登录Gitlab

  1. 查找管理员(root)的密码,进入容器
docker exec -it gitlab /bin/bash
  1. 查看初始密码
cat /etc/gitlab/initial_root_password

在这里插入图片描述

  1. 登录
    账号:root
    密码:【上一步查看的密码】

  2. 修改超级管理员的密码
    在这里插入图片描述

  3. 关闭用户自动注册功能
    以root权限登录,在Gitlab的主菜单上,选择Menu—》Admin,如下所示:
    在这里插入图片描述
    之后,选择Settings—》General—》Sign-up restrictions,点击右边的Expand,如下所示:
    在这里插入图片描述
    在弹出的页面中,取消掉Sign-up enabled选项前面的勾,然后点击底部的Save changes后,就可以使得我们的配置生效了。这样在登录的时候,就无法实现自动注册了。如下所示:
    在这里插入图片描述

5 Gitlab配置邮箱

邮箱是企业进行工作中的通知,交互必不可少的部分,gitlab同样支持邮箱的配置,方便对一些操作有邮件的提醒。

  1. 开启smtp功能
    去邮箱的提供商开启SMTP服务。

注意事项:一定要搞清楚邮件服务的端口到底是哪个,不然配置完后测试邮件发送会提示链接超时,也可以在docker部署的gitlab容器内 telnet IP 端口 来判断邮箱的地址和端口是否正确,如果正确则不报错,后面也会给出具体的配置。

QQ邮箱SMTP 服务器地址及端口
在这里插入图片描述


163邮箱SMTP 服务器地址及端口
在这里插入图片描述


  1. 进入gitlab容器内部修改配置
docker exec -it gitlab /bin/bash

建议先在容器内 telnet IP 端口 来确定邮件的SMTP服务能否链接上。

  1. 修改配置文件
vi /etc/gitlab/gitlab.rb

QQ邮箱:【注意端口】推荐,因为163邮箱可能会出现telnet端口不到的问题。

gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = 'smtp.qq.com'
gitlab_rails['smtp_port'] = 587
gitlab_rails['smtp_user_name'] = '发件邮箱'
gitlab_rails['smtp_password'] = '第三方登录授权码'
gitlab_rails['smtp_domain'] = 'smtp.qq.com'
gitlab_rails['smtp_authentication'] = 'login'
gitlab_rails['smtp_enable_starttls_auto'] = true
gitlab_rails['smtp_tls'] = false
gitlab_rails['smtp_pool'] = '发件邮箱'

gitlab_rails['gitlab_email_enabled'] = true
gitlab_rails['gitlab_email_from'] = '发件邮箱'
# gitlab_rails['gitlab_email_display_name'] = 'Example'

163邮箱:【注意端口】

gitlab_rails['smtp_enable'] = true
gitlab_rails['smtp_address'] = 'smtp.163.com'
gitlab_rails['smtp_port'] = 25
gitlab_rails['smtp_user_name'] = '发件邮箱'
gitlab_rails['smtp_password'] = '第三方登录授权码'
gitlab_rails['smtp_domain'] = 'smtp.163.com'
gitlab_rails['smtp_authentication'] = 'login'
gitlab_rails['smtp_enable_starttls_auto'] = true
gitlab_rails['smtp_tls'] = false
gitlab_rails['smtp_pool'] = '发件邮箱'

gitlab_rails['gitlab_email_enabled'] = true
gitlab_rails['gitlab_email_from'] = '发件邮箱'
# gitlab_rails['gitlab_email_display_name'] = 'Example'

以上两个厂商的邮箱配置已验证,可用。

  1. 更新配置文件
gitlab-ctl reconfigure
gitlab-ctl restart
  1. 测试
    执行 gitlab-rails console进入控制台交互界面,然后在控制台提示符后输入下面内容发送一封测试邮件,测试完成后exit()退出。
gitlab-rails console
# 示例
Notify.test_email('229xxxx@qq.com', 'GitLab email', 'Hellow world').deliver_now

在这里插入图片描述

6 创建组

Gitlab上创建项目时,由于新项目的创建必须依赖于一个组,因此,我们在创建项目前,先创建组。
进入Gitlab主页面后,点击Overview中的Groups选项,然后点击右边的New group,选择新创建一个组,如下所示:
在这里插入图片描述
输入组的名称和描述,组的URL会随着组名称的输入而自动出现,在组的权限处,我们选择Private,并取消掉下方允许用户访问的请求,配置完成后如下所示:

在这里插入图片描述
点击最下方的Create Group,就可以完成组的创建了。

7 创建项目

项目的创建与组的创建过程类似,都是输入项目名称,选择组的名称,项目描述以及权限等。

建议直接在组下创建项目,有三种方式:创建空项目、根据模板创建、从其他代码仓库迁移,根据个人情况选择:
在这里插入图片描述

8 创建用户

  1. 在首页找到管理员,如图所示:
    在这里插入图片描述
  2. 点击小人图标
    在这里插入图片描述
  3. 找到Users,创建用户:
    在这里插入图片描述
  4. 填写相关信息
    注意:需要填写一下email,用于给被创建用户发送初始登录密码。
    在这里插入图片描述

9 Gitlab 数据备份【这块待实践】

9.1 手动备份

  1. 进入Gitlab容器内部
docker exec -it gitlab /bin/bash
  1. 执行备份命令
    使用一条命令即可创建完整的Gitlab备份。
gitlab-rake gitlab:backup:create

使用命令会在/var/opt/gitlab/backups目录下创建一个压缩包,这个压缩包就是Gitlab整个的完整部分。
在这里插入图片描述

9.2 更改Gitlab备份目录

可以通过/etc/gitlab/gitlab.rb配置文件来修改默认存放备份文件的目录。

vi /etc/gitlab/gitlab.rb
#指定备份后数据存放的路径、权限、时间配置
gitlab_rails['manage_backup_path'] = true              开启备份功能
gitlab_rails['backup_path'] = "/home/gitlab-backup"        指定备份的路径
gitlab_rails['backup_archive_permissions'] = 0644        备份文件的权限
gitlab_rails['backup_keep_time'] = 15552000             备份保留时间【180天】

修改完成之后使用下面命令重载配置文件即可。

gitlab-ctl reconfigure

9.3 自动定时备份

实现每天1点、13点各进行一次自动备份,通过crontab使用备份命令实现,需重启cron服务。

方法1:输入:crontab -e然后添加相应的任务。

附录1 GitLab常用命令汇总

#查看服务状态
gitlab-ctl status
使用控制台实时查看日志
# 查看所有的logs; 按 Ctrl-C 退出
gitlab-ctl tail
# 拉取/var/log/gitlab下子目录的日志
gitlab-ctl tail gitlab-rails
# 拉取某个指定的日志文件
gitlab-ctl tail nginx/gitlab_error.log
#启动关闭gitlab	
gitlab-ctl start      
gitlab-ctl stop                                #停止            
gitlab-ctl status                              #查看状态
gitlab-ctl restart                             #重启
gitlab-ctl reconfigure			   #更新配置文件
gitlab-ctl help                                #帮助
gitlab-rake gitlab:check SANITIZE=true --trace	检查gitlab
#gitlab 默认的日志文件存放在/var/log/gitlab 目录下
gitlab-ctl tail                                #查看所有日志
#禁止 Gitlab 开机自启动
systemctl disable gitlab-runsvdir.service 
#启用 Gitlab 开机自启动
systemctl enable gitlab-runsvdir.service

附录2 Git 命令行常用指令的使用

git status 	#上次提交后是否对文件再做了修改项目
git add . 		#添加所有的变动
git checkout -b 文件夹名称 		#创建本地分支并切换分支 git checkout -b pr/ffr
git commit -m “描述”			 #提交修改 git commit -m “修改什么”
git merge origin/develop “本地分支” 		#合并origin/develop上别人所做的修改到自己的本地分支 git merge origin/develop pr/ffr
git push origin “本地分支” #推送本地分支到远程,并建立联系 git push origin pr/ffr
git rebase -i 编号 #合并多次提交,将前几次的提交合并为一次
git checkout 分支名 #切换分支 git checkout pr/FFR-color git cherckout develop
git pull #更新当前分支的状态
git branch #列出本地分支
git branch -a #列出本地分支与远程分支
git branch -D 分支名 #删除分支(目前仅用于删除本地分支)
git remote -v #可以查看远程仓库信息
git branch 分支名 #仅仅创建 一个新分支,并不会自动切换到新分支中去
git rebase --abort #退出git rebase
git reset 提交编号 #git rebase -i 提交编号,之后出现错误,可以回退到之前未合并时的日志状态
git commit --amend -m “描述” #修改上一次的提交的描述
git stash #暂存上一次的修改,准备切换到其他的分支
git stash pop #还原上一次的修改,将暂存的修改加入到新的分支
风语者!平时喜欢研究各种技术,目前在从事后端开发工作,热爱生活、热爱工作。