etc/Server/vps2arch/README.md

   1 VPS2Arch
   2 ========
   3
   4 The fastest way to convert a _VPS_ to [Arch Linux](https://www.archlinux.org/)!
   5
   6 Author
   7 ------
   8
   9 [Timothy Redaelli](mailto:timothy@fsfe.org)
  10
  11 Description
  12 -----------
  13
  14 This script is used to convert a _VPS_, running another linux distro, to _Arch Linux_.
  15 It should be **only** used if your _VPS_ provider doesn't provide you an _Arch Linux_ image.
  16
  17 Disclaimer
  18 ----------
  19
  20 > I'm not responsible for any damage in your system and/or any violation of the agreement between you and your vps provider.
  21 > **Use at your own risk!**
  22
  23 How To
  24 ------
  25
  26 Download the script on your _VPS_ and execute it with root privileges
  27
  28 **WARNING** The script will **delete** any data in your _VPS_!
  29
  30         wget http://tinyurl.com/vps2arch
  31         chmod +x vps2arch
  32         ./vps2arch
  33
  34 Some _Debian_ _VPS_ images don't have the _CA certificates_ installed, so `wget` will give you the following errors:
  35
  36         ERROR: The certificate of `gitlab.com' is not trusted.
  37         ERROR: The certificate of `gitlab.com' hasn't got a known issuer.
  38
  39 To fix them just execute `apt-get install ca-certificates` and then re-execute the previous commands.
  40
  41 How does it work?
  42 -----------------
  43
  44 It's Black Magic.
  45 Just kiddin' 😏, the script itself is very simple.
  46
  47 In a nutshell, it will download the _Arch Linux Bootstrap Image_ and (see the [wiki](https://wiki.archlinux.org/index.php/Install_from_existing_Linux#Method_B:_Using_the_Bootstrap_Image_.28recommended.29)),
  48 extract the image to / and configure the _Bootstrap chroot_.
  49
  50 Now, about the **critical** part:
  51
  52 > How can you wipe the system without breaking everything?
  53
  54 It's simple: using `ld.so` from the _Bootstrap chroot_ to launch the `chroot` tool.
  55
  56 Since it will erase all the system directories except from the _Bootstrap chroot_, `/dev`, `/proc`, `/sys` and the like,
  57 the only way to launch a command inside the _Bootstrap chroot_ is to using ld.so from the _Bootstrap chroot_ itself.
  58
  59 At this point _Arch Linux_ has been installed, but not configured.
  60 The script will provide a SSH-able system automagically configuring grub (or syslinux), network and restoring the root password from the original system (or by using `vps2arch` as password if no root password was set).
  61
  62 Once done doing its job, the script will ask you to manually reboot your _VPS_ and voilà, PROFIT!
  63
  64 Does it really work?
  65 --------------------
  66
  67 Yes, it does!
  68
  69 On the [Tested VPS Providers](https://gitlab.com/drizzt/vps2arch/wikis/Tested-VPS-Providers) wiki page you can find a list of **Tested VPS Providers**.
  70
  71 Theoretically it should also work on **real** computers (running linux), but I think it's not worth it,
  72 because you can install it in the canonical way.
  73
  74 Contributing
  75 ------------
  76
  77 If you have any useful modification, please use **Pull requests**.
  78 If you have successfully used this script on a different _distro_ - _VPS_ combination, please contact me so that I can update the above list.
  79
  80 If you are not a developer, but you still want to contribute, you can donate me an account on your _VPS_ provider and I'll do my best to support it.
  81 Or you can just donate me some bucks I'll spend to buy a _VPS_ on your provider in order to support it.
  82
  83 Caveats
  84 -------
  85
  86 _IPv6_ currently is not supported. If you need to use it, please configure it manually.