You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docker/README.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,22 @@
4
4
5
5
## OpenGrok from official source
6
6
7
-
Directly downloaded from official source:
8
-
https://github.com/oracle/opengrok/releases/
7
+
Built from official source: https://github.com/oracle/opengrok/releases/
9
8
10
9
You can learn more about OpenGrok at http://oracle.github.io/opengrok/
11
10
12
11
The container is available from DockerHub at https://hub.docker.com/r/opengrok/docker/
13
12
14
13
## When not to use it
15
14
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.
15
+
This image is simple wrapper around OpenGrok environment. The indexer and the web container are **not** tuned for large workloads.
16
+
If you happen to have one of the following:
17
+
- large source data (e.g. [AOSP](https://en.wikipedia.org/wiki/Android_Open_Source_Project) or the like)
18
+
- stable service
19
+
- Source Code Management systems not supported in the image (e.g. Perforce,
20
+
Clearcase, etc.)
21
+
then it is advisable to run OpenGrok standalone or construct your own docker
22
+
image based on the official one.
17
23
18
24
## Additional info about the container
19
25
@@ -26,21 +32,15 @@ synchronize all its repositories (e.g. it will do `git pull` for Git
26
32
repositories).
27
33
28
34
The indexer/mirroring is set so that it does not log into files.
35
+
Rather, everything goes to standard (error) output. To see how the indexer
36
+
is doing, use the `docker logs` command.
29
37
30
38
## How to run
31
39
32
40
### From DockerHub
33
41
34
42
docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok/docker:latest
35
43
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
44
The container exports ports 8080 for OpenGrok.
45
45
46
46
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.
@@ -72,6 +72,16 @@ http://localhost:8080/
72
72
73
73
The first reindex will take some time to finish. Subsequent reindex will be incremental so will take signigicantly less time.
74
74
75
+
### Build image locally
76
+
77
+
If you want to do your own development, you can build the image yourself:
78
+
79
+
docker build -t opengrok-dev .
80
+
81
+
Then run the container:
82
+
83
+
docker run -d -v <path/to/your/src>:/opengrok/src -p 8080:8080 opengrok-dev
84
+
75
85
## Inspecting the container
76
86
77
87
You can get inside a container using the [command below](https://docs.docker.com/engine/reference/commandline/exec/):
@@ -80,4 +90,4 @@ You can get inside a container using the [command below](https://docs.docker.com
0 commit comments