ubuntu opengrok环境的搭建和索引

一、下载JDK（这里使用开源版本openjdk）

step1.sudo apt-get update：更新软件包列表

step2.sudo apt-get install openjdk-8-jdk：安装openjdk-8-jdk

step3.java -version：查看java版本，看是否安装成功

step4.成功之后用gedit文本编辑器在/etc/profile :sudo gedit /etc/profile

在打开的/etc/profile文件的末尾添加下面几行：

export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64

export JRE_HOME=${JAVA_HOME}/jre

export CLASSPATH=.:${JAVA_HOME}/lib:${JRE_HOME}/lib

export PATH=${JAVA_HOME}/bin:$PATH

step5.最后执行以下命令让修改生效：

source /etc/profile

二、安装tomcat

step1.http://tomcat.apache.org/download-80.cgi

step2.去上面的官网下载一个tomcat安装包（tar.gz），之后创建一个tomcat文件夹，将在tomcat官网下载的压缩包放到文件夹下。

step3.解压压缩包（tar  -zxf xxxxxxxxxxxxxxx.tar.gz）

step4.给解压的文件赋权限（chomd 755 -R 解压后的文件）

进入到文件夹的bin目录下：

先使用gedit startup.sh命令：在显示的文件的最后一行前面加上下图的环境配置： 

保存之后使用./startup.sh启动tomcat

看到启动成功后，在网站输入localhost:8080检测是否成功。

三、下载opengrok

step1.http：//github.com/oracle/opengrok/releases

去opengrok下载的网站下载opengrok的压缩包（多往下扒拉扒拉找opengrok-1.1-rc41.tar.gz，我用的这个，不然有些地方会不太一样）

step2.创建一个opengrok的文件夹，将下载的压缩包在文件夹中解压后将/lib/source.war这个文件放在之前创建的tomcat文件夹的webapp的目录下；

step3.注意进入web.xml中修改configuration.xml的路径

路径:tomcat[解压的版本号的文件夹]/webapps/source/WEB-INF/web.xml

将路径配置一下：                  （注：这里的workspace/project/k16/vendor是我放源码的位置）

四、下载ctags

作用主要是扫描指定的源文件，找出其中所包含的语法元素，并将找到的相关内容记录下来。

step1.如果有exuberant ctags，则需要先卸载掉，因为这个已经不再维护，后面在进行相关操作会报错。

卸载命令：sudo apt-remove exuberant ctags

step2.下载universal-ctags的命令：

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

step3.下载完成了之后，进入ctags文件夹，依次执行以下命令，完成编译和安装：

./autogen.sh

./configure

make

sudo make install

(不知道每条命令什么意思？就按这个输上去就行了！)

step4.使用ctags --version查看版本信息 

step5.使用whereis ctags查看安装路径，后面索引时会用到

 

step6.在网址中打开localhost:8080/source,如果能够正常显示OpenGrok搜索界面说明配置成功。（但是会有错误：因为我们还没有进行索引，只要能显示界面就能就算成功）

opengrok与要导入的源码建立索引

java -Xmx8g    

-jar /home/yjm/opengrok/opengrok-1.1-rc41/lib/opengrok.jar  -c /usr/local/bin/ctags    

-s /home/yjm/opengrok/workspace/project/k16    

-d /home/yjm/opengrok/opengrok-1.1.rc41/data -H -P -S -G -v    

-W /home/yjm/opengrok/opengrok-1.1.rc41/etc/configuration.xml -U http://localhost:8080/source    

-m 256

注：这里要把各个参数都设置好，看好每个参数的函数所对应的文件：

-Xmx8g：配置Java最大堆内存为8g，防止内存溢出。（这里我们不改）

-jar：指定opengrok.jar:指定opengrok.jar包.（这里我们也不改）

-c  ：指定universal-ctags的路径，这里我们之前获得过ctags的路径。

-s  ：指定源码路径，我的源码路径在/home/yjm/opengrok/workspace/project/k16/vendor这个文件夹下，你要把这个路径设置成你源码所在的位置。

-d  ：指定文件存放路径，在上面的路径下新建data文件夹

-w  ：指定configuration.xml的路径

（注意这里我们要在/home/yjm/tomcat/apache-tomcat-8.5.69/webapps/source/WEB-INF文件夹下的web.xml文件中指定路径：

）

-m  ：指定opengrok索引时的缓存大小，默认只有16M

然后你就可以执行了，如果你的代码的文件比较大的话，就耐心的等一下，等运行完了之后，再次进入到localhost:8080/source的界面就能成功了