aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--DEVELOPMENT.md2
-rw-r--r--docker/README.md34
2 files changed, 31 insertions, 5 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 487c318..e88be2f 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -43,3 +43,5 @@ Releases
* Make a git tag for a new minor version using `make tag`.
You can then review it and push using `git push --tags`.
+* For a new major version, update the version in the docker-compose definition
+in docker/README.md.
diff --git a/docker/README.md b/docker/README.md
index 5fc8f7e..ec7f89d 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -39,11 +39,35 @@ It could look like this:
Compose
-------
-See the root docker-compose.yml file for a possible services definition.
-In this configuration, cgitize pulls my repositories from GitHub every 3 hours.
-You can test it by running
+Here's an example docker-compose.yml file:
+
+ version: '3'
+
+ services:
+ cgitize:
+ environment:
+ # Every 3 hours:
+ SCHEDULE: '0 */3 * * *'
+ # Set CGITIZE_{GITHUB,BITBUCKET,GITLAB}_{USERNAME,TOKEN} variables
+ # here or in the config file.
+ image: egortensin/cgitize:5
+ restart: unless-stopped
+ volumes:
+ - ./example.toml:/etc/cgitize/cgitize.toml:ro
+ - /srv/volumes/cgitize:/mnt/cgitize
+ frontend:
+ image: egortensin/cgitize-frontend:5
+ ports:
+ - '127.0.0.1:80:80'
+ restart: unless-stopped
+ volumes:
+ - /srv/volumes/cgitize:/mnt/cgitize:ro
+
+In this configuration, cgitize pulls repositories defined in example.toml every
+3 hours and puts them to /srv/volumes/cgitize on the host.
+
+To launch containers, run:
- docker-compose build
docker-compose up -d
-and visiting http://localhost:80/.
+To inspect the repositories, visit http://localhost:80/.