Skip to content

Commit 15936b0

Browse files
author
Vladimir Kotal
authored
document env vars properly
1 parent 8925909 commit 15936b0

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

docker/README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,15 @@ The container exports ports 8080 for OpenGrok.
6767

6868
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.
6969

70-
By default, the index will be rebuild every ten minutes. You can adjust this
71-
time (in minutes) by passing the `REINDEX` environment variable:
70+
## Environment Variables
7271

73-
docker run -d -e REINDEX=30 -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
72+
| Docker Environment Var. | Description |
73+
| ----------------------- | ----------- |
74+
`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+
`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+
`NOMIRROR` | To avoid the mirroring step, set the variable to non-empty value.
7477

75-
Setting `REINDEX` to `0` will disable automatic indexing. You can manually trigger an reindex using docker exec:
76-
77-
docker exec <container> /scripts/index.sh
78-
79-
Setting `INDEXER_OPT` could pass extra options to opengrok-indexer. For example, you can run with:
80-
81-
docker run -d -e INDEXER_OPT="-i d:vendor" -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
82-
83-
To remove all the `*/vendor/*` files from the index. You can check the indexer options on
84-
85-
https://github.com/oracle/opengrok/wiki/Python-scripts-transition-guide
86-
87-
To avoid the mirroring step, set the `NOMIRROR` variable to non-empty value.
78+
To specify environment variable for `docker run`, use the `-e` option, e.g. `-e REINDEX=30`
8879

8980
## OpenGrok Web-Interface
9081

0 commit comments

Comments
 (0)