OpenGrok是一个快速,便于使用的源码搜索引擎与对照引擎,它能够帮助我们快速的搜索、定位、对照代码树。接下来就具体讲解一下OpenGrok的安装及使用。
第一步:apt-get install exuberant-ctags 安装ctags,以及jdk,apt-get install sun-java6-jdk 已经装了java环境的就不须再装。
第二步:安装Web服务器-Tomcat。如果ubuntu自带已经安装了tomcat6,这步就可以跳过。
首先大家应该明白OpenGrok是一个Web系统,因此要共享OpenGrok搜索引擎,需要安装Web服务器。在Ubuntu环境下,推荐使用Tomcat。
http://mirror.esocc.com/apache/tomcat/tomcat-7/v7.0.47/bin/apache-tomcat-7.0.47.tar.gz
目录放到/opt/apache-tomcat-7.0.47
使用以下命令解压下载的Tomcat压缩包
- #tar xvzf apache-tomcat-7.0.47.tar.gz
- #cd apache-tomcat-7.0.47
- #cd bin/
- #./shutdown.sh #这里先执行./shutdown.sh关闭一下tomcat服务,默认ubuntu可能启动了tomcat6,而我们现在安装的是tomcat7
- #./startup.sh
第三步:
安装好Tomcat后,接下来就是配置OpenGrok了。OpenGrok下载地址:http://opengrok.github.io/OpenGrok/ 在该网址中可以下载OpenGrok的编译文件,也可以下载源文件。在此我们直接下载编译文件(对OpenGrok感兴趣的同学可以下载源码查看究竟),下载后通过以下命令进行解压:
- #tar xvzf opengrok-0.11.1.tar.gz
注意网址后面有加“/source”.
接下就是建立源码的索引。
第四步:修改OpenGrok的数据存放目录,建立源码的索引。
编辑/opt/opengrok-0.11.1/bin/OpenGrok
DefaultInstanceConfiguration()
{
...
OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
#修改这个路径为自定义的数据目录即可。
#例如修改为 OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/work/opengrok}"
...
}
需要创建两个文件夹:
1./work/opengrok/src 源代码的文件夹,里面是搜索的工程源代码,可以是源代码链接
2.再创建/work/opengrok/data,搜索索引后的数据库的存放文件夹。
最后将所有需要加到OpenGrok进行搜索的工程源代码创建个链接到 /work/opengrok/src ,再执行/opt/opengrok-0.11.1/bin/OpenGrok index命令就完成了对那些工程的搜索索引,可以在浏览器就行访问和搜索代码了。
创建符号链接:ln -s 源代码文件夹名
3.需要修改/opt/apache-tomcat-7.0.47/webapps/source/WEB-INF/目录下的web.xml,(如果是默认tomcat6在/var/lib/tomcat6/webapps/source/WEB-INF/web.xml)
<context-param>
<param-name>CONFIGURATION</param-name>
<param-value>/work/opengrok/etc/configuration.xml</param-value>
<description>Full path to the configuration file where OpenGrok can read it's configuration</description>
</context-param>
这样设置,保证tomcat找对OpenGrok的路径设置,要不然重启电脑再次访问OpenGrok会没有搜索的工程列表。
到此结束。
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------