opengrok搭建快餐教程2020

opengrok搭建快餐教程2020

安装tomcat

看这个中文版教程的大概在国内，大家下载就找个镜像会快一些，比如清华的镜像：
https://mirrors.tuna.tsinghua.edu.cn/apache/tomcat

下载tar.gz包解压之后，运行startup.sh，就可以在8080端口看到运行的tomcat的页面，俗称大猫页：

编译universal-ctags

首先下载源代码：

git clone https://github.com/universal-ctags/ctags

编译需要autoconf和pkg-config两个包的支持。可以通过apt或dnf,yum等包管理工具来安装。

然后运行autoconf.sh，成功后生成configure脚本。
接着运行configure，最后运行make，大功告成。

下载opengrok运行包

可以去https://github.com/oracle/opengrok/releases/download找到当前最新的release:

wget -c https://github.com/oracle/opengrok/releases/download/1.3.6/opengrok-1.3.6.tar.gz

然后解压到一个dist目录里吧，例：

tar -C ~/opengrok/dist --strip-components=1 -xzf opengrok-1.3.6.tar.gz

配置日志属性

将我们刚才解压的dist目录下doc下的logging.properties复制到opengrok的etc目录下：

cp ~/opengrok/dist/doc/logging.properties ~/opengrok/etc

建立索引

下面我们就可以正式创建索引啦，几个主要参数如下：

• -Djava.util.logging.config.file: 配置日志属性中讲到过
• -jar: 下载的opengrok.tar.gz中提供的opengrok.jar
• -c: 之前我们编译好的ctags的执行路径
• -s: 要建立索引的源代码目录
• -d: 生成索引数据的目录
• -W: 配置文件

例：

java -Djava.util.logging.config.file=~/opengrok/etc/logging.properties -jar ~/opengrok/dist/lib/opengrok.jar -c ~/opengrok/ctags/ctags -s ~/github -d ~/opengrok/data -H -P -S -G -W ~/opengrok/etc/configuration.xml

部署

首先安装下脚本工具，在dist/tools下有个opengrok-tools.tar.gz，通过pip命令进和安装：

pip3 install ./opengrok-tools.tar.gz

然后运行刚安装脚本中的opengrok-deploy将刚才生成的source.war部署到tomcat的webapps目录下，例：

opengrok-deploy -c ~/opengrok/etc/configuration.xml ~/opengrok/dist/lib/source.war ~/opengrok/apache-tomcat-9.0.30/webapps

然后我们打开浏览器，就可以查看结果了。因为我是在docker里运行的，将8080映射到了10080，大家可以用8080就好：