miao_opengrok

写了一个小js来管理docker版的opengrok

1.目的

该项目仅仅是管理docker版的opengrok的，在docker版中，需要将本机的一个目录挂载到docker容器中的opengrok源码目录。在非docker版中，大部分人是直接将项目目录的软连接放到opengrok的源码目录中的，然而在docker版中，因为软连接指向的目录并未被挂载到docker中，所以会出现读取不到的问题，故而写了这么个小东西，可以自动遍历所有的项目软连接，找寻其真实目录将其挂载到docker中，用户只需要一个专门的存放软连接的目录即可。该软件会生成对应的docker-compose.yml文件，用户只需要在使用docker-compose的之后指定该配置文件即可。后续功能尚在持续研究中。

2.安装

首先，需要安装docker、docker-compose、docker版的oepngrok,笔者使用的是itszero/opengrok 这个镜像，故而默认配置是按照该镜像制作的，其他镜像的话需要有一定的小改动，不过问题不大。

npm install -g miao_opengrok

3.使用

基础的使用可以参考miao_opengrok -h 为了更良好的体验，需要设置系统变量OPENGROK_READ_DIR=你的放软连接的目录,在这个系统变量存在的情况下，每个命令的src_path参数就都可以省略，否则，就需要手动指定src目录

4.补充

可以使用-c参数选择一个json文件来作为配置文件，完整的json文件格式如下：

{
  "name":"xxx",//你的启动后的容器名
  "image":"xxx",//指定使用的docker镜像，默认是itszero/opengrok
  "ports":["8888:8080"],//指定暴露的端口绑定，另外，必须有一个端口和8080绑定，默认是8888:8080
  "runDir":"./",//指定放置软连接的目录的位置，但是建议使用系统变量的方式设定
  "outputFile":"docker-compose.yml"//默认输出的文件名
}