1. 全栈程序员必看首页

opengrok搭建[通俗易懂]

全栈程序员-站长 • • 未分类 • 阅读 64

opengrok搭建[通俗易懂]前序OpenGrok是一个快速，便于使用的源码搜索引擎与对照引擎，它能够帮助我们快速的搜索、定位、对照代码树。一般常用于大型的项目中，比如Android系统源码。我也是刚来公司后才发现有这个东西的，在此自己也搭建一套，方便在家里也可以查看源码。因为是查看自己定制的系统源码所以要搭这个，如果只是查看AOSP的官方源码推荐一个网站：http://androidxref.com/环境OS：Debian

大家好，又见面了，我是你们的朋友全栈君。

前序

OpenGrok是一个快速，便于使用的源码搜索引擎与对照引擎，它能够帮助我们快速的搜索、定位、对照代码树。一般常用于大型的项目中，比如Android系统源码。
我也是刚来公司后才发现有这个东西的，在此自己也搭建一套，方便在家里也可以查看源码。因为是查看自己定制的系统源码所以要搭这个，如果只是查看AOSP的官方源码推荐一个网站：http://androidxref.com/

环境

OS：Debian 8/Ubuntu 14.04及以上
Web Server：tomcat8
JDK：openjdk-8
opengrok：0.12.1.6 (stable)

安装tomcat8

在这里为了简单化，直接使用系统内仓库进行安装了。
$ sudo apt-get install tomcat8

安装 openjdk-8

$ sudo apt-get install openjdk-8-jdk

安装opengrok

这个需要从github下载了。
在这里可以找到所有releases的版本
https://github.com/OpenGrok/OpenGrok/releases
我们使用最新的稳定版：0.12.1.6 (stable)
最好找一个分区空间较大的地方安装

$ wget https://github.com/OpenGrok/OpenGrok/files/467358/opengrok-0.12.1.6.tar.gz.zip

可能是为了减小体积吧，压缩了2次，所以我们也需要解压2次
$ unzip opengrok-0.12.1.6.tar.gz.zip
$ tar zxvf opengrok-0.12.1.6.tar.gz

配置opengrok

在oepngrok的安装目录中，也就是我们刚刚解压后的目录，新建src和data目录。
src目录用于存放源码的链接
data目录用于存放生成的索引文件。

创建源码链接

因为可能在下载opengrok之前就已经下好了android源码， 由于源码太大，复制和移动都不现实，所以我们可以使用软链接的方式。当然也可以在索引的时候指定源码路径，不过那样不便于管理，我不喜欢那样。以下是我的源码路径，可以根据自己的来进行修改。

$ ln -s /home/lu/Android-src/AOSP-6.0 ~/data/opengrok-0.12.1.6/src/AOSP-6.0
$ ln -s /home/lu/Android-src/cm13 ~/data/opengrok-0.12.1.6/src/cm13

配置tomcat8

opengrok 0.12.1.6版本默认是只识别tomcat6和7的，所以我们需要修改一下配置文件使其搜索tomcat8，当然了也可以直接安装tomcat7，不过在这里我使用的是tomcat8，所以必须要修改配置了。
编辑opengrok安装目录中的bin/OpenGrok文件：

$ vim ~/data/opengrok-0.12.1.6/bin/OpenGrok
找到/var/lib/tomcat7/webapps和/var/lib/tomcat7
将tomcat7改为tomcat8即可。

更简单的方式是直接使用sed命令批量改就行了
$ sed -i 's/tomcat7/tomcat8/g' ~/data/opengrok-0.12.1.6/bin/OpenGrok

配置opengrok实例路径

默认opengrok实例路径是/var/opengrok当第一次进行索引的时候会在改目录中生成配置文件和log文件。默认源码目录src和data索引文件也是要放置在这里的。为了方便起见我们也可以将其改为opengrok的安装目录下面。
编辑opengrok安装目录中的bin/OpenGrok文件：

$ vim ~/data/opengrok-0.12.1.6/bin/OpenGrok

找到如下内容
OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
将其改为
OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/home/lu/data/opengrok-0.12.1.6}"
即可

索引项目

opengrok已经配置完了。要对项目进行索引，我们还需要一个工具Exuberant Ctags。

安装Exuberant Ctags

$ sudo apt-get install exuberant-ctags

开始索引

进入opengrok的安装目录，执行以下命令即可开始索引：

$ bin/OpenGrok index

它会自动去找安装目录下面src目录中的项目源码，并且将其索引记录到data目录中。
索引过程中我们可以通过安装目录中的log/opengrok0.0.log查看当前进度。

部署

索引完成后，我们就可以部署到tomcat8中，然后在web页面进行查看了。
执行以下命令开始部署，注意由于我们是通过apt-get安装的tomcat8，所以系统会自动创建tomcat8用户和组的。而我们如果是其他用户的话需要加sudo 权限。

$ sudo bin/OpenGrok deploy

还有记得启动tomcat哦，我的是debian 8所以可以用systemd来启动。
$ sudo systemctl start tomcat8
如果是ubuntu 14.04的话，可能还没有systemd，可以使用以下命令启动。
$ sudo service tomcat8 start

搜索项目

部署成功后，我们就可以通过浏览器访问了。
http://server-ip:8080/source/
出现以下界面就表示已经成功。
opengrok

最后如果在公司源码经常改动的话，可以通过crontab定时
repo sync然后也定时~/data/opengrok-0.12.1.6/bin/OpenGrok update更新一下索引即可。

总结

刚开始的时候从网上也找了一些资料，有很多太笼统了，有的又残缺不全。最后只能去看官方文档了，发现还是文档比较靠谱点。要养成看文档的习惯啊。在安装包中的doc目录下面讲的很清楚了。

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请联系我们举报，一经查实，本站将立刻删除。

发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/130095.html原文链接：https://javaforall.net

赞 (0)
全栈程序员-站长的头像全栈程序员-站长
0 0


相关推荐

  • PHP多进程 基于Redis实现轻量级延迟队列[通俗易懂]

    PHP多进程 基于Redis实现轻量级延迟队列[通俗易懂]

    PHP多进程 基于Redis实现轻量级延迟队列

    全栈程序员-站长的头像 全栈程序员-站长
    2022年2月12日
    51
  • Windows 7系统DNS服务器配置方法

    Windows 7系统DNS服务器配置方法

    Windows 7系统DNS服务器配置方法DNSDNS域名系统。域名系统是一个有序、结构化系统用于计算机与互联网或连接在一个私密网络系统。每个参与者补充了一个域名,代表不同的信息。电脑系统要求数字IP地址的功能。然而,这显然是非常困难的，对一些IP地址的门外汉来说,DNS可以翻译处容易记住的域名,DNS的重要性在于它是一个目录服务的互联网。正如电话目录翻译的人的名字到他们的电话号码,DNS也是这样，它们会翻译IP地

    全栈程序员-站长的头像 全栈程序员-站长
    2022年5月22日
    37
  • 远程连接mysql8，报错10061 解决办法「建议收藏」

    远程连接mysql8，报错10061 解决办法「建议收藏」

    远程连接mysql8，报错10061 解决办法「建议收藏」mysql8.0的1，检查服务器mysql服务是否启动100612，mysql必须设置密码，不然报错10061usemysql;updateusersetauthentication_string=””whereuser=“root”;flushprivileges;ALTERUSER‘root’@’%’IDENTIFIEDWITHmysql_native_passwordBY‘密码’;3，selectHost,Userfromuser;查看roo

    全栈程序员-站长的头像 全栈程序员-站长
    2022年10月13日
    4
  • ThinkPHP5.0 实现 app支付宝支付功能

    ThinkPHP5.0 实现 app支付宝支付功能

    ThinkPHP5.0 实现 app支付宝支付功能

    全栈程序员-站长的头像 全栈程序员-站长
    2021年10月25日
    59
  • HTML中的定位(php跳转到指定网页)

    HTML中的定位(php跳转到指定网页)

    1、通过地址定位：先页面定位位置：<aname=”name”/>然后通过js地址跳转：location.href=”#name”;或直接点击的html<ahref=”#name”>2、基于H5标准语法跳转先页面定位位置：<aid=”name”/>document.querySelector(“#name”).sc…

    全栈程序员-站长的头像 全栈程序员-站长
    2022年4月14日
    55
  • 端口号大全「建议收藏」

    端口号大全「建议收藏」

    端口号大全「建议收藏」计算机系统“端口”是英文port的义译，可以认为是计算机与外界通讯交流的出口。其中硬件领域的端口又称接口，如：USB端口、串行端口、打印机端口等。软件领域的端口一般指网络中面向连接服务和无连接服务的通信协议端口，是一种抽象的软件结构，包括一些数据结构和I/O（基本输入输出）缓冲区。说白了，我们在计算机的任何操作都在有意无意的使用着计算机的各个端口，下面列出了计算机的常用端口:0…

    全栈程序员-站长的头像 全栈程序员-站长
    2025年11月30日
    6

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号