opengrok环境搭建 - mehome/openthos GitHub Wiki
快速搭建opengrok环境
OpenGrok是一个快速,便于使用的源码搜索引擎与对照引擎,它能够帮助我们快速的搜索、定位、对照代码树。 本身也是利用ctags建立index的方式来进行关联,但是最终是通过web服务的形式提供给多个用户;所以只需要一台服务器来搭建opengrok环境就ok了
http://www.linuxidc.com/Linux/2013-05/84518.htm(百度上有很多的描述)
安装步骤:
1.需要apache tomcat来向外提供web服务(依赖JDK8以上,设置JAVA_HOME)
直接下载:wget http://mirrors.noc.im/apache/tomcat/tomcat-9/v9.0.0.M6/bin/apache-tomcat-9.0.0.M6.tar.gz
tar -xvf apache-tomcat-9.0.0.M6.tar.gz
./apache-tomcat-9.0.0.M6/bin/startup.sh
在浏览器中输入http://localhost:8080/能够获取一个页面就证明第一步是ok的
2.获取opengrok
需要依赖jdk,openjdk1.7及以上,oracleJdk8及以上
依赖ctags:sudo apt-get install ctags
进入https://github.com/OpenGrok/OpenGrok/releases下载
tar -xvf opengrok-0.12.1.5.tar.gz
将opengrok-0.12.1.5/lib/source.war包拷贝到apache-tomcat-9.0.0.M6/webapps目录下,在浏览器中输入http://localhost:8080/source 就可以得到一个空白的opengrok页面
修改apache-tomcat-9.0.0.M6/webapps/source/WEB-INF/web.xml
<context-param>
<param-name>CONFIGURATION
<param-value>你的opengrok路径前缀/opengrok-0.12.1.5/etc/configuration.xml
<description>Full path to the configuration file where OpenGrok can read it's configuration
3.运行opengrok针对code生成index
sudo ./opengrok-0.12.1.5/bin/OpenGrok index source_code_dir
提示:每次生成index后可能会有错误提示:"Failed to send configuration to localhost:2424"和java错误,目前不用理会
此时重新访问http://localhost:8080/source就可以正常阅览代码了
TIPS:
1.Full Search:不仅会搜索代码而且还会搜索注释/文本,一般会使用这个;
2.Definition:搜索define,函数原型的声明,实现位置
3.Symbol:只会搜索代码,不会搜过注释/文本,如果你确信这个是code,请使用这个选项,会有效减少搜索结果
4.File Path:一般是和上面三个选型联合使用;举例:如果只想搜索 kernel下的代码,你可以在这一栏中写入kernel,不带kernel路径的文件将不会被搜索到;
5.Type:可以指定搜索的文本类型;
进入到具体的文件中还有几个选项可以使用,请自行使用摸索
后续可能会对默认的配置进行修改,后续请继续补充