Skip to main content
Version: 2.4

Quick admin setup

To get you setup quickly, the following steps are required.


Connecting a hypervisor to the system


You must have installed at least one hypervisor as documented here before continuing.

From the admin menu, select Hypervisors. Click on the Add Hypervisor button on the top right.

Fill in a name for the hypervisor (It can be changed at any time) and the ip address (IPv4 or IPv6).


Once added you will be asked to commission the hypervisor. Click the start button.


The hypervisor will now set up authentication automatically and finish the commissioning process.


If all goes well (If an error occurs it will print the error and give you the opportunity to configure again) the hypervisor will now be connected and ready to configure.

Configuring the hypervisor

When configuring a hypervisor it's vital you set limits on the resources available.


  • Servers should be set to the maximum amount of servers you would like on the hypervisor. This can be left at 0 (unlimited) if you are not sure.
  • Virtual CPU Cores should be set to the maximum amount of cores. It's not easy to calculate, so this setting can be set at a high value.
  • Memory should be set to the maximum amount of memory available for servers. You should take the amount of memory in the hypervisor and deduct a few GB for hypervisor usage.

Once you have set the values, Enable the hypervisor and click the update button.

Lower down the page you will see the storage section. You will need to set the Maximum Disk value. This should be set to the available disk space you have on the hypervisor but allowing space for cached operating system templates and temporary files.


Make sure its Enabled and click the Update button.

Select the correct network type for the primary network and update it.


Creating a hypervisor group

A hypervisor needs to be placed in a group. Doing this means you can cluster hypervisors and distribute servers across the cluster.

Click on Hypervisor Groups from the main menu. You will see a pre-added group called Default. You can either edit and rename this group or create your own.

Let's just edit the default group.


  • Name can be set to anything you like. The most common method is countries and cites. For example United Kingdom (London).
  • Server Distribution is how the servers are placed across all hypervisors in the group.

Once edited, click the Update button.

As you can see the hypervisor that we added earlier is already in this group. If you created a new group, you would need to edit the hypervisor and select the group you created.


IP Addressing

You don't strictly need IP addresses, but it's unlikely the use case you require.

Creating an IP address block

Select IP Address Blocks from the main menu and click the Create IP Block button.


  • Name can be set to anything you like and can be changed later.
  • Type IPv4 or IPv6.

Once created you will land on the configuration screen.

IPv4 configuration


Fill in all the details for your IP block, Enable it and click Save Settings.

Once save a new box will be displayed underneath.


Enter the start IP and the end IP then click the Add button. IP's can be reserved so full ranges can be added.

The last thing to do is aggin the IP block to the hypervisor we added. Select it and click Save Hypervisors.


IPv6 configuration

IPv6 configuration is a little more complicated as it requires a master subnet that the system can break down into smaller subnets. The fields should be self-explanatory though.


Once configured click Save Settings.

Information about the subnet will be shown at the top of the screen.


You may also blacklist subnets you don't want to be made available to servers at the bottom of the page.


The final step is to enable this block for the hypervisor like we did with IPv4.



Each server will be built from a package. A package is a collection of resources to be applied to a server when it's built.

Creating a package

Select Packages from the main menu and click the Create Package button.


Give it a Name which can always be changed later.

Once created you configure the package. Packages are limited at the moment but will be expanded on as development progresses.


Again, the settings should be self-explanatory. Fill in the fields, Enable and click Update.

That's it. You have now done the minimal configuration to build servers!