opengrok搭建[通俗易懂]

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)
上一篇 2022年4月27日 下午7:20
下一篇 2022年4月27日 下午8:20


相关推荐

  • 分布式事务 java代码_Java分布式事务概念与实现示例[通俗易懂]

    分布式事务 java代码_Java分布式事务概念与实现示例[通俗易懂]在java中有如下三种事务,简单的JDBC级的事务JTA-在EJB环境下,用户得到事务并进行控制CMP-完全由容器控制事务,用户通过Bean配置文件来定义事务行为二三种都支持分布式事务,但只支持Java环境下的分布式事务。下面讨论如何在Java程序里实现分布式事务,即在同一个事务里访问多个数据源。实际上就是如何使用JTA.这里假设使用oracle数据库,使用webLogic部署应用,所要做…

    2022年5月8日
    51
  • DeepAgents 0.2发布:构建长期自主智能体的完整指南!

    DeepAgents 0.2发布:构建长期自主智能体的完整指南!

    2026年3月16日
    5
  • Java 实现二分(折半)插入排序

    Java 实现二分(折半)插入排序

    2021年12月16日
    46
  • intellijidea激活码 2022-激活码分享[通俗易懂]

    (intellijidea激活码 2022)JetBrains旗下有多款编译器工具(如:IntelliJ、WebStorm、PyCharm等)在各编程领域几乎都占据了垄断地位。建立在开源IntelliJ平台之上,过去15年以来,JetBrains一直在不断发展和完善这个平台。这个平台可以针对您的开发工作流进行微调并且能够提供…

    2022年3月31日
    651
  • 好友朋友圈动态仅三天可见?点击这个按钮,不管多久都能看

    好友朋友圈动态仅三天可见?点击这个按钮,不管多久都能看微信朋友圈可以说是了解好友的最好地方,但是现在大部分人都会设置朋友圈动态仅三天可见的权限。这样就只能看到好友三天内的朋友圈内容,其实只要点击这个按钮,多久都能看!先给大家介绍一点朋友圈小技巧吧!快速设置朋友圈权限朋友圈最烦人的就是广告了,本来想看看好友们有趣的动态,但翻了好几页都是广告。其实只需长按对方头像,就能设置不看对方的权限啦!发表纯文字朋友圈家里…

    2022年6月11日
    103
  • 如何将ts格式文件转成MP4格式文件

    如何将ts格式文件转成MP4格式文件这里写自定义目录标题欢迎使用 Markdown 编辑器新的改变功能快捷键合理的创建标题 有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中 居左 居右 SmartyPants 创建一个自定义列表如何创建一个注脚注释也是必不可少的 KaTeX 数学公式新的甘特图功能 丰富你的文章 UML 图表 FLowchart 流程图导出与导入导出导入欢迎使用 Ma

    2025年11月14日
    4

发表回复

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

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