Adding comprehensive comments

gitea-runner/docker-compose-multi.yml

@@ -1,42 +1,61 @@
+# Gitea Multiple Actions Runners Configuration
 services:
+  # First Gitea Runner Instance
   gitea_runner1:
+    # Basic container configuration
     container_name: gitea_runner1
     image: docker.io/gitea/act_runner:0.2.12
     restart: unless-stopped
+    
+    # Runner configuration environment variables
     environment:
-      CONFIG_FILE: /config.yaml
-      GITEA_INSTANCE_URL: "${INSTANCE_URL}"
-      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"
-      GITEA_RUNNER_NAME: "${RUNNER_NAME1}"
+      CONFIG_FILE: /config.yaml  # Path to configuration file
+      GITEA_INSTANCE_URL: "${INSTANCE_URL}"  # URL of Gitea instance
+      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"  # Registration token
+      GITEA_RUNNER_NAME: "${RUNNER_NAME1}"  # Display name for first runner
+    
+    # Persistent storage and docker socket configuration
     volumes:
-      - ./config.yaml:/config.yaml
-      - ./data1:/data
-      - /var/run/docker.sock:/var/run/docker.sock
+      - ./config.yaml:/config.yaml  # Shared configuration file
+      - ./data1:/data  # Dedicated data directory for runner1
+      - /var/run/docker.sock:/var/run/docker.sock  # Docker socket for container jobs
 
+  # Second Gitea Runner Instance
   gitea_runner2:
+    # Basic container configuration
     container_name: gitea_runner2
     image: docker.io/gitea/act_runner:0.2.12
     restart: unless-stopped
+    
+    # Runner configuration environment variables
     environment:
-      CONFIG_FILE: /config.yaml
-      GITEA_INSTANCE_URL: "${INSTANCE_URL}"
-      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"
-      GITEA_RUNNER_NAME: "${RUNNER_NAME2}"
+      CONFIG_FILE: /config.yaml  # Path to configuration file
+      GITEA_INSTANCE_URL: "${INSTANCE_URL}"  # URL of Gitea instance
+      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"  # Registration token
+      GITEA_RUNNER_NAME: "${RUNNER_NAME2}"  # Display name for second runner
+    
+    # Persistent storage and docker socket configuration
     volumes:
-      - ./config.yaml:/config.yaml
-      - ./data2:/data
-      - /var/run/docker.sock:/var/run/docker.sock
+      - ./config.yaml:/config.yaml  # Shared configuration file
+      - ./data2:/data  # Dedicated data directory for runner2
+      - /var/run/docker.sock:/var/run/docker.sock  # Docker socket for container jobs
 
+  # Third Gitea Runner Instance
   gitea_runner3:
+    # Basic container configuration
     container_name: gitea_runner3
     image: docker.io/gitea/act_runner:0.2.12
     restart: unless-stopped
+    
+    # Runner configuration environment variables
     environment:
-      CONFIG_FILE: /config.yaml
-      GITEA_INSTANCE_URL: "${INSTANCE_URL}"
-      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"
-      GITEA_RUNNER_NAME: "${RUNNER_NAME3}"
+      CONFIG_FILE: /config.yaml  # Path to configuration file
+      GITEA_INSTANCE_URL: "${INSTANCE_URL}"  # URL of Gitea instance
+      GITEA_RUNNER_REGISTRATION_TOKEN: "${REGISTRATION_TOKEN}"  # Registration token
+      GITEA_RUNNER_NAME: "${RUNNER_NAME3}"  # Display name for third runner
+    
+    # Persistent storage and docker socket configuration
     volumes:
-      - ./config.yaml:/config.yaml
-      - ./data3:/data
-      - /var/run/docker.sock:/var/run/docker.sock
+      - ./config.yaml:/config.yaml  # Shared configuration file
+      - ./data3:/data  # Dedicated data directory for runner3
+      - /var/run/docker.sock:/var/run/docker.sock  # Docker socket for container jobs