From 5a792fee1335ea60ca6930dddb6080bcf869213d Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sat, 27 Mar 2021 23:17:14 +0300 Subject: further renaming work --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3a984bc..db0e609 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,42 @@ cgitize ======= -[![Test](https://github.com/egor-tensin/cgit-repos/workflows/Test/badge.svg)](https://github.com/egor-tensin/cgit-repos/actions?query=workflow%3ATest) +[![Test](https://github.com/egor-tensin/cgitize/workflows/Test/badge.svg)](https://github.com/egor-tensin/cgitize/actions?query=workflow%3ATest) Mirror your git repositories and make them cgit-ready. Usage ----- -Adjust the config in [examples/cgit-repos.conf] and pass it using the +Adjust the config in [examples/cgitize.conf] and pass it using the `--config` parameter: - > python3 -m cgitize.main --config path/to/cgit-repos.conf + > python3 -m cgitize.main --config path/to/cgitize.conf The repository list is stored in my_repos.py (the `my_repos` setting in the config). See [examples/my_repos.py] for an example. -cgit/repos/main.py calls git, which might call ssh internally. +cgitize/main.py calls git, which might call ssh internally. Make sure the required keys are loaded to a ssh-agent. -[examples/cgit-repos.conf]: examples/cgit-repos.conf +[examples/cgitize.conf]: examples/cgitize.conf [examples/my_repos.py]: examples/my_repos.py ### Docker The image is **egortensin/cgitize**. -The container reads the config from */etc/cgit-repos/cgit-repos.conf* and -writes the repositories to */var/tmp/cgit-repos/output*. +The container reads the config from */etc/cgitize/cgitize.conf* and +writes the repositories to */var/tmp/cgitize/output*. If SSH is required, the socket should be mapped to -*/var/run/cgit-repos/ssh-agent.sock*. +*/var/run/cgitize/ssh-agent.sock*. For example: > docker run -it --rm \ - -v "/path/to/config:/etc/cgit-repos:ro" \ - -v "$SSH_AUTH_SOCK:/var/run/cgit-repos/ssh-agent.sock" \ - -v "/path/to/output:/var/tmp/cgit-repos/output" \ + -v "/path/to/config:/etc/cgitize:ro" \ + -v "$SSH_AUTH_SOCK:/var/run/cgitize/ssh-agent.sock" \ + -v "/path/to/output:/var/tmp/cgitize/output" \ egortensin/cgitize ### my_repos.py -- cgit v1.2.3