From ad66e2f3a9bb2c4d2a7566151d75986d459c4e5b Mon Sep 17 00:00:00 2001 From: Tim Date: Fri, 3 Jan 2025 13:02:13 +0100 Subject: Add README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..2e098b0 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# GitAutoFetch + +Fetch your git repos and clear your cgit cache every hour. + +## Usage + +Create a .env File with the following environment variables: + +| name | description | default | +|----------------------|----------------------------------------------------------------------|----------| +| GIT_DIRECTORY | The path to the directory where your git repositories are. | ./repos/ | +| CGIT_CACHE_DIRECTORY | The CGit cache directory, leave blank to disable clearing the cache. | | + +Now run the Program from the same directory. Alternatively you can provide the environment variables to the process. +The ``gitautofetch.service`` file could be a good template for a systemd service that runs GitAutoFetch in the background. -- cgit v1.2.3