win7下安装配置opengrok

目录
0、声明
1、 安装软件 & 设置环境变量
1.1、JDK
1.2、tomcat
1.3、opengrok
1.4、ctags
2、配置opengrok
3、配置tomcat
4、开始使用
5、使用体验

0、声明
自己安装、配置过程中，参考了网上的2篇博文，发现有的地方写的不够准确，或者有遗漏，为防止其他人遇到类似的情况，特写此step by step教程。
2篇博文分别如下：
http://blog.csdn.net/finewind/article/details/47362525
http://blog.csdn.net/newbie_zhu/article/details/50635139

1、安装软件 & 设置环境变量
1.1 安装JDK
安装：
下载地址：http://www.oracle.com/technetwork/java/javase/downloads/index.html
注意：
1、下载，Java SE （不是java ME/EE）的JDK（不是JRE），版本用最新的，32bit/64bit的都行，但是如果之前电脑上，有其他软件使用过JRE，那么最好与此JRE的bit位数一致，否则会导致使用此jre的软件无法运行。
2、JDK的安装界面，把JDK、JRE、SRC都装上；
验证：
安装完后，在命令行下输入java 空格-version，如果显示了java的版本信息，则证明java安装成功。
如果不成功，重启一下电脑，再试一下，一般都会ok。
设置环境变量：
根据实际的安装路径，新建 & 设置JAVA_HOME和JRE_HOME环境变量，我的是：
JAVA_HOME C:\Program Files (x86)\Java\jdk1.8.0_121
JRE_HOME C:\Program Files (x86)\Java\jdk1.8.0_121\jre
注意：
1、目前的java运行，其实是无需设置这两个环境变量的，但是后面讲到的tomcat，启动时要求设置这两个环境变量。
2、“C:\Program Files (x86)\Java\jdk1.8.0_121”，这个要根据实际安装情况自己修改一下。
3、“C:\Program Files (x86)\Java\jdk1.8.0_121\jre”，这个同上，但是请注意，我这次使用的是“jdk1.8.0_121\jre”，也就是JDK的私有jre。
这块要彻底搞明白怎么回事，最好要明白jdk、jre之间的区别。扼要说明一下，jdk用于java开发，jre用于运行java开发出来的软件，所以JRE_HOME只要设置成一个jre的位置就行了，不管是jdk的私有jre，还是公共jre，比如我设置成公共jre的路径“C:\Program Files (x86)\Java\jre1.8.0_121”，也是可以的。

1.2 安装tomcat
安装：
下载地址：http://tomcat.apache.org/
从以上地址下载，并解压到合适的地方，我将文件解压到C盘根目录下。
注意：
要选择跟操作系统的bit版本一致的版本，win7是32位的就选32bit的，64bit的同理。
设置环境变量：
新建 & 设置环境变量CATALINA_HOME，值为tomcat的解压目录，我的是：
CATALINA_HOME C:\apache-tomcat-8.5.15
注意：
“C:\apache-tomcat-8.5.15”应改为你实际的路径。
启动tomcat：
运行C:\apache-tomcat-8.5.15\bin\startup.bat（到C:\apache-tomcat-8.5.15\bin文件夹下面，找到startup.bat文件，双击，即可运行。）
运行之后，会启动tomcat窗口，不要关闭。
注意：
以后每次使用opengrok，都是要启动tomcat的，按照如上的步骤。Tomcat其实就是一个web服务器。
验证：
在浏览器中输入以下网址并回车： localhost:8080。如果无误，将出现tomcat的介绍页面，如下。

1.3 安装opengrok
安装：
下载地址，https://github.com/OpenGrok/OpenGrok/releases
从以上地址中下载opengrok的binary发布版本，解压到合适的位置。
设置环境变量：
这一步不需要设置环境变量。
注意：
1、下载最新的版本即可，我的是“opengrok-1.1-rc4.tar.gz”，后缀是“.tar.gz”的版本。

2、“opengrok-1.1-rc4.tar.gz”里面是后缀为 “.tar”的压缩文件“opengrok-1.1-rc4.tar”，要继续解压，把其解压出来就是我们需要的东西了，放到合适的位置，我的是“C:\opengrok-1.1-rc4”。

1.4 安装ctags
安装：
下载地址：http://ctags.sourceforge.net/
下载“ctags58.zip”压缩包，解压到合适的路径。
设置环境变量：
将安装路径，加入“系统环境变量 / path”，如我的是C:\ctags58。

2、配置opengrok
2.1、在opengrok的安装目录下，新建data和source两个文件夹，source目录用于放置我们自己的源码，data目录用于放置opengrok生成的索引数据；
2.2、把要建立索引的源代码，拷贝到1中建立的source目录下；
2.3、在win7 cmd命令行下，输入以下命令并执行：
java -Xmx524m -jar C:\opengrok-1.1-rc4\lib\opengrok.jar -W”C:\opengrok-1.1-rc4\data\configuration.xml” -P -S -v -s”C:\opengrok-1.1-rc4\source” -d “C:\opengrok-1.1-rc4\data”
以上命令用于生成索引数据，等待以上命令执行完毕;
注意：
1、命令之间的空格，单个就行了。
2、“Xmx524m”这里，网上其他教程有的是“Xmx512m”，之间的区别，还没研究。
3、“C:\opengrok-1.1-rc4”，这个要改成自己的，之前“安装opengrok”中的路径。
4、”C:\opengrok-1.1-rc4\data\configuration.xml”，这是个字符串，不要把2边的双引号丢了，另外注意，里面的路径也要改成自己的路径，同时把路径分隔符，改成“\”，2个“\”在字符串里面，就是 \ 的意思。
5、 “C:\opengrok-1.1-rc4\source”、”C:\opengrok-1.1-rc4\data”，同以上道理，都要改成自己的实际路径。

3、配置tomcat
3.1、把opengrok安装目录下的\lib\source.war文件，拷贝到tomcat安装目录下的webapps\目录下。
验证：
启动浏览器，访问地址：http://localhost:8080/source，如果能够正常显示OpenGrok搜索页面说明配置成功。

3.2、打开tomcat安装目录下的文件，webapps\source\WEB-INF\web.xml，ctrl+F，搜索“aram-value”，修改第一个匹配项之后的路径，改成opengrok路径下data文件夹里面configuration.xml文件的绝对路径。
我的如下，蓝色背景的部分。

注意：
这里要留意的是，路径的分隔符，用“/”，而不是“\”, 后者是windows默认的路径分隔符。

4、开始使用
经过以上各种操作，就可以使用了，打开浏览器，访问地址：http://localhost:8080/source，就可以看到界面了。
如果出现404，记得运行C:\apache-tomcat-8.5.15\bin\startup.bat即可。
我的如下：

5、使用体验
1、我之所以搭建opengrok，是看网上说他的review功能比sourceinsight强，但是经过测试发现，也许是强，但是分析功能还是不够完善，比如我用它分析了一个自己工作中用到的协议栈代码，C语言，里面有的函数的定义部分，有比较复杂的宏函数 & 条件编译的混合，结果发现解析不了，无法正确识别函数名字，把宏函数名放到Navigate列表里面了。
我觉得可能是ctags太老了的原因，很久没有更新了，很可惜。
2、我觉得对于团队来说，用这个还是挺实用的，一个人搭建好，其他人用流浪器就可以了，确实很方便。