diff options
| -rw-r--r-- | README.md | 51 | ||||
| -rw-r--r-- | docker/README.md | 49 |
2 files changed, 50 insertions, 50 deletions
@@ -35,56 +35,7 @@ tokens/application passwords). ### Docker -The image is **egortensin/cgitize**. - -| Path | Description -| ------------------------- | ----------- -| /etc/cgitize/cgitize.toml | Configuration file path. -| /mnt/cgitize | Default output directory for cloned repositories. -| /ssh-agent.sock | If SSH is required, map the socket here. - -| Environemnt variable | Description -| -------------------- | ----------- -| SCHEDULE | cron job schedule \[1\]. - -1. cgitize is executed as a cron job inside the container. -The `SCHEDULE` environment variable controls how often it gets run. -By default, it's set to `once`, which makes the container exit after the first -run. -You can also set it to `15min`, `hourly`, `daily`, `weekly`, `monthly` or a -custom 5-part cron schedule like `*/5 * * * *`. - -#### Frontend - -There's a web server image with a working cgit installation: -**egortensin/cgitize-frontend**. - -| Path | Description -| ------------ | ----------- -| /etc/cgitrc | If you use a custom cgit configuration, map it here \[1\]. -| /mnt/cgitize | Map cgitize's output directory here. - -1. A custom cgitrc might look like this: - - # Include most common useful settings. - include=/etc/cgit/common - - # If you serve from a subdirectory. - virtual-root=/secret/ - - root-title=Custom title - root-desc=Custom description - -#### 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 - - docker-compose build - docker-compose up -d - -and visiting http://localhost:80/. +Please see [docker/README.md](docker/README.md). Mirror maintenance ------------------ diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..c6f973a --- /dev/null +++ b/docker/README.md @@ -0,0 +1,49 @@ +cgitize in Docker +================= + +cgitize is executed as a cron job inside the container. +The `SCHEDULE` environment variable controls how often it gets run (see below). + +* Image: **egortensin/cgitize** +* Volumes: + * `/etc/cgitize/cgitize.toml`: configuration file path. + * `/mnt/cgitize`: by default, cloned repositories will be written here. + * `/ssh-agent.sock`: if you use SSH, map the agent socket here. +* Environment variables: + * `SCHEDULE`: defaults to "once", which makes the container exit after the +first run. +You can also set it to "15min", "hourly", "daily", "weekly", "monthly" or a +custom 5-part cron schedule like "*/5 * * * *". + +Frontend +-------- + +There's a web server image with a working cgit installation. + +* Image: **egortensin/cgitize-frontend** +* Volumes: + * `/etc/cgitrc`: if you use a custom cgit configuration, map it here. +It can look like this: + + # Include most common useful settings. + include=/etc/cgit/common + + # If you serve from a subdirectory. + virtual-root=/secret/ + + root-title=Custom title + root-desc=Custom description + + * `/mnt/cgitize`: map cgitize's output directory here. + +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 + + docker-compose build + docker-compose up -d + +and visiting http://localhost:80/. |