Skip to content

Commit 33551f1

Browse files
author
Vladimir Kotal
authored
document docker-compose
1 parent 15936b0 commit 33551f1

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

docker/README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,43 @@ http://localhost:8080/
8585

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

88-
### Build image locally
88+
## Using Docker compose
89+
90+
[Docker-compose](https://docs.docker.com/compose/install/) example:
91+
92+
```yaml
93+
version: "3"
94+
95+
# More info at https://github.com/oracle/opengrok/docker/
96+
services:
97+
opengrok:
98+
container_name: opengrok
99+
image: opengrok/docker:latest
100+
ports:
101+
- "8080:8080/tcp"
102+
environment:
103+
REINDEX: '60'
104+
# Volumes store your data between container upgrades
105+
volumes:
106+
- '~/opengrok-src/:/opengrok/src/'
107+
```
108+
109+
Save the file into `docker-compose.yml` and then simply run
110+
111+
docker-compose up -d
112+
113+
Equivalent `docker run` command would look like this:
114+
115+
```bash
116+
docker run -d \
117+
--name opengrok \
118+
-p 8080:8080/tcp \
119+
-e REINDEX="60" \
120+
-v "~/opengrok-src/:/opengrok/src/" \
121+
opengrok/docker:latest
122+
```
123+
124+
## Build image locally
89125

90126
If you want to do your own development, you can build the image yourself:
91127

0 commit comments

Comments
 (0)