Skip to content

Commit f384858

Browse files
committed
update readme for run opengrok as container
1 parent 4aedc80 commit f384858

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

docker/readme.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# A Docker container for OpenGrok
44

5-
## OpenGrok from official source:
5+
## OpenGrok from official source
66

77
Directly downloaded from official source:
88
https://github.com/oracle/opengrok/releases/
@@ -15,7 +15,7 @@ The container is available from DockerHub at https://hub.docker.com/r/opengrok/d
1515

1616
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.
1717

18-
## Additional info about the container:
18+
## Additional info about the container
1919

2020
* Tomcat 9
2121
* JRE 8 (Required for Opengrok 1.0+)
@@ -27,12 +27,22 @@ repositories).
2727

2828
The indexer/mirroring is set so that it does not log into files.
2929

30-
## How to run:
30+
## How to run
3131

32-
The container exports ports 8080 for OpenGrok.
32+
### From DockerHub
3333

3434
docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
3535

36+
### Build image locally
37+
38+
docker build -t opengrok-dev .
39+
40+
Then run the container,
41+
42+
docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok-dev
43+
44+
The container exports ports 8080 for OpenGrok.
45+
3646
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.
3747

3848
By default, the index will be rebuild every ten minutes. You can adjust this

0 commit comments

Comments
 (0)