使用OpenGrok搭建 可搜索可跳转的源码 阅读网站

使用OpenGrok搭建 可搜索可跳转的源码 阅读网站

效果类似于 androidxref.com/

1. 在Linux环境下搭建 参考该链接 blog.csdn.net/haiyanghaiy…

2. 在windows环境下搭建

• 首先环境要求： JDK1.8，Ant 1.9.7,Tomcat 8.5.8，Git for windows客户端 (并配置环境变量)

• OpenGrok的windows环境下载： 参考链接 github.com/OpenGrok/Op…

  新建OpenGrok目录进入该目录下右键git bash在命令行窗口执行如下命令
  

2.1 下载OpenGrok 源码

git clone https://github.com/OpenGrok/OpenGrok

2.2 编译OpenGrok源码

ant

2.3 找到OpenGrok\OpenGrok\dist目录下

把source.war 拷贝到Tomcat安装目录下的webapps目录下

2.4 下载ctags.exe 并指定源码所在目录生成索引

前往 www.vim.org/scripts/scr…网址，下载ctags.exe 1.5版本，然后找到你本地
git for windows客户端 安装目录 进入 mingw64目录下的bin目录下，把下好的ctags.exe复制粘贴

git bash在命令行窗口 中cd OpenGrok 进入到源码（OpenGrok文件）所在目录然后输入如下命令
./OpenGrok index D:\sources\android-14（这里 D:\sources\android-14 换成你想看的源码所在位置） 这里将会生成配置文件以及索引文件在 git for windows客户端安装所在目录下面的var目录中（请更改权限最好让所有用户拥有读写权限 ,不然会导致
例如：CONFIGURATION parameter has not been configured in web.xml! Please configure your webapp.的问题）， 如果要更改源码位置，先删除var目录
再执行 `` ./OpenGrok index XXX`命令
执行该步后 OpenGrok将会在你的Git安装目录下 生成var目录，这里windows环境下内存是4G的同学要注意如下一个问题

./OpenGrok index D:/Android/sdk/sources
Loading the default instance configuration ...
Error occurred during initialization of VM
Could not reserve enough space for 2097152KB object heap
复制代码

这里执行./OpenGrok index操作的时候会提示你内存不够给VM分2097152KB，也就是VM内存申请失败 用notipad++ 可以看到你OpenGrok目录下的OpenGrok文件中有一行这样的代码JAVA_OPTS="${JAVA_OPTS:--Xmx2048m}"意思是默认分配2G给java VM，但是机器只有4G内存的同学 会分配失败，解决办法就是 把2048改成1024

然后修改tomcat安装目录下webapps中你的source目录下WEB-INF目录的web.xml文件中,对应如下修改(不改就会404)

<context-param>
 <description>Full path to the configuration file where OpenGrok can read its configuration</description>
 <param-name>CONFIGURATION</param-name>
 <param-value>你的Git安装目录/var/opengrok/etc/configuration.xml</param-value>
</context-param>
复制代码

2.5 在浏览器中输入网址 http://localhost:8080/source 即可打开 源码阅读网站

支持按内容搜索，支持按字段搜索，支持按文件名搜索等各种姿势搜索 ，而且不局限于Android源码，各种源码都可以看！