Skip to content

Commit 1106ade

Browse files
author
Vladimir Kotal
committed
rename and add more details
1 parent 6dce66a commit 1106ade

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

docker/readme.md renamed to docker/README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,22 @@
44

55
## OpenGrok from official source
66

7-
Directly downloaded from official source:
8-
https://github.com/oracle/opengrok/releases/
7+
Built from official source: https://github.com/oracle/opengrok/releases/
98

109
You can learn more about OpenGrok at http://oracle.github.io/opengrok/
1110

1211
The container is available from DockerHub at https://hub.docker.com/r/opengrok/docker/
1312

1413
## When not to use it
1514

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.
1723

1824
## Additional info about the container
1925

@@ -26,21 +32,15 @@ synchronize all its repositories (e.g. it will do `git pull` for Git
2632
repositories).
2733

2834
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.
2937

3038
## How to run
3139

3240
### From DockerHub
3341

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

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-
4444
The container exports ports 8080 for OpenGrok.
4545

4646
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/
7272

7373
The first reindex will take some time to finish. Subsequent reindex will be incremental so will take signigicantly less time.
7474

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+
7585
## Inspecting the container
7686

7787
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
8090
docker exec -it <container> bash
8191
```
8292

83-
Enjoy.
93+
Enjoy.

0 commit comments

Comments
 (0)