diff --git a/README.md b/README.md index 27019810032a6e6670e4aa2419dc733415791511..60edfa6624d5a4f73c42fb7d09d0b729448c9cc3 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,28 @@ -# simple-vps-provider +# Super-Simple QEMU manager script + +> Designed for single user desktop / home server. Turn your server/desktop to DigitalOcean / Linode / Vultr with a super-simple script. -No complex configuration, no fancy dependency, no management cost. This project is designed for single user home server. It allows you to easily get a server for testing and dev. +- Easy setup: No dependency, no libvirt, no user/group/pool config. + +- Easy configuration: Simple list your VMs in config file. + +- Easy management: Everything in one single directory. + +- Easy customization: Just a naive bash script. Everyone knows how to customize. ## Dependency -qemu, bash +qemu, bash, sed + +> ArchLinux user: simply run `pacman -S cdrkit qemu-base` ## Usage -1. Download release and put it in any directory you love. -2. Run `./vps-provider-daemon` in background. (Optional: run it on system startup) -3. Access `http://localhost:6083` and enjoy. +1. Download this repo to anywhere. +2. Modify `init.settings` and `runtime.settings`. +3. Add `` ## If you want to modify the configuration... diff --git a/src/cron-callback.sh b/cron-callback.sh old mode 100644 new mode 100755 similarity index 100% rename from src/cron-callback.sh rename to cron-callback.sh diff --git a/src/init.settings b/init.settings similarity index 100% rename from src/init.settings rename to init.settings diff --git a/src/qemu-create-vm-from-cloudimg.fish b/qemu-create-vm-from-cloudimg.fish similarity index 100% rename from src/qemu-create-vm-from-cloudimg.fish rename to qemu-create-vm-from-cloudimg.fish diff --git a/src/runtime.settings b/runtime.settings similarity index 100% rename from src/runtime.settings rename to runtime.settings