1 files changed, 36 insertions, 0 deletions

diff --git a/examples/git.igorek.dev/README.md b/examples/git.igorek.dev/README.md
new file mode 100644
index 0000000..d048150
--- /dev/null
+++ b/examples/git.igorek.dev/README.md
@@ -0,0 +1,36 @@
+# How to setup
+
+## Create git user
+
+Create a `git` user in the /repo folder
+
+```sh
+sudo useradd --home-dir $PWD/repos/ git
+sudo mkdir repos/
+sudo chown -R git:git repos/
+```
+
+## Create some repos
+
+```sh
+sudo su - git
+git init --bare test
+exit
+```
+
+## Edit a repos config file
+
+Put something like that into `./etc/repos` file
+
+```txt
+repo.url=test
+repo.path=/app/repos/test
+repo.desc=The test repository
+repo.readme=:README.md
+```
+
+## Run the docker image
+
+```ssh
+docker compose --up -d
+```