Skip to content

Commit 2b2d78d

Browse files
zeniar-auzeniar-au
authored
Update README.md
Created an entire process around installing the AMP Module into WHMCS and configuring it
1 parent d0c0fc9 commit 2b2d78d

1 file changed

Lines changed: 159 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,162 @@
11
# CubeCoders AMP WHMCS Module
22

33
This WHMCS module provides provisioning integration with CubeCoders AMP with WHMCS.
4+
5+
<h2>Installing the AMP WHMCS module</h2>
6+
7+
1. Upload the package content into your MAIN WHMCS DIRECTORY. 
(We recommend using an FTP Client)
8+
2. Login to WHMCS Admin Area
9+
3. Navigate to System Settings -> Product & Services -> Servers
10+
4. Click on Add New Server
11+
12+
- For the Module type, select AMP
13+
- Enter the hostname for your AMP server followed by a Username and Password
14+
15+
- Note: You should create a seperate AMP user for WHMCS with the Super Admin Role and ensure MFA is disabled for this user.
16+
17+
5. Click Test Connection
18+
19+
- If the connection was successful you will see a green banner confirming the connection at the top
20+
21+
- Enter a Name for this AMP server that will be displayed in WHMCS
22+
23+
6. Click Save Changes
24+
7. From the Servers overview page click on Create New Group
25+
26+
- Enter a Name for your AMP Server Group
27+
- Select your AMP Server(s) from the list and Add to Selected Servers
28+
29+
8. Click Save Changes
30+
31+
<h2>Creating the AMP Welcome & Password Reset Email Template</h2>
32+
33+
10. Navigate to System Settings -> System -> Email Templates
34+
11. Click on Create New Email Template
35+
36+
- For Email Type, click the dropdown and select Product/Service
37+
- Enter the name “AMP Welcome Email” for this template.
38+
39+
- Note: Its important you use this exact template title name otherwise the email will not be sent once AMP has provisioned the Instance. This name will not be visible to your customers
40+
41+
- Enter an Email Subject that your customers will see such as “Important Account Information”
42+
- Copy and paste the below template into the text area of the email template
43+
44+
Congratulations {$client_name},
45+
46+
Your order has now been activated and you are minuets away from starting an epic journey with your friends in {$service_product_name}
47+
48+
49+
50+
Username: {$service_username}
51+
52+
Generated Password: {$service_password}
53+
54+
Console Login: https://{$service_server_hostname}/?instance={$service_instance_id}
55+
56+
57+
58+
Lets get started!
59+
60+
Now that you are a {$service_product_name} Server owner, you'll need to login to the above link and accept the {$service_product_name} EULA and then Start your server.
61+
62+
Please raise a ticket on our website if you require assistance. 
63+
64+
65+
{$signature}
66+
67+
12. Click Save Changes
68+
13. Next, we'll setup the AMP Password Reset email.
69+
14. Navigate to System Settings -> System -> Email Templates
70+
15. Click on Create New Email Template
71+
72+
- For Email Type, click the dropdown and select Product/Service
73+
- Enter the name “AMP Password Reset” for this template.
74+
- Note: Its important you use this exact template title name otherwise the email will not be sent once AMP has provisioned the Instance. This name will not be visible to your customers
75+
76+
- Enter an Email Subject that your customers will see such as “Password Reset Information”
77+
- Copy and paste the below template into the text area of the email template
78+
79+
Hello {$client_name},
80+
81+
We've reset your password to your Control Panel. Please find your new login details below:
82+
83+
84+
Username: {$service_username}
85+
86+
Generated Password: {$service_password}
87+
88+
Console Login: https://{$service_server_hostname}/?instance={$service_instance_id}
89+
90+
91+
92+
If you did not request this password change, please reply to this email.
93+
94+
{$signature}
95+
96+
97+
<h2>Set the callback function between AMP & WHMCS</h2>
98+
99+
16. Login to your AMP Control Panel
100+
17. Navigate to Configuration -> Instance Deployment
101+
18. Set the Template deployment callback URL as follows :
102+
103+
https://WHMCS_URL/index.php?ampCallback=1
104+
eg. https://example.com/index.php?ampCallback=1
105+
106+
- Ensure to change WHMCS_URL to your own domain where WHMCS is installed as this will allow AMP to tell WHMCS once the product is created and the status of the instance.
107+
108+
109+
<h2>Setting up a Server Group & Product within WHMCS</h2>
110+
111+
19. Navigate to System Settings -> Products & Services -> roducts/Services
112+
20. Create New Product Group ( or use existing one )
113+
114+
- Select Create New Product
115+
- For the Product Type, select [Other]
116+
- From the Product Group dropdown, select the Product Group you created earlier
117+
- Enter a product name (For Example, Minecraft Java)
118+
- Click on the drop down menu for Module and select AMP
119+
120+
21. Click on Continue
121+
122+
- Click on the Module Settings tab
123+
- Ensure that Module Name is set to AMP
124+
- Click on the Server Group drop down menu and select the Server Group you created earlier
125+
- You will now see two new fields appear for Provisioning Template & Post Create Action
126+
- Select the Provisioning Template you have created within the AMP Admin selection
127+
- Then Select the Post Create Action such as Full Application Startup.
128+
- Set the Required Tags field as per below
129+
- If you are running AMP in Standalone or Hybrid mode, enter the value ‘Local’
130+
- If you are running AMP in Controller/Target mode, enter the Tag value that you have set on a Target within the AMP panel
131+
- Extra Provision Setting field allows you to set a static setting that will apply to all Instances created for this product. If you wish to sell customisable parameters such as RAM & CPU allocations, please see the Configurable Options section further down.
132+
- Now select your preference for the Automatic Setup
133+
134+
22. Click Save Changes
135+
136+
Don’t forget to set the other configurations in the other tabs for this product such as pricing.
137+
138+
You’re ready to go! Module is ready to use. After activation of ordered product, module will wait for callback - then Application URL will be show in client area.
139+
140+
<h2>Configurable Options</h2>
141+
142+
You can set custom configuration options within WHMCS for settings such as RAM Allocation & CPU Allocation.
143+
144+
1. Navigate to System Settings -> Products & Services -> Configurable Options
145+
2. Click on Create a New Group and give it a name such as ‘AMP Product Options’
146+
3. From the Assigned Products select the products that these configurable options applies to
147+
4. Click on Add New Configurable Option
148+
149+
150+
<h2>FAQ’s</h2>
151+
152+
Q: Do I need to set a Product Welcome Email in each product?
153+
154+
A: No, the AMP WHMCS Module will always send out the email Template called “AMP Welcome Email”. You can however send an additional welcome email by selecting another email template in the Welcome Email drop down box within each product.
155+
156+
Q: Why does the WHMCS module show the instance is running straight away but then after a few seconds show as stopped?
157+
158+
A: Mike is aware of this issue and will hopefully be resolved in the future
159+
160+
Q: How can I change the URL that is displayed for the Endpoints in the welcome email or client section?
161+
162+
A: This URL is generated from the Hostname set in the Server created for AMP. If you use different servers, this will automatically pull the URL that the instance was provisioned to.

0 commit comments

Comments
 (0)