📝 Update README with complete Docker run documentation 📝

Rewrite README.md to accurately reflect the container's three bundled services (Gitea, dockerd DinD, act_runner) and all required runtime details that were missing from the previous sparse version. - README.md: add full description of Gitea + DinD + act_runner all-in-one image - README.md: add --privileged note explaining DinD cgroup requirement - README.md: document all four ports (80/7833/2375/44015) with service labels - README.md: add volumes table (/config, /data) with descriptions - README.md: add environment variables table (TZ, SERVER_ADDRESS, SERVER_TOKEN, RUNNER_LABELS, RUNNERS_START, RUNNERS_LOG_DIR) - README.md: update docker-compose with all ports and privileged flag - README.md: add docker-compose YYMM date tag convention note - README.md: follow canonical section order (Docker → Development → License) README.md
2026-06-23 20:01:01 -04:00 · 2026-05-24 19:42:34 -04:00
parent 895520eb77
commit 04b36738f6
1 changed files with 103 additions and 65 deletions
@@ -1,79 +1,117 @@
-## 👋 Welcome to gitea 🚀  
+# gitea

-gitea README  
+An all-in-one Alpine-based Docker image that bundles **Gitea** (self-hosted Git service), **Docker-in-Docker** (dockerd), and **act_runner** (Gitea Actions CI runner) into a single container. Designed for teams that want a complete self-hosted Git + CI/CD stack without orchestrating multiple containers. Gitea is pre-configured with Actions enabled, SSH access, LFS, and five act_runner worker instances that register automatically on first boot.

+---

-## Install my system scripts  
+## 🐳 Docker
+
+### Pull and run

 ```shell
- sudo bash -c "$(curl -q -LSsf "https://github.com/systemmgr/installer/raw/main/install.sh")"
- sudo systemmgr --config && sudo systemmgr install scripts  
-```
-  
-## Automatic install/update  
-  
-```shell
-dockermgr update gitea
-```
-  
-## Install and run container
-  
-```shell
-dockerHome="/var/lib/srv/$USER/docker/casjaysdevdocker/gitea/gitea/latest/rootfs"
-mkdir -p "/var/lib/srv/$USER/docker/gitea/rootfs"
-git clone "https://github.com/dockermgr/gitea" "$HOME/.local/share/CasjaysDev/dockermgr/gitea"
-cp -Rfva "$HOME/.local/share/CasjaysDev/dockermgr/gitea/rootfs/." "$dockerHome/"
 docker run -d \
  --restart always \
  --privileged \
  --name casjaysdevdocker-gitea-latest \
  --hostname gitea \
  -e TZ=${TIMEZONE:-America/New_York} \
-v "$dockerHome/data:/data:z" \
-v "$dockerHome/config:/config:z" \
+  -v /var/lib/srv/$USER/docker/casjaysdevdocker/gitea/data:/data:z \
+  -v /var/lib/srv/$USER/docker/casjaysdevdocker/gitea/config:/config:z \
  -p 80:80 \
+  -p 7833:7833 \
+  -p 2375:2375 \
+  -p 44015:44015 \
  casjaysdevdocker/gitea:latest
 ```

-## via docker-compose  
+> **Note:** `--privileged` is required — the container runs a full Docker daemon (DinD) and needs cgroup v2 access.
+
+### Ports
+
+| Port | Protocol | Service | Description |
+|------|----------|---------|-------------|
+| `80` | TCP | Gitea | Web UI and HTTP clone |
+| `7833` | TCP | sshd | Git SSH access (`git clone git@host:user/repo`) |
+| `2375` | TCP | dockerd | Docker daemon (plain HTTP — bind to localhost or a trusted network only) |
+| `44015` | TCP | act_runner | Actions artifact/cache server |
+
+### Volumes
+
+| Path | Description |
+|------|-------------|
+| `/config` | Gitea config, SSH host keys, act_runner registration state |
+| `/data` | Gitea repositories, LFS objects, SQLite database, Docker layer cache |
+
+### Environment variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `TZ` | `America/New_York` | Container timezone |
+| `SERVER_ADDRESS` | `http://localhost` | Gitea URL used by act_runner for self-registration |
+| `SERVER_TOKEN` | *(auto-generated)* | act_runner registration token — generated from Gitea on first boot if not set |
+| `RUNNER_LABELS` | *(runner default)* | Comma-separated labels applied to all registered runners |
+| `RUNNERS_START` | `5` | Number of act_runner worker instances to start |
+| `RUNNERS_LOG_DIR` | `/var/log/act_runner` | Directory for per-runner log files |
+
+### docker-compose

 ```yaml
-version: "2"
 services:
-  ProjectName:
-    image: casjaysdevdocker/gitea
+  gitea:
+    image: casjaysdevdocker/gitea:latest
    container_name: casjaysdevdocker-gitea
+    restart: always
+    privileged: true
+    hostname: gitea
    environment:
      - TZ=America/New_York
-      - HOSTNAME=gitea
+      - RUNNERS_START=5
    volumes:
-      - "/var/lib/srv/$USER/docker/casjaysdevdocker/gitea/gitea/latest/rootfs/data:/data:z"
-      - "/var/lib/srv/$USER/docker/casjaysdevdocker/gitea/gitea/latest/rootfs/config:/config:z"
+      - /var/lib/srv/$USER/docker/casjaysdevdocker/gitea/data:/data:z
+      - /var/lib/srv/$USER/docker/casjaysdevdocker/gitea/config:/config:z
    ports:
      - 80:80
-    restart: always
+      - 7833:7833
+      - 2375:2375
+      - 44015:44015
 ```

-## Get source files  
+### Automatic install/update via dockermgr

 ```shell
-dockermgr download src casjaysdevdocker/gitea
+dockermgr update gitea
 ```

-OR
+---
+
+## 🛠️ Development
+
+### Get source files

 ```shell
 git clone "https://github.com/casjaysdevdocker/gitea" "$HOME/Projects/github/casjaysdevdocker/gitea"
 ```

-## Build container  
+### 🐳 Docker build
+
+The image builds for `linux/amd64` and `linux/arm64` via BuildX. Gitea and act_runner binaries are downloaded from GitHub/Gitea APIs at build time.

 ```shell
 cd "$HOME/Projects/github/casjaysdevdocker/gitea"
 buildx
 ```

-## Authors  
+Image tags pushed: `casjaysdevdocker/gitea:latest` and `casjaysdevdocker/gitea:YYMM` (date tag).
+
+---
+
+## 👤 Authors

 🤖 casjay: [Github](https://github.com/casjay) 🤖  
 ⛵ casjaysdevdocker: [Github](https://github.com/casjaysdevdocker) [Docker](https://hub.docker.com/u/casjaysdevdocker) ⛵
+
+---
+
+## 📄 License
+
+MIT — see [LICENSE.md](LICENSE.md)