Getting Started

Get a CloudRouter image


Obtain the latest Minimal or Full image from the CloudRouter Downloads. These images are in raw format and are compressed with xz

Download the image:

Ensure the image's checksum is correct:

Un-compress the image:



The CloudRouter image ships without default credentials. The cloudrouter user is provided to manage the system and has sudo access, but no default password is set. The cloudrouter images are configured to load password and/or ssh key data for the cloudrouter user from a metadata ISO image attached to the guest.

Create your own cloud-init iso

Run the script to create your custom iso image. The provided script will auto generate a password and a ssh key pair unless otherwise specified.

Fedora required packages:

Ubuntu required packages:

Windows 10 required packages using Windows Subsystem for Linux:

Example script usage:

Use the pre-configured cloud-init ISO

The cloud init ISO provided sets the cloudrouter account's password to "CloudRouter".

Please note: This ISO is provided for testing use only and should not be used in production.

Create a guest VM


virt-install - KVM using the CLI

Create and boot the guest:

Attach to the serial console and login:

Please note:  In this example the guest was attached to the virbr0 bridge so it is using the hosts libvirt NAT network. If the host system has a bridge network such as br0 this can be used so other systems on the network can access the guest.

virt-manager - KVM using the GUI

Create a new VM:

Select the uncompressed cloudrouter image:

Allocate 2GB or RAM and 2 VCPUs:

Select customize installation and select the network bridge:

Add a CDROM device and attach the cloud-init.iso:

Login to the VM:

Login wth the cloudrouter user account and the password set by the cloud-init.iso. Please be aware that the guest will first boot and load the cloud-init data and reboot. On the second boot, the system is ready for use.


Download the vmdk image from the CloudRouter Downloads page.

You will need to un-compress the image, 7zip is a good tool for this:

Create the new vm in VirtualBox:

Set the vm to use 2GB of RAM:

Select the "Use an existing virtual hard disk file" options and cloudrouter vmdk image file from the harddisk:

In the VM Setting(Ctrl+S) attach the cloud-init iso to the VM before first boot. This will be under the storage section of the left menu followed by the empty cdrom device. Select the "Choose a Virtual Optical Disk File" option and select the cloudrouter-init iso:

After the cloud-init iso image is attached booting the VM you can login using the cloudrouter login and the credentials that were loaded by cloud-init from the cloudrouter-init.iso.