ubuntu 搭建 opengrok

概述

OpenGrok一个快速、便于使用的源代码搜索与对照引擎。它帮助你搜索，对照，定位你的源代码树。它能够明白各种程序文件格式和版本控制历史记录。

应用场景：

• 全工程搜索：十几G的代码量，搜索速度很快
• 查看版本控制记录

应用依赖：

• linux服务器：公共服务器，或者PC上面的虚拟机

安装源码

下面的源码经过更新，支持快捷方便的创建opengrok的环境。

验证环境：ubuntu 18.04
安装影响：

• 删除了原始root下的java环境，替换为当前软件包的java版本

git clone https://gitee.com/whilewell/tools-opengrok.git

源码结构

源码中的脚本均在后续的安装和使用过程中会用到

.
├── ctags                   # 基础工具ctags
├── data                    # 生成索引安装位置
├── etc                     # 生成web配置
├── gen_code_index.sh       # 创建代码索引脚本
├── index                   # 源码存放位置
├── install.sh              # 软件包安装脚本
├── jdk-17.0.1              # java工具
├── opengrok-1.7.21         # opengrok工具          
├── apache-tomcat-10.0.12   # tomcat软件包，提供web服务
├── down_tomcat.sh          # 关闭tomcat脚本
└── up_tomcat.sh            # 开启tomcat脚本

安装使用

步骤1：安装源码（必选）

执行install.sh脚本

步骤2：放置源码（必选）

在源码放入大index目录下

步骤3：启动tomcat（必选）

执行up_tomcat.sh脚本

步骤4：创建索引（必选）

执行gen_code_index.sh脚本

步骤5：访问opengrok（必选）

等待步骤4 完成，完成后访问http://${hostip}:8080/source, 其中hostip要根据实际情况进行输入

步骤6：增加代码索引（可选）

增加代码或更新代码后，重新执行步骤4
适用场景：

• 在index下面增加代码目录
• 更新index下面原有代码

参考

Opengrok环境搭建--阅读Android源码_Blues Feng的博客-程序员宅基地 - 程序员宅基地 (cxyzjd.com)