工具之OpenGrok的搭建方法

0.OpenGrok介绍

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

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

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

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

1.OS

Ubuntu 12.04 LTS

2.Java環境

版本要求

java1.7以上 (以jdk-8u5-linux-i586.tar.gz举例说明)

解压文件（以解压到/home/kawai/OpenGrok为例）

解压后的jdk路径为：/home/kawai/OpenGrok/jdk1.8.0_05

配置环境变量

打开配置文件：

$ sudo gedit /etc/profile

添加如下内容：

export JAVA_HOME=/home/kawai/OpenGrok/jdk1.8.0_05

export JRE_HOME=$JAVA_HOME/jre

export CLASSPATH=.:$JAVA_HOME/lib:$JRE_HOME/lib:$CLASSPATH

export PATH=$JAVA_HOME/bin:$JRE_HOME/bin:$PATH

保存后关闭，使用source命令进行更新：

source /etc/profile

设置为系统默认的jdk

$ sudo update-alternatives –install /usr/bin/java java /home/kawai/OpenGrok/jdk1.8.0_05bin/java 300

$ sudo update-alternatives –install /usr/bin/javac javac /home/kawai/OpenGrok/jdk1.8.0_05bin/javac 300

$ sudo update-alternatives –config java

$ sudo update-alternatives –config javac

测试

输入命令:java -version，如果能够正常输出版本信息，说明java环境配置成功。

3.Tomcat

版本要求

7.x以上 (以apache-tomcat-7.0.37.tar.gz举例说明)

解压文件（以解压到/home/kawai/OpenGrok为例）

解压后的tomcat路径为：/home/kawai/OpenGrok/apache-tomcat-7.0.37

启动tomcat

$ cd /home/kawai/OpenGrok/apache-tomcat-7.0.37/bin

$ ./startup.sh

测试

启动浏览器，访问地址:http://localhost:8080

如果能够显示欢迎页面说明配置成功。

4.Exuberant Ctags

执行如下命令进行安装：

sudo apt-get install exuberant-ctags

5.OpenGrok

下载地址
http://java.net/projects/opengrok/downloads/download/opengrok-0.12.1.tar.gz
解压文件（以解压到/home/kawai/OpenGrok为例）

解压后OpenGrok路径为：/home/kawai/OpenGrok/opengrok-0.12.1/

部署

拷贝文件opengrok-0.12.1/lib/source.war到apache-tomcat-7.0.37/webapp目录下。

拷贝完成后，该文件将会自动生成source目录。

测试

启动浏览器，访问地址：http://localhost:8080/source

如果能够正常显示OpenGrok搜索页面说明配置成功。

6.索引代码

进入opengrok的bin目录

$ cd /home/kawai/OpenGrok/opengrok-0.12.1/bin

执行索引命令

$ sudo ./OpenGrok index SourceDir

#SourceDir为待索引代码所在目录，如/home/kawai/SourceDir

索引完成后，访问页面http://localhost:8080/source进行代码搜索。

windows环境搭建

下载OpenGrok Binary

下载地址：http://java.net/projects/opengrok/downloads/download/opengrok-0.12.1.tar.gz

解压文件，比如：”D:\OpenGrok”

下载Ctags for Windows Binary

下载地址：http://prdownloads.sourceforge.net/ctags/ctags58.zip

解压Ctags，比如：”D:\Ctags”。并将该目录添加到系统环境变量中。

下载安装Tomcat

拷贝”D:\OpenGrok\lib\source.war”文件到tomcat的webapps文件夹中

编辑tomcat\webapps\source\WEB-INF\web.xml文件，修改如下内容：

1）<param-name>CONFIGURATION</param-name>

OpenGrok的配置文件。

按照OpengGrok的实际安装目录修改<param-value>的值。

比如：<param-value>d:\OpenGrok\configuration.xml</param-value>

2）<param-name>SRC_ROOT</param-name>

待索引代码的目录。根据实际要索引的目录进行设置。

3）<param-name>DATA_ROOT</param-name>

索引文件保存路径。也可以随意指定。

索引代码

启动命令行。cd 到OpenGrok目录。执行如下命令：

?

1

java -Xmx524m -jar lib\opengrok.jar -W "D:\\OpenGrok\\data\\configuration.xml" -P -S -v -s "D:\\OpenGrok\\source" -d "D:\\OpenGrok\\data"

1）-W “D:\\OpenGrok\\data\\configuration.xml” ：指定配置文件

2）-s “D:\\OpenGrok\\source” ： 指定要索引的代码的目录

3） -d “D:\\OpenGrok\\data” ：指定生成的索引文件保存的路径