OpenGrok is a fast and usable source code search and cross reference engine. It helps you search, cross-reference and navigate your source tree. It can understand various program file formats and version control histories like Mercurial, Git, SCCS, RCS, CVS, Subversion, Teamware, ClearCase, Perforce, Monotone and Bazaar. In other words it lets you grok (profoundly understand) the open source, hence the name OpenGrok. It is written in Java.
1)安装Java
这个可以从Oracle上找到下载。
2)安装tomcat6
从Apache的Tomcat6网站上下载这个网页上的core包就可以了,deployer的包可以不用下载。下载完了之后解压。这个时候,需要设置一下CATALINA_HOME参数;随后运行./bin/startup.sh就可以了。具体的指令步骤如下:
- tar xvfz apache-tomcat-7.0.2.tar.gz
- export CATALINA_HOME= ../apache-tomcat-7.0.2
- cd $CATALINA_HOME/bin
- ./startup.sh
这时,你可以打开浏览器,浏览http://192.168.1.100:8080,如果看到有页面出现,就说明Java和Tomcat安装成功了。
3)安装OpenGrok
- tar xvfz opengrok-0.9.tar.gz
- cd opengrok-0.9
- mkdir -p DATA/data # 建立一个专门的放索引和数据的目录
- ln -sf <src-of- your-repository> `pwd`/DATA/src # 这一步是将你的代码库的内容作为一个src的源。
- 在bin/OpenGrok文件中加入环境变量
- OPENGROK_DISTRIBUTION_BASE=~/work/software/opengrok/opengrok-0.9/lib # OpenGrok解压的目录,主要要加上lib
OPENGROK_INSTANCE_BASE=~/work/software/opengrok/opengrok-0.9/DATA
EXUBERANT_CTAGS=/usr/bin/ctags-exuberant # ctags的全部路径
JAVA_HOME=/usr/lib/jvm/java-6-sun # JAVA安装的目录
OPENGROK_APP_SERVER="Tomcat" # Tomcat
OPENGROK_WAR_TARGET=~/work/software/opengrok/apache-tomcat-7.0.2/webapps # Tomcat的webapps目录 - ./bin /OpenGrok deploy # 这步将source.war复制到tomcat的webapps目录。
- ./bin/OpenGrok index # 建立索引
- 当index的步骤完成,将浏览器中指向http://192.168.1.100:8080 /source就可以查询和阅读自己的代码了