InstaSite Configuration File

Last modified: February 21, 2024

Overview

The InstaSite feature allows an administrator to quickly generate a new website immediately after they install cPanel & WHM.

We currently offer the InstaSite feature as an experiment to a limited number of hyperscalers.

This document describes the /var/cpanel/.create-website configuration file which the InstaSite feature uses in the background to temporarily store values.

Note:

Typically, a third-party service will create this file, not the system administrator.

The configuration file

The /var/cpanel/.create-website configuration file uses JSON format, and it uses the following parameters:

Parameter	Description	Example
`domain`	The new account’s domain name.	`example.com`
`username`	The new account’s user name.	`example`
`password`	The new account’s password.	`password`

All three parameters are required.

Example

The following example demonstrates the contents of the /var/cpanel/.create-website file:

1
2
3
4
5


{
    "domain":   "example.com",
    "username": "example",
    "password": "yourPassword"
}

Important:

Because this file contains a password, make sure that the file uses 0600 permissions.