explaingit

1061700625/github_vps

38Shell

TLDR

This project is a small set of shell scripts that lets you use GitHub itself as a free VPS, meaning a free remote computer you can log into and use over the network.

Mindmap

A visual breakdown will appear here once this repo is fully enriched.

In plain English

This project is a small set of shell scripts that lets you use GitHub itself as a free VPS, meaning a free remote computer you can log into and use over the network. The README is written in Chinese and links to an illustrated tutorial on WeChat. The trick is that GitHub Codespaces, which is normally for running coding environments, can be used to run a full Ubuntu or Windows 11 desktop. To start it up, you give the start.sh script execute permission with chmod, then run bash start.sh ubuntu to launch Ubuntu, or bash start.sh by itself to launch Windows 11. The Ubuntu side exposes a web terminal on port 4200, SSH on port 8022, and RDP on port 3389. The default username and password are both root. The Windows 11 side exposes a management web UI on port 8006 and RDP on 3389, with the default account MASTER and password admin@123. You can change the default credentials by setting environment variables before the start command, for example ROOT_PASSWORD for Ubuntu, or WINDOWS_USERNAME and WINDOWS_PASSWORD for Windows. For Windows you can also set the RAM, CPU core count, and disk size through WINDOWS_RAM_SIZE, WINDOWS_CPU_CORES, and WINDOWS_DISK_SIZE. The Windows version is configurable via the underlying dockurr/windows Docker image. To stop everything, run bash start.sh stop. The README warns that Ubuntu and Windows share port 3389 for RDP, so you can only run one at a time. The FAQ explains that the built-in VNC is slow, so the author suggests installing a remote desktop tool like Todesk or Sunlogin inside the system. It also notes that you need to switch the Codespace URL from private to public to reach it from outside, and that Codespaces auto-delete after an idle period unless you keep some activity going.

Open on GitHub → Explain another repo

Generated 2026-05-21 · Model: sonnet-4-6 · Verify against the repo before relying on details.