|
| 1 | +[](https://travis-ci.com/OpenGrok/docker) |
| 2 | + |
| 3 | +# A Docker container for OpenGrok |
| 4 | + |
| 5 | +## OpenGrok from official source: |
| 6 | + |
| 7 | +Directly downloaded from official source: |
| 8 | +https://github.com/oracle/opengrok/releases/ |
| 9 | + |
| 10 | +You can learn more about OpenGrok at http://oracle.github.io/opengrok/ |
| 11 | + |
| 12 | +The container is available from DockerHub at https://hub.docker.com/r/opengrok/docker/ |
| 13 | + |
| 14 | +## When not to use it |
| 15 | + |
| 16 | +This image is simple wrapper around OpenGrok environment. The indexer and the web container are **not** tuned for large workloads. If you happen to have either large source data (e.g. [AOSP](https://en.wikipedia.org/wiki/Android_Open_Source_Project) or the like) or stable service or both, it is advisable to run the service standalone. |
| 17 | + |
| 18 | +## Additional info about the container: |
| 19 | + |
| 20 | +* Tomcat 9 |
| 21 | +* JRE 8 (Required for Opengrok 1.0+) |
| 22 | +* Configurable mirroring/reindexing (default every 10 min) |
| 23 | + |
| 24 | +The mirroring step works by going through all projects and attempting to |
| 25 | +synchronize all its repositories (e.g. it will do `git pull` for Git |
| 26 | +repositories). |
| 27 | + |
| 28 | +The indexer/mirroring is set so that it does not log into files. |
| 29 | + |
| 30 | +## How to run: |
| 31 | + |
| 32 | +The container exports ports 8080 for OpenGrok. |
| 33 | + |
| 34 | + docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest |
| 35 | + |
| 36 | +The 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. |
| 37 | + |
| 38 | +By default, the index will be rebuild every ten minutes. You can adjust this |
| 39 | +time (in minutes) by passing the `REINDEX` environment variable: |
| 40 | + |
| 41 | + docker run -d -e REINDEX=30 -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest |
| 42 | + |
| 43 | +Setting `REINDEX` to `0` will disable automatic indexing. You can manually trigger an reindex using docker exec: |
| 44 | + |
| 45 | + docker exec <container> /scripts/index.sh |
| 46 | + |
| 47 | +Setting `INDEXER_OPT` could pass extra options to opengrok-indexer. For example, you can run with: |
| 48 | + |
| 49 | + docker run -d -e INDEXER_OPT="-i d:vendor" -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest |
| 50 | + |
| 51 | +To remove all the `*/vendor/*` files from the index. You can check the indexer options on |
| 52 | + |
| 53 | +https://github.com/oracle/opengrok/wiki/Python-scripts-transition-guide |
| 54 | + |
| 55 | +To avoid the mirroring step, set the `NOMIRROR` variable to non-empty value. |
| 56 | + |
| 57 | +## OpenGrok Web-Interface |
| 58 | + |
| 59 | +The container has OpenGrok as default web app installed (accessible directly from `/`). With the above container setup, you can find it running on |
| 60 | + |
| 61 | +http://localhost:8080/ |
| 62 | + |
| 63 | +The first reindex will take some time to finish. Subsequent reindex will be incremental so will take signigicantly less time. |
| 64 | + |
| 65 | +## Inspecting the container |
| 66 | + |
| 67 | +You can get inside a container using the [command below](https://docs.docker.com/engine/reference/commandline/exec/): |
| 68 | + |
| 69 | +``` |
| 70 | +docker exec -it <container> bash |
| 71 | +``` |
| 72 | + |
| 73 | +Enjoy. |
0 commit comments