From e89cfb1e3669e84a2076ecf3c3210a23ba9b83b7 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Mon, 11 Apr 2022 05:54:06 +0200 Subject: README: update --- README.md | 7 +++++-- docker/README.md | 4 ++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 69716b0..30dc912 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ cgitize [![CI](https://github.com/egor-tensin/cgitize/actions/workflows/ci.yml/badge.svg)](https://github.com/egor-tensin/cgitize/actions/workflows/ci.yml) -Mirror your git repositories and make them cgit-ready. +Self-host your repositories using cgit. Supports cloning all of your repositories from major hosting providers: * GitHub, @@ -35,7 +35,10 @@ tokens/application passwords). ### Docker -Please see [docker/README.md](docker/README.md). +You can run `cgitize` in a Docker container. +A separate image includes a web server with a configured cgit installation. + +Please see [docker/README.md](docker/README.md) for details. Mirror maintenance ------------------ diff --git a/docker/README.md b/docker/README.md index b0c88b1..096796c 100644 --- a/docker/README.md +++ b/docker/README.md @@ -25,11 +25,11 @@ There's a web server image with a working cgit installation. * `/etc/cgitrc`: if you use a custom cgit configuration, map it here. It could look like this: - # Include most common useful settings. + # Generally useful and opionated settings, included in the image. include=/etc/cgit/common # If you serve from a subdirectory. - virtual-root=/secret/ + virtual-root=/custom/ root-title=Custom title root-desc=Custom description -- cgit v1.2.3