{"id":49023888,"url":"https://github.com/vaggeliskls/windows-github-custom-runner","last_synced_at":"2026-04-19T05:38:35.628Z","repository":{"id":180118259,"uuid":"664612709","full_name":"vaggeliskls/windows-github-custom-runner","owner":"vaggeliskls","description":"A robust, cost-effective solution to deploy containerized custom GitHub Runners in a Windows OS environment on a Linux server. This project utilizes Vagrant VM, libvirt, and docker-compose, providing a seamless, plug-and-play approach that significantly enhances the CI/CD pipeline experience. No prior knowledge of VM creation required","archived":false,"fork":false,"pushed_at":"2025-03-11T11:39:03.000Z","size":94,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-19T05:37:59.655Z","etag":null,"topics":["github-actions","github-runners","vagrant","windows","windows-github-custom-runner"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vaggeliskls.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-10T11:12:04.000Z","updated_at":"2025-09-06T01:48:56.000Z","dependencies_parsed_at":"2024-05-18T13:23:10.403Z","dependency_job_id":"d553ed9e-75a6-430e-bdb0-50211d4248a9","html_url":"https://github.com/vaggeliskls/windows-github-custom-runner","commit_stats":{"total_commits":61,"total_committers":2,"mean_commits":30.5,"dds":"0.21311475409836067","last_synced_commit":"e8e9b9d86b6a83c60ccf95491b5613d99f536c2a"},"previous_names":["vaggeliskls/windows-github-custom-runner"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/vaggeliskls/windows-github-custom-runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaggeliskls%2Fwindows-github-custom-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaggeliskls%2Fwindows-github-custom-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaggeliskls%2Fwindows-github-custom-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaggeliskls%2Fwindows-github-custom-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaggeliskls","download_url":"https://codeload.github.com/vaggeliskls/windows-github-custom-runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaggeliskls%2Fwindows-github-custom-runner/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31996445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","github-runners","vagrant","windows","windows-github-custom-runner"],"created_at":"2026-04-19T05:38:35.087Z","updated_at":"2026-04-19T05:38:35.618Z","avatar_url":"https://github.com/vaggeliskls.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🏃 Windows Github Custom Runner \n\nExplore 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. \n\n⭐ **Don't forget to star the project if it helped you!**\n\n# 📋 Prerequisites\n\n- [docker](https://www.docker.com/)  version 24 or higher.\n- [docker-compose](https://www.docker.com/) version 1.18 or higher.\n\n# 🚥 Authentication for Self-Hosted Runners\nFor the purpose of authenticating your custom self-hosted runners, we offer two viable authentication methods:\n\n1. Personal Access Token (`PAT`) - The Personal Access Token is a static, manually created token that provides secure access to GitHub. This offers a long-lived method of authentication (The PAT token needs Read and Write access to organization self-hosted runners).\n\n2. Registration Token (`TOKEN`) - The Registration Token is a dynamic, short-lived token generated automatically by GitHub during the creation of a new self-hosted runner. This provides a temporary but immediate method of authentication.\n\n\u003e **Note:** Only one of these authentication methods is necessary. Choose the method that best fits your\n\n# 🚀 Deployment Guide\n\n1. Create/Update the environmental file `.env`\n  - `PAT`: Personal access token from GitHub\n  - `TOKEN`: Short lived Github token\n  - `RUNNER_URL`: The URL of the GitHub that the runner connects to\n  - `RUNNERS`: Number of runners\n  - `MEMORY`: Amount of memory for the Vagrant image (in MB)\n  - `CPU`: Number of CPUs for the Vagrant image\n  - `DISK_SIZE`: Disk size for the Vagrant image (in GB)\n\n### Example with PAT\n```env\n# Runner settings\nPAT=\u003cYour Personal access token\u003e\nRUNNER_URL=\u003crunner url\u003e\nRUNNERS=1\n# Vagrant image settings\nMEMORY=8000 # 8GB\nCPU=4\nDISK_SIZE=100\n```\n### Example with TOKEN\n```env\n# Runner settings\nTOKEN=\u003cYour short lived acess token\u003e\nRUNNER_URL=\u003crunner url\u003e\nRUNNERS=1\n# Vagrant image settings\nMEMORY=8000 # 8GB\nCPU=4\nDISK_SIZE=100\n```\n2. Create `docker-compose.yml`\n```yaml\nversion: \"3.9\"\n\nservices:\n  windows-github-runner-vm:\n    image: docker.io/vaggeliskls/windows-github-custom-runner:latest\n    env_file: .env\n    stdin_open: true\n    tty: true\n    privileged: true\n    ports:\n      - 3389:3389\n```\n3. Run: `docker-compose up -d`\n\n# 🌐 Access via Remote Desktop\nFor debugging purposes or testing you can always connect to the VM with remote desktop softwares.\n\nSome software that used when developed was \n1. Linux: rdesktop `rdesktop \u003cip\u003e:3389` or [remina](https://remmina.org/)\n2. MacOS: [Windows remote desktop](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12)\n3. Windows: buildin `Remote Windows Connection` \n\n# 🔑 User Login\nThe default users based on vagrant image are \n\n1. Administrator\n    - Username: Administrator\n    - Password: vagrant\n1. User\n    - Username: vagrant\n    - Password: vagrant\n\n\n\n# 📚 Further Reading and Resources\n\n- [Windows in docker container](https://github.com/vaggeliskls/windows-in-docker-container)\n- [Windows Vagrant Tutorial](https://github.com/SecurityWeekly/vulhub-lab)\n- [Vagrant image: peru/windows-server-2022-standard-x64-eval](https://app.vagrantup.com/peru/boxes/windows-server-2022-standard-x64-eval)\n- [Vagrant by HashiCorp](https://www.vagrantup.com/)\n- [Windows Virtual Machine in a Linux Docker Container](https://medium.com/axon-technologies/installing-a-windows-virtual-machine-in-a-linux-docker-container-c78e4c3f9ba1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaggeliskls%2Fwindows-github-custom-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaggeliskls%2Fwindows-github-custom-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaggeliskls%2Fwindows-github-custom-runner/lists"}