Skip to main content
Custom images allow you to use iPXE scripts to boot into your operating system of choice. Using an iPXE script to deploy a custom image gives you more flexibility and control over deployments, as you can customize an operating system to your needs and requirements. You must set a valid public URL where your iPXE script is stored. Your script should follow iPXE standards.

​
What is an iPXE script

The iPXE script contains a set of instructions that specify how the network boot process should be performed. This can include loading an operating system image from a remote server, setting up network configurations, and executing custom scripts or commands. Learn more about iPXE

​
DHCP

Our custom images deployment uses DHCP to automatically assign an IP address during the boot process. This simplifies the workflow so you don’t need to manually configure network settings with variables in most regions.

​
How to deploy a custom image

  1. For the Operating System option on the server create page, paste your iPXE script under Custom images or select one of the examples from the right.
Custom image selection on the Latitude.sh dashboard
  1. Finish filling out the rest of the server create form as usual, including selecting the server type, location, and any other options you need.
  2. When ready, click the Deploy button at the bottom of the page. Latitude.sh will begin deploying your server using your iPXE script, and you should see status updates on the server’s progress in your account dashboard.
Custom images take between 10 and 30 minutes to deploy, depending on the size of the image you are deploying.

​
Exceptions

Variables are only required for custom images deployed in the following regions: TYO3, TYO4, SAO, SYD2, and SAN3. For all other regions, DHCP will handle network configuration automatically. If you’re deploying in one of these regions, you can use these variables when writing your script. See some examples here.
VariableDescription
{{ PUBLIC_IP }}Public IP of the server that will be provisioned.
{{ PUBLIC_GW }}Public Gateway used to configure the network.
{{ INTERFACE_ID }}The public interface ID is used to configure the public interface of your server.
{{ NETMASK }}The Subnet Mask

​
Caveats

When deploying with a custom image, the server will report as active and show the On status in the dashboard. That doesn’t mean your image has finished installing. You will need to access the server console via Remote access to follow the installation process and make prompt selections, if applicable.

​
Alternative deployment methods

If iPXE scripts don’t meet your needs, you can also deploy custom operating systems using IPMI virtual media. See our Custom OS via IPMI deployment guide for detailed instructions.