目录
一、JAVA安装与环境配置
网上的好些教程好些都是安装JDK1.8,但是随着opengrok以及ctags工具的更新,新版本的opengrok需要JAVA10以上版本,尽管opengrok也可以安装旧版本,但是还是会出一些莫名其妙的错误,所以推荐所有工具均用最新的版本比较靠谱。
1. jdk下载与安装
我下载的是JDK17,从官网下载:
Java Downloads | Oracle https://www.oracle.com/java/technologies/downloads/#jdk17-windows
下载后正常安装就可以了,要记住安装路径。
2.环境变量配置
安装完成后需要配置环境变量:点击"桌面计算机->属性->高级系统设置->高级->环境变量",点击下面的系统环境变量-> 新建(系统环境变量):
- 变量名:JAVA_HOME
- 变量值:C:\Program Files\Java\jdk-17.0.1(路径是自己的安装的实际路径)
之后找到环境变量名"Path",点击“编辑”,然后点击"新建",然后输入上"%JAVA_HOME%\bin"从而添加java的路径:
新建->变量名"CLAsspATH",变量
3.检查java是否安装成功
进入cmd中检查Java是否安装成功,检查的命令为 java -version:
二、ctags安装
我下载的是ctags-2021-10-25_p5.9.20211024.0-2-g6f544dfc-x64.zip
下载后直接解压到一个自定义的路径中,我的是D:\opengrok\ctags
,并把ctags的路径加到Path环境变量中:
然后验证ctags是否添加成功:在cmd中输入ctags --version
三、opengrok安装与配置
1.安装
下载地址:Releases · oracle/opengrok · GitHubhttps://github.com/OpenGrok/OpenGrok/releases(下载最新的.tar.gz为后缀的版本即可)
opengrok直接解压到相应的盘符中即可,我的是D:\opengrok\opengrok-1.7.24
2.配置:
1)在opengrok的安装目录下,新建data和source两个文件夹,source目录用于放需要浏览的源码,data目录用于放置opengrok生成的索引数据
2)把要建立索引(也是将来使用opengrok阅读)的源代码,拷贝到上步中建立的source目录下
3)在CMD中运行以下命令:(注:下面指令的路径需要和自己的目录一致,建立索引的时间可能会比较长,耐心等待即可)
java -Xmx524m -jar "D:\opengrok\opengrok-1.7.24\lib\opengrok.jar" -W "D:\opengrok\opengrok-1.7.24\data\configuration.xml" -P -S -v -s "D:\opengrok\opengrok-1.7.24\source" -d "D:\opengrok\opengrok-1.7.24\data"
四、tomcat安装与配置
1.安装与验证
需要安装tomcat10,安装tomcat9会有问题,下载地址:
Apache Tomcat® - Apache Tomcat 10 Software Downloadshttps://tomcat.apache.org/download-10.cgi找到对应操作系统的版本下载解压到相应目录即可。
新建环境变量:
- 变量名:CATALINA_HOME
- 变量值:“D:\opengrok\apache-tomcat-10.0.13”(路径是自己的实际路径)
启动tomcat:
运行D:\opengrok\apache-tomcat-10.0.13\bin\startup.bat(到D:\opengrok\apache-tomcat-10.0.13\bin文件夹下面,找到startup.bat文件,双击,即可运行。)
运行之后,会启动tomcat窗口,不要关闭。
在浏览器中输入: http://localhost:8080/。如果无误,将出现tomcat的介绍页面,如下:
2.配置Tomcat
1)把opengrok安装目录下的\lib\source.war
文件,拷贝到tomcat安装目录下的webapps\
目录下,之后会自动生成source文件夹
2)打开tomcat安装目录下的文件,webapps\source\WEB-INF\web.xml,ctrl+F,搜索“param-value”,修改第一个匹配项之后的路径,改成opengrok路径下data文件夹里面configuration.xml文件的绝对路径。
3.运行
打开浏览器,访问地址:http://localhost:8080/source,就可以看到界面:
我这里在source文件夹下放了多个工程,效果如上,之后就可以使用opengrok了。
参考文章: