aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArianit K <arianit@hax.al>2025-06-01 10:45:09 +0000
committerArianit K <arianit@hax.al>2025-06-01 10:45:09 +0000
commitae8b61718dc17d20057eb9d4a7b902f379ab9c9e (patch)
treeb65bf68f18d2ed6e9145fe9735761043ea586e3c
parentSimple git docker image. (diff)
downloadhaxgit-ae8b61718dc17d20057eb9d4a7b902f379ab9c9e.tar.gz
haxgit-ae8b61718dc17d20057eb9d4a7b902f379ab9c9e.zip
Updating README
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index a984908..992d894 100644
--- a/README.md
+++ b/README.md
@@ -22,8 +22,32 @@ docker pull savagedot/haxgit
Run the container with:
```bash
+# haxgit - Lightweight cgit Docker Container
+
+A complete, ready-to-run cgit solution with website and SSH access, packaged in Docker.
+
+## Features
+
+- Full cgit web interface
+- Integrated SSH server for git operations
+- Persistent storage for repositories and configuration
+- Pre-configured with sensible defaults
+- Lightweight Alpine Linux base
+
+## Quick Start
+
+
+Pull the image:
+
+```bash
+docker pull savagedot/haxgit
+```
+
+Run the container with:
+
+```bash
docker run -d --rm \
- --name docker_cgit \
+ --name hax_cgit \
-p 64801:80 -p 64822:22 \
-v $PWD/data/git:/home/git \
-v $PWD/data/repositories:/home/git/repositories \
@@ -31,3 +55,4 @@ docker run -d --rm \
-v $PWD/data/web:/var/www \
savagedot/haxgit
```
+