Skip to content

Commit 3aa96a7

Browse files
committed
Added DockerHub images to documentation.
1 parent 2b65e06 commit 3aa96a7

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Features
2929
Documentations
3030
--------
3131
- [User guide](doc/usage.md)
32+
- [Docker guide](docker/README.md)
3233

3334
Development
3435
--------

docker/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Table of Contents
3737
* [Build image for runtime](#build-image-for-runtime)
3838
* [Build image for webserver](#build-image-for-webserver)
3939
* [How to use the webserver executing container](#how-to-use-the-webserver-executing-container)
40+
* [Official DockerHub images](#official-dockerhub-images)
4041

4142
# Development
4243
## Build image from development
@@ -159,3 +160,23 @@ docker run \
159160
codecompass:web \
160161
CodeCompass_webserver -w /workspace
161162
```
163+
164+
# Official DockerHub images
165+
166+
Prebuilt images can be downloaded from DockerHub, from the
167+
[modelcpp/codecompass](https://hub.docker.com/r/modelcpp/codecompass)
168+
repository.
169+
170+
The following image tags are available:
171+
172+
| Name | Description |
173+
| ---- | ------------|
174+
| `dev` | Development image |
175+
| `runtime-sqlite` | Runtime image containing CodeCompass binaries built against SQLite |
176+
| `runtime-pgsql` | Runtime image containing CodeCompass binaries built against PostrgreSQL |
177+
| `web-sqlite` | Webserver executing container image built against SQLite |
178+
| `web-pgsql` | Webserver executing container image built against PostgreSQL |
179+
180+
The default `latest` is an alias to `:runtime-pgsql`.
181+
To download (or update) an image from DockerHub, issue the command
182+
`docker pull modelcpp/codecompass:latest`. (Replace `latest` with the desired tag.)

0 commit comments

Comments
 (0)