Gerrit快速安装手册

最新推荐文章于 2023-04-28 16:15:35 发布
最新推荐文章于 2023-04-28 16:15:35 发布
阅读量2.5k 收藏 7
点赞数 1
分类专栏： 版本控制 linux开发工具 文章标签： gerrit gerrit config apache2 e-mail
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shenwanjiang111/article/details/83386497
版权

0 目录

1 在 Ubuntu 16.04 上安装Gerrit

本文展示如何在Ubuntu 16.04上机器上安装Gerrit。

快速安装手册，可以参考Quick get started guide

详细的安装手册，可以参考Standalone Daemon Installation Guide.

其它参考文章：

（1） HowTo: Demo Gerrit server on AWS EC2 instance

1.1 准备工作

  1. 一台运行类Unix操作系统的服务器

  2. Java SE 实时运行环境，1.8及其以后的版本(如果没有，可以使用下面的方法安装)

    a. 安装依赖包：

     sudo apt-get install python-software-properties

    b. 添加仓库源：

     sudo add-apt-repository ppa:webupd8team/java

    c. 更新软件包列表：

     sudo apt-get update

    d. 安装java JDK：

     sudo apt-get install oracle-java-installer

    安装过程中需要接受协议：接受即可。

    e. 查看java版本，看看是否安装成功：

     java version "1.8.0_191"

  3. git

    gerrit用来操作git仓库。安装非常简单：

     sudo apt-get install git

    验证安装是否成功：

     git --version

  4. apache2

    gerrit反向代理时使用，安装：

     sudo apt-get install apache2

    验证：

     sudo /etc/init.d/apache2 start

  5. gerrit管理帐号(可选，使用独立账号配置gerrit)

    用来管理gerrit。

     sudo adduser gerrit
 sudo passwd gerrit

    并将gerrit加入sudo权限

     sudo vim /etc/sudoers

    添加下面一句：

     gerrit  ALL=(ALL:ALL) ALL

1.2 下载Gerrit

选择合适的Gerrit版本，进行下载。可用的Gerrit版本，可以参考Gerrit Code Review - Releases

本手册使用的版本是Gerrrit 2.15.2，下载命令是：

wget https://www.gerritcodereview.com/download/gerrit-2.14.2.war

如果想使用源代码进行安装，请参考Developer Setup。

1.3 安装和初始化Gerrit

命令行输入：

java -jar gerrit*.war init --batch --dev -d ~/gerrittest

参数解释：

1. --batch

    这个参数

运行完成后，命令行会显示下面这些信息：

Generating SSH host key ... rsa(simple)... done
Initialized /home/gerrit/gerrittest
Executing /home/gerrit/gerrittest/bin/gerrit.sh start
Starting Gerrit Code Review: OK

Starting Gerrit Code Review: OK，这条信息告知我们Gerrit服务正在运行。

1.4 使用Gerrit

  1. 更新监听的URL

把Gerrit监听的URL，从* 改为localhost，阻止外界与本服务链接。

git config --file ~/gerrittest/etc/gerrit.config httpd.listenUrl 'http://localhost:8080'

git config是gerrit的配置方法。

  1. 重启Gerrit服务

必须重新启动身份验证类型的Gerrit服务，监听URL的改变才能生效。

~/gerrittest/bin/gerrit.sh restart

~/gerrittest/就是安装时，指定的目录。

  1. 浏览Gerrit

到现在，已经完成了Gerrit的基本安装，可以通过打开浏览器，查看安装的结果：

http://localhost:8080

到目前为止，我们已经完成了一个本机上的简易Gerrit服务器。接下来，我们研究使用代理服务器，从远程服务器访问该Gerrit服务器。

2 反向代理

2.1 描述

Gerrit可以被配置在第3方web服务器下运行。这允许其它web服务器绑定到特权端口80(或用于SSL的443)。

2.2 Gerrit配置

确保'$site_path'/etc/gerrit.config有属性httpd.listenUrl，使用 'proxy-http://' 或'proxy-https://' 和一个自由端口号进行配置。如果在安装的时候，也就是’init’的时候，代理支持被使能，这里应该已经配置了。

[httpd]
    listenUrl = proxy-http://10.48.100.182:8081/ # started by the proxy; gerrit server ip and port

我的配置,位于'$site_path'/etc/gerrit.config：

[gerrit]
    basePath = git
    serverId = 45493128-5b74-44c5-a0ef-41e9b72fd239
    canonicalWebUrl = http://10.48.100.182:8081/  # gerrit server ip and port
[database]
    type = h2
    database = /home/gerrittest/gerrit/db/ReviewDB
[noteDb "changes"]
    disableReviewDb = true
    primaryStorage = note db
    read = true
    sequence = true
    write = true
[index]
    type = LUCENE
[auth]
    type = HTTP #DEVELOPMENT_BECOME_ANY_ACCOUNT # authenticated by http
[receive]
    enableSignedPush = false
[sendemail]
    smtpServer = localhost
[container]
    user = gerrittest
    javaHome = /usr/lib/jvm/java-8-oracle/jre
[sshd]
    listenAddress = *:29418
[httpd]
    listenUrl = proxy-http://10.48.100.182:8081/ # started by the proxy
[cache]
    directory = cache
[plugins]
    allowRemoteAdmin = true

2.3 HTTP身份验证

参考文档:
Gerrit Code Review - 配置

使用HTTP身份验证时，Gerrit假定servlet容器或前端Web服务器在将请求交给Gerrit之前已执行了所有用户身份验证。

基于这个假设，Gerrit可以假设所有请求都已经过身份验证。因此， login 和 logout 不会显示在Web UI中。

使能HTTP身份验证：

git config --file $site_path/etc/gerrit.config auth.type HTTP
git config --file $site_path/etc/gerrit.config --unset auth.httpHeader
git config --file $site_path/etc/gerrit.config auth.emailFormat '{0}@example.com'

  • auth.type

    默认是OpenID，所以，这里需要根据所需进行设置。下面是一些常用的设置项：

    • HTTP

      Gerrit依赖于HTTP请求中提供的数据。这包括HTTP基本身份验证或某些类型的商业单点登录解决方案。 启用此设置后，身份验证必须在Web服务器或servlet容器中进行，而不是在Gerrit中进行。

    • HTTP_LDAP

      完全像上面的HTTP，但是还要根据从LDAP中用户的账户对象中获得的信息，预填充用户的全名和电子邮件地址。 用户的组成员关系也从LDAP中提取，使用户所属的任何LDAP组成为Gerrit的组。

    • LDAP

      Gerrit提示用户输入一个用户名和密码，然后通过与配置的ldap.server进行简单的绑定来验证用户名和密码。 使用此配置，web服务器不会涉及到用户身份验证。

      LDAP简单绑定请求中使用的实际用户名是帐户的完整DN，通过首先使用匿名请求或配置的ldap.username标识查询目录来发现该用户名。 如果将ldap.authentication设置为GSSAPI，Gerrit也可以使用kerberos。

    • LDAP_BIND

      Gerrit提示用户输入一个用户名和密码，然后通过与配置的ldap.server进行简单的绑定来验证用户名和密码。 使用此配置，web服务器不会涉及到用户身份验证。

      与LDAP不同的是，LDAP简单绑定请求中所使用的用户名就是用户在对话框中填入的真实字符串。不会使用ldap.username设置的标识中获取账户的信息。

    • DEVELOPMENT_BECOME_ANY_ACCOUNT

      不要使用！！！，仅在开发阶段的时候使用。不需要任何登录信息。

  • auth.httpHeader

    必须是unset。如果设置为任何值（包括Authorization），则Gerrit将无法正确遵循标准的Authorization HTTP标头。

  • auth.loginUrl

    在最终用户点击右上角的登录链接后，将浏览器重定向到的URL。 仅在auth.type设置为HTTP或HTTP_LDAP时使用。 使用企业单点登录解决方案的组织可能希望将浏览器重定向到SSO产品的登录页面，以完成登录过程并验证其凭据。

    如果设置，Gerrit允许匿名访问，直到最终用户执行登录并通过HTTP标头提供受信任的身份。 如果未设置，Gerrit需要具有受信任标识的HTTP标头，并返回错误页面“LoginRedirect.html”（如果此标头不存在）。

2.4 Apache2配置

需要使能必要的Apache2模块：

a2enmod proxy_http
a2dissite 000-default
a2enmod ssl          ; # 可选，HTTPS或SSL需要

使用上面的'http://'URL设置’ProxyPass’行。 保证ProxyPass 和 httpd.listenUrl 匹配，或者能够重定向到正确的地址。

我的设置，位于/etc/apache2/sites-available/gerrit.conf，在/etc/apache2/sites-enabled/目录下有其链接文件。

<VirtualHost *:8080>
    ServerName 10.48.100.182
    ProxyRequests Off
    ProxyVia Off
    ProxyPreserveHost On
    <Proxy *>
        Require all granted # >= apache2 2.6 required
    </Proxy>

    <Location "/">
        AuthType Basic
        AuthName "Gerrit Code Review"
        Require valid-user
    AuthBasicProvider file
        AuthUserFile /etc/apache2/passwords
    </Location>

    AllowEncodedSlashes On
    ProxyPass /  http://10.48.100.182:8081/ nocanon
    ProxyPassReverse / http://10.48.100.182:8081/ nocanon

    ErrorLog /var/log/apache2/gerrit.error.log
    CustomLog /var/log/apache2/gerrit.access.log combined
</VirtualHost>

2选项'AllowEncodedSlashes On'和'ProxyPass .. nocanon'在Gerrit 2.6及以后版本必须有。

使能配置的网站命令：

sudo a2ensite gerrit

注意： 要记得编辑文件/etc/apache2/ports.conf，将监听端口改为listen 8080。

2.5 设置第一个 Gerrit 用户的帐号和密码

$ sudo touch /etc/apache2/passwords
$ sudo htpasswd -b /etc/apache2/passwords admin 123456 # administrator
$ sudo htpasswd -b /etc/apache2/passwords gerrit1 123456 # general usr

htpasswd命令是 apache2-utils软件包中的一个工具。如果系统中还没有安装的话，通过如下命令进行安装：

$ sudo apt-get install apache2-utils

后续再添加 Gerrit 用户可使用 htpasswd -b /etc/apache2/passwords UserName PassWord)。如果要创建一组授权用户， 则可以使用下面的命令：

for i in $(seq 1 30); do echo user$i | sudo htpasswd -i /etc/apache2/passwords user$i; done

对于 Gerrit 来说，第一个成功登录的用户具有特殊意义-它会直接被赋予管理员权限。对于第一个账户，需要特别注意一下。

2.6 启动gerrit&启动apache2

sudo ~/gerrittest/bin/gerrit.sh start
sudo /etc/init.d/apache2 start

3 SSH登录

3.1 生成SSH key

首先查看的目录下是否已经具有id_rsa 和 id_rsa.pub两个文件。

生成SSH key：

ssh-keygen -t rsa

3.2 设置Gerrit服务端SSH Key

查看ssh key：

cat ~/.ssh/id_rsa.pub

结果：

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmXV/aXLZ+orq37Yr+0rmw43xk2Cfd8qEhJ9dpdLM9vX/2BglvUH4DFNyevpvQHUmmZpXvtlhpjuJuD2tt5pzGY7ZtmDRwOXCvmkNwXG/nbREUoeWctHT1KUbArPCrxByEdW2VPNk3yrFk2ZTBio7GhHPl8Pzhi0kzJvBQulK0U77ywTZwpmaZz0SiDiwHCAoCv/VyDCVpLCzLB48yUnNpaxaujAhf19q7jrqWHWaV8UFAv9vD+eET/sB1EIVaNm3ymiRuQtSyranVm4aV2hXdFpDxvN4qQGI160cI9V+EeGXlz8zqgL2/KE6ykhnFzDQU6tFsClHGJ89AD7K5tEcj gerrittest@tupelo-VirtualBox

添加sshkey到gerrit服务器(gerrit 服务端)。此步骤与git流程类似，即将id_rsa.pub内容上传到git仓库，gerrit中帮我们管理git仓库

Gerrit_SSHKey_Paste_Setting

验证sshkey是否配置成功：

ssh gerrit1@[gerrit服务器的IP地址] -p 29418

如果不知道gerrit服务器的IP地址，可以使用下面的命令获取：

git config -f ~/gerrit_testsite/etc/gerrit.config gerrit.canonicalWebUrl

4 使用gerrit

4.1 添加项目

  1. 使用gerrit添加新项目：（适用于开启新项目并使用gerrit）

     ssh -p 29418 gerrit1@[服务器的IP地址] gerrit create-project --empty-commit --name demo-project

或者使用gerrit管理界面(推荐)

gerrit_create_new_project

  1. 使用gerrit添加已有项目：（适用于已有项目下移植到gerrit中）

     ssh -p 29418 gerrit1@[服务器的IP地址] gerrit create-project --name exist-project

或者使用gerrit管理界面(推荐)

gerrit_create_exist_project

然后将已有项目与gerrit上建立的exist-project关联，即将已有代码库代码push到gerrit中进行管理。

cd ~/gitcode/exist-project
git push ssh://gerrit1@[服务器的IP地址]:29418/exist-project *:*

4.2 修改并push到gerrit服务器

  1. pull代码及配置git hooks(git client)

     git clone ssh://gerrit1@[服务器的IP地址]:29418/demo-project

  2. 更新git hooks

     gitdir=$(git rev-parse --git-dir); scp -p -P 29418 gerrit1@[服务器的IP地址]:hooks/commit-msg ${gitdir}/hooks/

    该过程用来在commit-msg中加入change-id，gerrit流程必备。

  3. push 改动到远程服务器

     cd ~/demo-project
 date > testfile.txt
 git add testfile.txt
 git commit -m "My pretty test commit"
 git push origin HEAD:refs/for/master

    这里有可能报错：

     remote: Processing changes: refs: 1, done
 remote:
 remote: ERROR:  In commit 4732b67cac5f3e7d406c5ef5eeef63716c541b85
 remote: ERROR:  committer email address shenwanjiang2013@163.com
 remote: ERROR:  does not match your user account and you have no 'forge committer' permission.
 remote: ERROR:
 remote: ERROR:  You have not registered any email addresses.
 remote: ERROR:
 remote: ERROR:  To register an email address, please visit:
 remote: ERROR:  http://10.48.100.182:8081/#/settings/contact
 remote:
 remote:
 To ssh://gerrit1@10.48.100.182:29418/demo-project
  ! [remote rejected] HEAD -> refs/for/master (invalid committer)
 error: 无法推送一些引用到 'ssh://gerrit1@10.48.100.182:29418/demo-project'

    push代码时需要commit email与gerrit account email一致，否则无法push成功，可选择关闭email notify，并开启forge user权限，或者通过修改gerrit数据库account email信息

    修改Gerrit的配置文件gerrit.config和secure.config，内容分别如下:

    • gerrit.config：

      [sendemail]
      enable = true
      smtpServer = smtp.163.com
      smtpServerPort = 465
      smtpEncryption = ssl
      smtpUser = 【你的邮箱账号】
      smtpPass = 【你的授权密码】
      sslVerify = false
      from = 【你的邮箱账号】

    • secure.config：

      [auth]
      registerEmailPrivateKey = ZIbpTyD12K8ZspVMsgkw5Tt0DkDL9FOlHV0=
      [sendemail]
      smtpPass = 【你的授权密码】

  4. 提交成功的结果：

     gerrittest@tupelo-VirtualBox:~/demo-test/demo-project$ date > testfile.txt
 gerrittest@tupelo-VirtualBox:~/demo-test/demo-project$ git add testfile.txt
 gerrittest@tupelo-VirtualBox:~/demo-test/demo-project$ git commit -m "My pretty test commit"
 [master a3c1973] My pretty test commit
  1 file changed, 1 insertion(+)
  create mode 100644 testfile.txt
 gerrittest@tupelo-VirtualBox:~/demo-test/demo-project$ git push origin HEAD:refs/for/master
 Enter passphrase for key '/home/gerrittest/.ssh/id_rsa':
 对象计数中: 3, 完成.
 写入对象中: 100% (3/3), 338 bytes | 0 bytes/s, 完成.
 Total 3 (delta 0), reused 0 (delta 0)
 remote: Processing changes: new: 1, done
 remote:
 remote: New Changes:
 remote:   http://10.48.100.182:8081/#/c/demo-project/+/21 My pretty test commit
 remote:
 To ssh://gerrit1@10.48.100.182:29418/demo-project
  + [new branch]      HEAD -> refs/for/master

4.3 完成review并merge

使用gerrit website完成code review

a. 当完成push后，可在gerrit管理界面看到当前提交code review的change。

Gerrit_check_commit_result

b. 添加reviewers

gerrit_push_result_add_reviewer

c. 结果

gerrit_push_result_after_add_reviewer

d. 以下是Reviewer的账户，可以看到收到的Review请求：

gerrit_reviewer_check

e. 点击请求，进入其中，

gerrit_reviewer_do_review

f. 完成Review并提交代码：

gerrit_reviewer_complete_review

5 gerrit权限控制

在gerrit中权限控制是基于群组的. 每个用户有一个或者多个群组, 访问权限被赋予这些群组.访问权限不能赋予个人用户.

  1. System Groups

在Gerrit系统自带下面的群组

  • Anonymous Users
  • Change Owner
  • Project Owners
  • Registered Users
  1. Anonymous Users

所有用户都是匿名用户成员, 所有用户都能继承Anonymous Users所有访问权限.
当前只有Read access权限值得赋予给Anonymous Users群组, 因为其他权限都需要认证.

  1. Project Owners

Project Owners的访问权限在Project范围内有效

  1. Change Owner

Change Owner的访问权限在Change范围内有效

  1. Registered Users

所有在页面上登录成功的用户都会自动注册为gerrit用户，属于Registered Users群组
Registered Users群组通常被赋予Code-Review -1…+1权限, 允许给需要审查代码投票, 但不会引起审查被批准和拒绝

tupelo-shen
关注
  • 1
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
gerrit使用文档手册，适合新手学习gerrit
04-13
Skyworth Gerrit 客户端使用手册提供了 Skyworth Gerrit 客户端的使用指南，包括安装、配置、使用等方面的内容。 总结 Gerrit 使用文档手册提供了 Gerrit 的使用指南，包括获取权限、配置环境、获取代码、开发和...
Gerrit工作流程及使用手册
01-27
好不容易在google上找了一篇相对简单明了的介绍gerrit工作流程的图： 使用过git的同学，都知道，当我们gitadd-->gitcommit--> gitpush之后，你的代码会被直接提交到repo，也就是代码仓库中，就是图中橘红色...
代码评审平台Gerrit安装配置方法介绍
测试开发小记
04-28 3591
Gerrit代码审查工具也是一个Git服务器，使用Git作为底层版本控制系统，当前的版本使用Java开发。一个典型的Git项目包含一个远程中央仓库，Gerrit在Git中央仓库基础上引入了一个额外的概念:存储修改的暂存区，push的代码更改会被存储到暂存区（Pending changes），其他人评审通过后就可以将更改提交到代码库 (Authoritative Repository)。下面介绍如何安装部署gerrit。
代码审查软件 Gerrit的安装教程
Nicolege678的博客
06-02 2640
Gerrit，一种免费、开放源代码的代码审查软件，使用网页界面。利用网页浏览器，同一个团队的软件程序员可以相互审阅彼此修改后的程序代码，决定是否能够提交，退回或者继续修改。需要安装的环境有 java环境，nginx环境，数据库环境，数据库这里选择的是默认的H2 db。1. 安装jdk环境。 2、下载安装nginx。 （1）下载 nginx 安装包 （2）解压 nginx 安装包 （3）进入文件目录，执行“./configure”命令为编译做好准备； （4）执行“make”命令进
Gerrit的使用和常见错误
池塘
03-14 9674
邮件不符合错误 由于我的gerrit是内网，并且也没有内部邮件服务。 You have not registered any email addresses. gerrit下面直接修改mysql中的数据来修复这个错误： mysql> show databases -> ; +--------------------+ | Database | +---------
gerrit常见问题及解决方法
zyfzhangyafei的专栏
10-10 5346
1、 git：'interpret-trailers' 不是一个 git 命令。参见 'git --help'。 cannot insert change-id line in .git/COMMIT_EDITMSG 解决方法： 升级git 版本 sudo add-apt-repository ppa:git-core/ppa # 向 PPA 中添加 git 的软件源 sudo apt-get update sudo apt-get install git 2、 git push ...
gerrit install
weixin_34200628的博客
06-23 82
server os 這邊其實可以有好幾個方案，一个是直接安装ESXI,然后去install各种版本，各部分的OS。但是因为当前的机器内存不足，所以我这边直接安装了OS[root@rsgit ~]# uname -aLinux rsgit 4.5.6-200.fc23.x86_64 #1 SMP Wed Jun 1 21:28:20 UTC 2016 x86_64 x86_64...
gerrit搭建手册.docx
05-08
在搭建Gerrit之前，我们需要进行一系列的系统配置和软件安装。以下是对文档内容的详细解析： 1. **系统安装**： - 系统平台：CentOS 7.5 - 系统版本：CentOS 1805 - 语言选择：简体中文 - 软件选择：选择带GUI...
Gerrit 开发人员手册
08-28
Gerrit 开发人员手册提供了详细的安装、配置和使用 Gerrit 的指南，涵盖了 Git 客户端的安装、密钥对的生成、EGit 的配置、Git 配置、登录 Gerrit、从 Gerrit 上 Clone 仓库、Commit 变更、Push 到 Gerrit、Egit ...
Gerrit lfs安装及配置
最新发布
04-26
Gerrit lfs安装及配置
Gerrit教程
10-22
Gerrit教程，Qt_Developer_Network_Wiki__Gerrit_Introduction_.pdf
gerrit-2.11.2安装包
08-03
gerrit安装包 因为google被墙了，所以这里放一个gerrit的新版安装包 有需要的就下载吧
gerrit 安装文件
02-25
google 提供的最新的gerrit-2.13.war 文件。国外直接下载后分享
gerrit操作手册
06-08
* 在gerrit安装目录下的etc目录中执行htpasswd -dhtpasswd.conf admin命令，生成登录用户验证文件htpasswd.conf，其中admin为登录用户名。 4. 验证登录 * 直接访问http://172.16.1.123:8081，如果出现如图所示的...
ldap+gerrit详细安装视频讲解
04-06
此视频详细讲解了ldap服务器和gerrit服务器的安装流程，以及对gerrit进行ldap认证配置也进行详细的讲解。
CentOS 7.x安装部署Gerrit完整教程
ll535299的博客
07-06 1722
本文介绍基于CentOS 7.x 搭建Gerrit服务
centos7.0安装部署Gerrit详解
it-wangxiaobai的博客
11-24 1013
.Gerrit是一个建立在Git版本控制系统之上并且基于Web的代码审查工具，是开发者和Git之间的一层屏障，不允许直接将本地修改内容同步到远程仓库中。Gerrit可以和Jenkins进行集成，每次代码提交后，在人工审核代码前，通过Jenkins任务自动运行单元测试、构建以及自动化测试。Jenkins任务如果失败，会自动大会这次提交。
ubuntu20.04 + gerrit3.1.3 + nginx
weixin_46557083的博客
03-10 5524
一.相关环境部署 sudo apt-get install openjdk-11-jdk openjdk-11-jre git nginx 二.配置nginx 不装nginx也不影响gerrit启动，以下操作可跳过 1. 开防火墙 sudo ufw app list sudo ufw allow ‘Nginx HTTP’ 按情况开启 sudo ufw status 2. nginx相关命令 sudo systemctl status nginx 查看nginx状态 sudo systemctl stop
ubuntu 搭建gerrit服务器
zyfzhangyafei的专栏
09-27 1650
https://www.cnblogs.com/eastnapoleon/p/6497802.html

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值