( 旧文档案 )
代码畅游必备工具-在Debian上安装配置OpenGrok
代码畅游必备工具:在 Debian 上安装配置 OpenGrok 源码搜索引擎。
最近打算好好研究一下微软给出的微服务架构示例项目eShopOnContainers,需要一个方便的源代码浏览工具,自然而言地想到了用OpenGrok来进行。原来安装配置过,但是没有做记录,这么久了也忘记怎么做了,又从头折腾了一遍,为了备忘,将安装配置的过程记录下来。
基本环境
- Debian 10.1.0(buster)
- JDK 11
- Tomcat 9
- universal-ctags
安装步骤
- 安装JDK 11
sudo apt install openjdk-11-jdk
- 安装Tomcat 9
sudo apt install tomcat9
- 安装universal-ctags
sudo apt install universal-ctags
- 在OpenGrok的下载页面下载最新版本(目前是1.3.6)
wget https://github.com/oracle/opengrok/releases/download/1.3.6/opengrok-1.3.6.tar.gz
- 将下载的文件解压至*/opt/opengrok*目录
- 将source.war部署志Tomcat
sudo cp /opt/opengrok/lib/source.war /var/lib/tomcat9/webapps
- 源码目录和索引目录默认存放在/var/opengrok下,新建下列文件夹
mkdir -p /var/opengrok/data
mkdir -p /var/opengrok/src
mkdir -p /var/opengrok/etc
- 将想阅读的源代码放在src目录下,例如eShopOnContainers
cd /var/opengrok/src
git clone https://github.com/dotnet-architecture/eShopOnContainers.git
- 配置默认日志配置
sudo cp /opt/opengrok/doc/logging.properties /var/opengrok/logging.properties
- 生成源代码的索引
java -Djava.util.logging.config.file=/var/opengrok/logging.properties \
-jar /opt/opengrok/lib/opengrok.jar \
-c /usr/bin/ctags-universal \
-s /var/opengrok/src -d /var/opengrok/data -H -P -S -G \
-W /var/opengrok/etc/configuration.xml -U http://localhost:8080
