OpenGrock搭建

OpenGrok简介 

OpenGrok一个快速、便于使用的源代码搜索与对照引擎。它帮助你搜索，对照，定位你的源代码树。


OpenGrok是OpenSolaris操作系统源文件浏览和搜索的工具。


目前网络上已经有使用OpenGrok对Android源码进行索引的搜索引擎，地址：http://androidxref.com


OpenGrok官方主页请参照：http://opengrok.github.io/OpenGrok/

环境要求

1、JDK 1.8（系统安装版本不是1.8的可以参考文档安装JDK：http://3ms.huawei.com/hi/group/1502313/wiki_4453117.html）
2、Exuberant Ctags工具 (一般机器安装过vim就会安装过该工具，也可以使用sudo apt-get install exuberant-ctags安装)
3、Apache-tomcat服务8.x或以上
4、OpenGrok工具

安装方法
 1.安装JDK8以上，并手工搭建apache-tomcat（略）
2.从github下载opengrok包，我使用的是1.0版本，即opengrok-1.0.tar.gz。https://github.com/OpenGrok/OpenGrok/releases
3.解压OpenGrok-1.0.zip，编辑bin/OpenGrok，增加如下环境变量
OPENGROK_INSTANCE_BASE=/root/opengrok                     #opengok目录
OPENGROK_TOMCAT_BASE=/root/apache-tomcat-8.0.30   #tomcat安装路径
SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"               #代码根路径
DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"         #索引根路径
OPENGROK_READ_XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"   #opengrok最关键的配置文件路径
4.克隆代码到SRC_ROOT目录下。注意：需要包含.git等的目录，否则opengrok无法识别配置库信息
5.使用 bin/OpenGrok index全量索引。该命令会识别SRC_ROOT下的目录仓库，生成configuration.xml。
6..bin/OpenGrok deploy 该命令会拷贝source.war到tomcat的webapps下，并修改web.xml，指向/etc/configuration.xml。此时已经可以启动tomcat,访问http://ip:8080/source来使用opengrok了
7.使用 bin/OpenGrok indexpart /root/opengrok/src/ /projectname 为每个项目单独更新索引.PS:也可对每个仓库Repository分别建索引，从而提升单词索引的效率。之前公司分析安卓的代码，每次分析一个整repo(里面包括多个git)，有时更新索引非常久，导致索引进程内存溢出了。
8.如果有新的project或老的project需要删除，则需要使用bin/OpenGrok index来重新生成configuration.xml

其他高级配置

https://github.com/OpenGrok/OpenGrok/wiki