docs: readme.md

Author: vaggeliskls

README.md

@@ -1,17 +1,23 @@
-# Windows Github Custom Runner 
-A implementation of windows github custom runner (x64) based on vagrant VM, libvirt and docker compose. The VM is created inside a container using vagrant and libvirt. This strategy makes the deployment of windows action runners trivial and plug and play. 
+# 🏃 Windows Github Custom Runner 
 
-# Prerequisites
+Explore an innovative, efficient, and cost-effective approach to deploying a custom GitHub Runner that runs in a containerized Windows OS (x64) environment on a Linux system. This project leverages the robust capabilities of Vagrant VM, libvirt, and docker-compose which allows for seamless management of a Windows instance just like any Docker container. The added value here lies in the creation of a plug-and-play solution, significantly enhancing convenience, optimizing resource allocation, and integrating flawlessly with existing workflows. This strategy enriches CI/CD pipeline experiences in various dev-ops environments, providing a smooth and comprehensive approach that does not require prior knowledge of VM creation. 
 
-- [docker](https://www.docker.com/) >= 24
-- [docker-compose](https://www.docker.com/) >= 1.18
+# 📋 Prerequisites
 
-# Deployment Guide
+- [docker](https://www.docker.com/)  version 24 or higher.
+- [docker-compose](https://www.docker.com/) version 1.18 or higher.
+
+# 🚀 Deployment Guide
 
 1. Create/Update the environmental file `.env`
-    - Runner URL
-    - PAT: Personal access token
-```
+  - `PAT`: Personal access token from GitHub
+  - `RUNNER_URL`: The URL of the GitHub that the runner connects to
+  - `RUNNERS`: Number of runners
+  - `MEMORY`: Amount of memory for the Vagrant image (in MB)
+  - `CPU`: Number of CPUs for the Vagrant image
+  - `DISK_SIZE`: Disk size for the Vagrant image (in GB)
+```env
+# Runner settings
 PAT=<Replace with your personal access token>
 RUNNER_URL=<runner url>
 RUNNERS=1
@@ -31,31 +37,25 @@ services:
     stdin_open: true
     tty: true
     privileged: true
-    cap_add:
-      - NET_ADMIN
-      - SYS_ADMIN
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup
-    devices:
-      - /dev/kvm
-      - /dev/net/tun
     ports:
       - 3389:3389
 ```
 3. Run: `docker-compose up -d`
 
-> The PAT token needs Read and Write access to organization self hosted runners
+> The PAT token needs Read and Write access to organization self-hosted runners
 
 
-# Remote Desktop
+# 🌐 Access via Remote Desktop
 For debugging purposes or testing you can always connect to the VM with remote desktop softwares.
 
 Some software that used when developed was 
 1. Linux: rdesktop `rdesktop <ip>:3389` or [remina](https://remmina.org/)
 2. MacOS: [Windows remote desktop](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12)
 3. Windows: buildin `Remote Windows Connection` 
 
-## User login
+# 🔑 User Login
 The default users based on vagrant image are 
 
 1. Administrator
@@ -67,7 +67,7 @@ The default users based on vagrant image are
 
 
 
-# References
+# 📚 Further Reading and Resources
 
 - [Windows in docker container](https://github.com/vaggeliskls/windows-in-docker-container)
 - [Windows Vagrant Tutorial](https://github.com/SecurityWeekly/vulhub-lab)