1e2736ff6SVladimir Kotal[](https://microbadger.com/images/opengrok/docker "Get your own image badge on microbadger.com") 2e2736ff6SVladimir Kotal[](https://microbadger.com/images/opengrok/docker "Get your own version badge on microbadger.com") 3e2736ff6SVladimir Kotal 41106ade6SVladimir Kotal# A Docker container for OpenGrok 51106ade6SVladimir Kotal 61106ade6SVladimir Kotal## OpenGrok from official source 71106ade6SVladimir Kotal 81106ade6SVladimir KotalBuilt from official source: https://github.com/oracle/opengrok/releases/ 91106ade6SVladimir Kotal 101106ade6SVladimir KotalYou can learn more about OpenGrok at http://oracle.github.io/opengrok/ 111106ade6SVladimir Kotal 121106ade6SVladimir KotalThe container is available from DockerHub at https://hub.docker.com/r/opengrok/docker/ 131106ade6SVladimir Kotal 141106ade6SVladimir Kotal## When not to use it 151106ade6SVladimir Kotal 16bc2f6de0SVladimir KotalThis image is simple wrapper around OpenGrok environment. It is basicallyt a small appliance. The indexer and the web container are **not** tuned for large workloads. 17bc2f6de0SVladimir Kotal 181106ade6SVladimir KotalIf you happen to have one of the following: 191106ade6SVladimir Kotal - large source data (e.g. [AOSP](https://en.wikipedia.org/wiki/Android_Open_Source_Project) or the like) 201106ade6SVladimir Kotal - stable service 211106ade6SVladimir Kotal - Source Code Management systems not supported in the image (e.g. Perforce, 221106ade6SVladimir Kotal Clearcase, etc.) 23bc2f6de0SVladimir Kotal - need for authentication/authorization 24703bf669SVladimir Kotal 25bc2f6de0SVladimir Kotalthen it is advisable to run OpenGrok standalone or construct your own Docker 261106ade6SVladimir Kotalimage based on the official one. 271106ade6SVladimir Kotal 28f70822c2SVladimir Kotal## Additional info about the image 291106ade6SVladimir Kotal 301106ade6SVladimir Kotal* Tomcat 9 311106ade6SVladimir Kotal* JRE 8 (Required for Opengrok 1.0+) 321106ade6SVladimir Kotal* Configurable mirroring/reindexing (default every 10 min) 331106ade6SVladimir Kotal 341106ade6SVladimir KotalThe mirroring step works by going through all projects and attempting to 351106ade6SVladimir Kotalsynchronize all its repositories (e.g. it will do `git pull` for Git 361106ade6SVladimir Kotalrepositories). 371106ade6SVladimir Kotal 38ab135123SVladimir Kotal### Indexer logs 39ab135123SVladimir Kotal 401106ade6SVladimir KotalThe indexer/mirroring is set so that it does not log into files. 411106ade6SVladimir KotalRather, everything goes to standard (error) output. To see how the indexer 421106ade6SVladimir Kotalis doing, use the `docker logs` command. 431106ade6SVladimir Kotal 4484ed967bSVladimir Kotal### Source Code Management systems supported 4584ed967bSVladimir Kotal 4684ed967bSVladimir Kotal- Mercurial 4784ed967bSVladimir Kotal- Git 4884ed967bSVladimir Kotal- Subversion 4984ed967bSVladimir Kotal 50f70822c2SVladimir Kotal### Tags and versioning 51f70822c2SVladimir Kotal 52eea6103dSVladimir KotalEach OpenGrok release triggers creation of new Docker image. 53eea6103dSVladimir Kotal 54eea6103dSVladimir Kotal| Tag | Note | 55eea6103dSVladimir Kotal| -------- |:--------------------------------------------------------| 56eea6103dSVladimir Kotal| `latest` | tracks the latest version | 57eea6103dSVladimir Kotal| `x.y.z` | if you want to pin against a specific version | 58eea6103dSVladimir Kotal| `x.y` | stay on micro versions to avoid reindexing from scratch | 59f70822c2SVladimir Kotal 601106ade6SVladimir Kotal## How to run 611106ade6SVladimir Kotal 621106ade6SVladimir Kotal### From DockerHub 631106ade6SVladimir Kotal 641106ade6SVladimir Kotal docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest 651106ade6SVladimir Kotal 661106ade6SVladimir KotalThe container exports ports 8080 for OpenGrok. 671106ade6SVladimir Kotal 681106ade6SVladimir KotalThe volume mounted to `/opengrok/src` should contain the projects you want to make searchable (in sub directories). You can use common revision control checkouts (git, svn, etc...) and OpenGrok will make history and blame information available. 691106ade6SVladimir Kotal 70*15936b04SVladimir Kotal## Environment Variables 711106ade6SVladimir Kotal 72*15936b04SVladimir Kotal| Docker Environment Var. | Description | 73*15936b04SVladimir Kotal| ----------------------- | ----------- | 74*15936b04SVladimir Kotal`REINDEX: <time_in_minutes>`<br/> *Optional* *Default: 10* | Period of automatic mirroring/reindexing. Setting to `0` will disable automatic indexing. You can manually trigger an reindex using docker exec: `docker exec <container> /scripts/index.sh` 75*15936b04SVladimir Kotal`INDEXER_OPT` | pass extra options to opengrok-indexer. For example, "-i d:vendor" will remove all the `*/vendor/*` files from the index. You can check the indexer options on https://github.com/oracle/opengrok/wiki/Python-scripts-transition-guide 76*15936b04SVladimir Kotal`NOMIRROR` | To avoid the mirroring step, set the variable to non-empty value. 771106ade6SVladimir Kotal 78*15936b04SVladimir KotalTo specify environment variable for `docker run`, use the `-e` option, e.g. `-e REINDEX=30` 791106ade6SVladimir Kotal 801106ade6SVladimir Kotal## OpenGrok Web-Interface 811106ade6SVladimir Kotal 821106ade6SVladimir KotalThe container has OpenGrok as default web app installed (accessible directly from `/`). With the above container setup, you can find it running on 831106ade6SVladimir Kotal 841106ade6SVladimir Kotalhttp://localhost:8080/ 851106ade6SVladimir Kotal 861106ade6SVladimir KotalThe first reindex will take some time to finish. Subsequent reindex will be incremental so will take signigicantly less time. 871106ade6SVladimir Kotal 881106ade6SVladimir Kotal### Build image locally 891106ade6SVladimir Kotal 901106ade6SVladimir KotalIf you want to do your own development, you can build the image yourself: 911106ade6SVladimir Kotal 926670a14aSVladimir Kotal mvn -DskipTests=true clean package && \ 931106ade6SVladimir Kotal docker build -t opengrok-dev . 941106ade6SVladimir Kotal 951106ade6SVladimir KotalThen run the container: 961106ade6SVladimir Kotal 971106ade6SVladimir Kotal docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok-dev 981106ade6SVladimir Kotal 991106ade6SVladimir Kotal## Inspecting the container 1001106ade6SVladimir Kotal 1011106ade6SVladimir KotalYou can get inside a container using the [command below](https://docs.docker.com/engine/reference/commandline/exec/): 1021106ade6SVladimir Kotal 1031106ade6SVladimir Kotal``` 1041106ade6SVladimir Kotaldocker exec -it <container> bash 1051106ade6SVladimir Kotal``` 1061106ade6SVladimir Kotal 1071106ade6SVladimir KotalEnjoy. 108
){kind=link}
){kind=link}