Revision as of 18:37, 17 December 2021 (view source) SarahK (talk | contribs) ← Older edit		Latest revision as of 11:36, 16 August 2022 (view source) JuanR (talk | contribs) (→‎About this Module)
(2 intermediate revisions by one other user not shown)
Line 1:		Line 1:
		+	== About this Module ==
		+	<div class="docs-alert-info">
		+	The Helm module is only compatible with the discontinued server control panel (not the Kubernetes® package manager).
		+	</div>
		+	<div class="docs-alert-success">
		+	For our other Helm module, see [[Helm 3]].
		+	</div>
		+	The Helm 4 module allows you to add and manage Helm 4 servers in WHMCS.
	{{Provisioning_Module		{{Provisioning_Module
	| changepackage = Yes		| changepackage = Yes
	| clientarealink = Yes		| clientarealink = Yes
	| port = 8086}}		| port = 8086}}
−	==Adding a Helm 4 Server==
−	#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.	+	== Adding a Helm 4 Server ==
−	#Click '''Add New Server'''.
−	#Enter the server name, IP address, select the server type "helm4" from the dropdown menu, and enter the username (the Account Name and Login Name for Helm must be the same) and password for the server
−	# The default port will be displayed. If your server is configured to communicate on a different port, check the '''Override with Custom Port''' checkbox and enter it into the Port field. For more information refer to [[Server Port Overrides]].
−	#Click '''Create Server''' to complete the process and add your new Helm Server
−	==Setting up a Helm 4 Package==	+	To set up a Helm 4 server in WHMCS:
		+
		+	# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
		+	# Click '''Add New Server'''.
		+	# Select ''Helm 4'' from the menu.
		+	# Enter the hostname or IP address and your credentials.
		+	# Click '''Continue'''.
		+	# Enter the additional desired server details.
		+	# If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
		+	# Click '''Save Changes'''.
		+	# If this is the only ''Helm 4'' server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
−	#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.	+	=== Creating a Helm 4 Product ===
−	#Click '''Create A New Product'''.
−	#Configure the name, description, pricing and other options as necessary.
−	#On the ''Module Settings'' tab set the Module Name to '''Helm4'''.
−	# You will then be asked for the Role ID and Plan ID.  To find the Role ID, in Helm go to '''Account Settings > Customer Account Roles'''.  You can then click on the Excel download icon to get a list of roles & their IDs.
−	[[Image:Helm1.jpg]]	+	You can create a product that provisions accounts on your Helm 4 server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
−	The download gives you an Excel sheet as follows with each role and it's ID number that you need to enter into WHMCS.	+	To find your role ID:
−	[[Image:Helm2.jpg]]	+	# Log in to the Helm 4 server.
		+	# Go to '''Account Settings > Customer Account Roles'''.
		+	# Click the Excel download icon to get a list of roles and their IDs.[[Image:Helm1.jpg]][[Image:Helm2.jpg]]
		+	# Enter the necessary role IDs in WHMCS.
		+	# Go to '''Account Settings > My Plans'''.
		+	# Click the Excel download icon to get a list of plans and their IDs. [[Image:Helm3.jpg]] [[Image:Helm4.jpg]]
−	You need the role ID of the role this package should have which is highlighted above.  You then need to do the same to get the Plan IDs by going to '''My Plans''' and then clicking the Excel download link as shown below.	+	=== WHMCS Connect ===
−	[[Image:Helm3.jpg]]	+	This module does not support [[WHMCS Connect]].
−	The download produces a list like the one below in Excel where you can then take the Plan ID from which you need to enter into WHMCS.	+	==Troubleshooting==
−	[[Image:Helm4.jpg]]	+	''N/A''
	{{modules}}		{{modules}}

---

Latest revision as of 11:36, 16 August 2022

About this Module

 

The Helm 4 module allows you to add and manage Helm 4 servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

Change Package	Change Password	Usage Updates	Client Area Link
Yes	No	No	Yes

The following ports should be open for outbound connections from your WHMCS server: 8086

Adding a Helm 4 Server

To set up a Helm 4 server in WHMCS:

1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
2. Click Add New Server.
3. Select Helm 4 from the menu.
4. Enter the hostname or IP address and your credentials.
5. Click Continue.
6. Enter the additional desired server details.
7. If your server uses a different port, check Override with Custom Port and enter the correct port. For more information, see Server Port Overrides.
8. Click Save Changes.
9. If this is the only Helm 4 server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating a Helm 4 Product

You can create a product that provisions accounts on your Helm 4 server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.   

To find your role ID:

1. Log in to the Helm 4 server.
2. Go to Account Settings > Customer Account Roles.
3. Click the Excel download icon to get a list of roles and their IDs.
4. Enter the necessary role IDs in WHMCS.
5. Go to Account Settings > My Plans.
6. Click the Excel download icon to get a list of plans and their IDs.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A