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就好: