Revision as of 17:27, 1 December 2021

Many server modules allow you to customise the port number that is used for connections via the server configuration. This is useful for situations where you customise the port a service is operating on.

If a module supports it, a Port field will show up as in the below screenshot when configuring a server. If you do not see this field, then the module you are using does not support port customisation.

Check the 'Override with Custom Port' checkbox that can be seen next to the existing port number. Once checked, you can then customise the port value as you wish. Unchecking the box will reset the value to the default defined for that server. All supported modules that use this option are defined in the Default Server Ports table below.

Default Server Ports

Use in Development

To add support for port customisation to your server/provisioning modules, you need to define the default(s) within the MetaData function.
The sample here provides a custom module with a default port of 80 and an SSL port of 443.

function template_MetaData()
{
    return array(
        'DisplayName' => 'Server Module Display Name',
        'DefaultNonSSLPort' => '80',
        'DefaultSSLPort' => '443',
    );
}

function template_CreateAccount($params)
{
    $serverPort = $params['serverport'];
}