Server Port Overrides - Revision history

SarahK at 20:21, 3 May 2022

2022-05-03T20:21:42Z

SarahK at 17:27, 1 December 2021

2021-12-01T17:27:47Z

Matt at 22:44, 7 July 2015

2015-07-07T22:44:58Z

Andrew at 14:59, 7 July 2015

2015-07-07T14:59:07Z

Andrew: Created page with "Server Port configuration To override the port that a server in WHMCS will use, is quite simple. When adding a server, check the 'Override with..."

2015-07-07T14:57:35Z

Created page with "thumb|Server Port configuration To override the port that a server in WHMCS will use, is quite simple. When adding a server, check the 'Override with..."

New page

[[File:server_port.png|thumb|Server Port configuration]]
To override the port that a server in WHMCS will use, is quite simple. When adding a server, check the 'Override with Custom Port' checkbox that can be seen next to the existing port number. Once checked, you can then amend the 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.

===Use in Development===
To use an overridable port in your custom server module, you need to define the default(s) within the MetaData function.<br />
The sample here provides a custom module with a default port of 80 and an SSL port of 443.
<source lang="php">
function template_MetaData()
{
return array(
'DisplayName' => 'Server Module Display Name',
'DefaultNonSSLPort' => '80',
'DefaultSSLPort' => '443',
);
}
function template_CreateAccount($params)
{
$serverPort = $params['serverport'];
}
</source>

===Default Server Ports===

{| class="wikitable"
!Module Name
!Standard Port
!SSL Port
|-
|cPanel||2086||2087
|-
|DirectAdmin||2222||2222
|-
|Enkompass||2086||2087
|-
|Helm 4||8086|| -
|-
|HyperVM||8888||8887
|-
|Interworx||-||2443
|-
|LXAdmin||7778||7777
|-
|SCPanel||2086||2087
|-
|vePortal||2407||2408
|-
|WHMSonic||2086||2087
|-
|XPanel||80||3737
|}

@@ Line 1: / Line 1: @@
 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.
+== The Port Field ==
 [[File:Server-config-port-override84.png]]
-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.
+Check '''Override with Custom Port''' for the existing port number and then customise the port value. Unchecking the box will reset the value to the default for the server. See the table below for a list of supported modules that use this option:
 ===Default Server Ports===
@@ Line 38: / Line 39: @@
 ===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.<br />
-The sample here provides a custom module with a default port of 80 and an SSL port of 443.
+To add support for port customisation to your server or provisioning modules, define the defaults within the <tt>MetaData</tt> function.
 <source lang="php">

@@ Line 3: / Line 3: @@
 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.
-[[File:Server-config-port-override.png]]
+[[File:Server-config-port-override84.png]]
 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.

← Older revision		Revision as of 14:59, 7 July 2015
Line 1:		Line 1:
		+	<br /><br />
	[[File:server_port.png\|thumb\|Server Port configuration]]		[[File:server_port.png\|thumb\|Server Port configuration]]
	To override the port that a server in WHMCS will use, is quite simple. When adding a server, check the 'Override with Custom Port' checkbox that can be seen next to the existing port number. Once checked, you can then amend the 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.		To override the port that a server in WHMCS will use, is quite simple. When adding a server, check the 'Override with Custom Port' checkbox that can be seen next to the existing port number. Once checked, you can then amend the 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.