Windows10 opengrok配置文档

参考文档：
  https://blog.csdn.net/w860316/article/details/72796295
  http://mazhuang.org/2016/12/14/rtfsc-with-opengrok/#折腾狂魔

1.安装jdk
    安装配置jdk环境变量，windows10--此电脑--属性--高级系统设置--环境变量--系统设置--path--新建路径
    验证使用java javac java -version
    jdk百度软件搜索下载
    
2.安装tomcat

安装： 
下载地址：http://tomcat.apache.org/ 附件版本为apache-tomcat-9.0.6-windows-x64
从以上地址下载，并解压到合适的地方，我将文件解压到C盘根目录下。 
注意： 
要选择跟操作系统的bit版本一致的版本，win7是32位的就选32bit的，64bit的同理。 
设置环境变量： 
新建 & 设置环境变量CATALINA_HOME，值为tomcat的解压目录，我的是： 

CATALINA_HOME C:\apache-tomcat-8.5.15 

--环境变量配置时--系统变量--新建
变量名 ： CATALINA_HOME
变量值 ： C:\Program Files\opengrok\apache-tomcat-9.0.6（tomcat解压路径）
path新建路径  C:\Program Files\opengrok\apache-tomcat-9.0.6\bin
以管理员身份运行C:\apache-tomcat-8.5.15\bin\startup.bat，不用管理员运行会报权限错误，说创建失败

运行之后，会启动tomcat窗口，不要关闭。 
注意： 
以后每次使用opengrok，都是要启动tomcat的，按照如上的步骤。Tomcat其实就是一个web服务器。 
验证： 
在浏览器中输入以下网址并回车： localhost:8080。如果无误，将出现tomcat的介绍页面，如下。

由于一些原因我修改了C:\Program Files\opengrok\apache-tomcat-9.0.6\bin
startup.bat最前面添加  
SET JAVA_HOME=C:\Program Files\Java\jdk1.8.0_101
SET TOMCAT_HOME=C:\Program Files\opengrok\apache-tomcat-9.0.6
shutdown.bat最前面添加  
SET JAVA_HOME=C:\Program Files\Java\jdk1.8.0_101
SET TOMCAT_HOME=C:\Program Files\opengrok\apache-tomcat-9.0.6

3 安装opengrok
安装： 
下载地址，https://github.com/oracle/opengrok/releases   我的附件版本 opengrok-1.1-rc21.tar
从以上地址中下载opengrok的binary发布版本，解压到合适的位置。 
设置环境变量： 
这一步不需要设置环境变量。 
注意： 
1、下载最新的版本即可，我的是“opengrok-1.1-rc4.tar.gz”，后缀是“.tar.gz”的版本。解压
2.将 OpenGrok 的 lib 目录里的 source.war 解压到 C:\Program Files\opengrok\apache-tomcat-9.0.6\webapps\source，（C:\Program Files\opengrok\apache-tomcat-9.0.6\webapps上一级目录也可以放一个）
3.配置 WEB-INF\web.xml 文件的 CONFIGURATION 为上一步生成的 data 目录下的 configureation.xml，比如我的配置：
 
     <display-name>OpenGrok</display-name>
    <description>A wicked fast source browser</description>
    <context-param>
        <description>Full path to the configuration file where OpenGrok can read its configuration</description>
        <param-name>CONFIGURATION</param-name>
      <!--   <param-value>/var/opengrok/etc/configuration.xml</param-value> -->
        <param-value>D:/software/opengrok/back/opengrok-1.1-rc21/data/configuration.xml</param-value>  //修改值为路径
    </context-param>
4.配置 data root,source root
在目录D:\software\opengrok\back\opengrok-1.1-rc21，创建source data目录，放源码和索引
可以让 OpenGrok 认为 source root 下的每个子文件夹是一个项目，所以我们利用这个特性来配置和阅读多个项目源码就好了。
我的做法是在 OpenGrok 下创建了一个子目录 D:\Programs\opengrok-0.13-rc4\projects，然后将需要阅读的源码使用符号链接的方式链接到这个目录里：

cd /d D:\Programs\opengrok-0.13-rc4\projects
mklink /J android D:\sources\android_5.1
mklink /J openjdk7 D:\sources\openjdk7
这样就有一个叫 android 的工程，它实际对应 D:\sources\android_5.1 下的源码，一个叫 openjdk7 的工程，它实际对应 D:\sources\openjdk7 下的源码。
    
  4 安装ctags 
安装： 
下载地址：http://ctags.sourceforge.net/ 
下载“ctags58.zip”压缩包，解压到合适的路径。  我的目录C:\Program Files\opengrok\ctags58 
设置环境变量： 
将安装路径，加入“系统环境变量 / path”，如我的是C:\ctags58。  //我的路径C:\Program Files\opengrok\ctags58
    
5 配置opengrok
1、在opengrok的安装目录下，新建data和source两个文件夹，source目录用于放置我们自己的源码，data目录用于放置opengrok生成的索引数据； 
2、把要建立索引的源代码，拷贝到1中建立的source目录下；    
3、在win7 cmd命令行下，输入以下命令并执行：命令用于生成索引数据，等待以上命令执行完毕;
 java -Xmx524m -jar "D:\\software\\opengrok\\back\\opengrok-1.1-rc21\\lib\\opengrok.jar" -W "D:\\software\\opengrok\\back\\opengrok-1.1-rc21\\data\\configuration.xml" -P -S -v -s "D:\\software\\opengrok\\back\\opengrok-1.1-rc21\\source" -d "D:\\software\\opengrok\\back\\opengrok-1.1-rc21\\data"

-P 表示为 source root 目录下的每个一级子目录生成一个工程。
-S 表示搜索并添加 “external” source repositories。
-v 表示打印操作的进度信息。
-s 表示指定 source root。
-d 表示指定 data root。
-W 表示指定将配置写到该文件。

还有更多配置选项可以使用 java -jar /path/to/opengrok.jar 查看。

6 启动 Tomcat
关掉之后重新进，可以使用shutdownup.bat,然后以 管理员身份运行startup启动tomcat
用浏览器打开 http://localhost:8080/source/，然后就能愉快地跟 OpenGrok 玩耍了。
当新添加了项目，或者现有项目有源码更新时，再次执行上一步的命令，就能增量更新索引了。
 
http://192.168.2.45:8080/source   //网页访问ip，cmd之后ipconfig查看

7 配置多项目  
我曾经为如何在 OpenGrok 里配置多项目苦恼了好久——一开始我是把 Android 源码的根目录当作 source root 的，可想而知 OpenGrok 把 Android 分成了好多个子项目，而这时我也没法再添加新的工程了。
后来才发现建一个专用的 source root，然后把各种项目源码根目录软链接过来，让 OpenGrok 为 source root 下的每个 symbol 一级子目录建立一个项目才是正确的使用方法。
Windows 下建立软链接的方法是使用 mklink /J android D:\sources\android_5.1，Mac OS X 和 Linux 下可以使用 ln -s /path/to/source project_name。

8 常见问题 
打开网页错误如下：
There was an error!
CONFIGURATION parameter has not been configured in web.xml! Please configure your webapp.
Unable to determine source root path. Missing configuration?
java.io.FileNotFoundException: Unable to determine source root path. Missing configuration?
at org.opensolaris.opengrok.web.PageConfig.checkSourceRootExistence(PageConfig.java:1562)
at org.apache.jsp.index_jsp._jspService(index_jsp.java:222)
at org.apache.jasper.runtime.HttpJspBase.service(HttpJspBase.java:70)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:742)
at org.apache.jasper.servlet.JspServletWrapper.service(JspServletWrapper.java:443)
at org.apache.jasper.servlet.JspServlet.serviceJspFile(JspServlet.java:385)
at org.apache.jasper.servlet.JspServlet.service(JspServlet.java:329)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:742)


这一般是由于更新或切换了 OpenGrok 版本，但却没有将 tomcat 的 webapps 目录下的 source 文件夹替换为对应版本。