aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-10-16 17:42:41 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-10-16 17:42:41 +0300
commit01942f915a9f14b933430fc434e339cadeeb5114 (patch)
tree06909eb66f829f412ef67fbd01728bb8df46164f /README.md
parentworkflows/ci: run SSH integration tests (diff)
downloadcgitize-01942f915a9f14b933430fc434e339cadeeb5114.tar.gz
cgitize-01942f915a9f14b933430fc434e339cadeeb5114.zip
README: update
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4b3490f..c24088e 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,11 @@ 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.
+Supports cloning all of your repositories from major hosting providers:
+
+* GitHub,
+* Bitbucket,
+* Gitlab.
Example output can be found at https://egort.name/git/.
@@ -33,8 +38,7 @@ tokens/application passwords).
The image is **egortensin/cgitize**.
The container reads the config from /etc/cgitize/cgitize.toml and writes the
repositories to /var/tmp/cgitize.
-If SSH is required, the socket should be mapped to
-/var/run/cgitize/ssh-agent.sock.
+If SSH is required, map the socket to /var/run/cgitize/ssh-agent.sock.
docker run -it --rm \
-v "/path/to/config:/etc/cgitize:ro" \