You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-41Lines changed: 48 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,23 +21,23 @@ This WHMCS module provides provisioning integration with CubeCoders AMP with WHM
21
21
22
22
- Enter a Name for this AMP server that will be displayed in WHMCS
23
23
24
-
6. Click Save Changes
25
-
7. From the Servers overview page click on Create New Group
24
+
6. Click **Save Changes**
25
+
7. From the Servers overview page click on **Create New Group**
26
26
27
27
- Enter a Name for your AMP Server Group
28
28
- Select your AMP Server(s) from the list and Add to Selected Servers
29
29
30
-
8. Click Save Changes
30
+
8. Click **Save Changes**
31
31
32
32
<h2>Creating the AMP Welcome & Password Reset Email Template</h2>
33
33
34
-
10. Navigate to System Settings -> System -> Email Templates
35
-
11. Click on Create New Email Template
34
+
10. Navigate to **System Settings -> System -> Email Templates**
35
+
11. Click on **Create New Email Template**
36
36
37
-
- For Email Type, click the dropdown and select Product/Service
37
+
- For Email Type, click the dropdown and select **Product/Service**
38
38
- Enter the name “AMP Welcome Email” for this template.
39
39
40
-
- 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
+
⚠️ 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
41
41
42
42
- Enter an Email Subject that your customers will see such as “Important Account Information”
43
43
- Copy and paste the below template into the text area of the email template
@@ -65,14 +65,15 @@ This WHMCS module provides provisioning integration with CubeCoders AMP with WHM
65
65
66
66
{$signature}
67
67
68
-
12. Click Save Changes
68
+
12. Click **Save Changes**
69
69
13. Next, we'll setup the AMP Password Reset email.
70
-
14. Navigate to System Settings -> System -> Email Templates
71
-
15. Click on Create New Email Template
70
+
14. Navigate to **System Settings -> System -> Email Templates**
71
+
15. Click on **Create New Email Template**
72
72
73
-
- For Email Type, click the dropdown and select Product/Service
73
+
- For Email Type, click the dropdown and select **Product/Service**
74
74
- Enter the name “AMP Password Reset” for this template.
75
-
- 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
+
⚠️ 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
76
77
77
78
- Enter an Email Subject that your customers will see such as “Password Reset Information”
78
79
- Copy and paste the below template into the text area of the email template
@@ -94,59 +95,73 @@ This WHMCS module provides provisioning integration with CubeCoders AMP with WHM
94
95
95
96
{$signature}
96
97
98
+
16: Click **Save Changes**
97
99
98
100
<h2>Set the callback function between AMP & WHMCS</h2>
99
101
100
102
16. Login to your AMP Control Panel
101
-
17. Navigate to Configuration -> Instance Deployment
103
+
17. Navigate to **Configuration -> Instance Deployment**
102
104
18. Set the Template deployment callback URL as follows :
103
105
104
106
https://WHMCS_URL/index.php?ampCallback=1
105
107
eg. https://example.com/index.php?ampCallback=1
106
108
107
-
- 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.
109
+
⚠️ 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.
108
110
109
111
110
112
<h2>Setting up a Server Group & Product within WHMCS</h2>
111
113
112
-
19. Navigate to System Settings -> Products & Services -> roducts/Services
20. Create New Product Group ( or use existing one )
114
116
115
-
- Select Create New Product
116
-
- For the Product Type, select [Other]
117
+
- Select **Create New Product**
118
+
- For the Product Type, select **[Other]**
117
119
- From the Product Group dropdown, select the Product Group you created earlier
118
120
- Enter a product name (For Example, Minecraft Java)
119
-
- Click on the drop down menu for Module and select AMP
121
+
- Click on the drop down menu for Module and select **AMP**
120
122
121
-
21. Click on Continue
123
+
21. Click on **Continue**
122
124
123
-
- Click on the Module Settings tab
124
-
- Ensure that Module Name is set to AMP
125
+
- Click on the **Module Settings** tab
126
+
- Ensure that Module Name is set to **AMP**
125
127
- Click on the Server Group drop down menu and select the Server Group you created earlier
126
-
- You will now see two new fields appear for Provisioning Template & Post Create Action
127
-
- Select the Provisioning Template you have created within the AMP Admin selection
128
-
- Then Select the Post Create Action such as Full Application Startup.
129
-
- Set the Required Tags field as per below
130
-
- If you are running AMP in Standalone or Hybrid mode, enter the value ‘Local’
131
-
- If you are running AMP in Controller/Target mode, enter the Tag value that you have set on a Target within the AMP panel
128
+
129
+
- You will now see new fields appear that are specific to this product
130
+
- The **Provisioning Template** allows you to select your deployment template within AMP for specific server you want to deploy
131
+
- Then select the **Post Create Action** from the below list depending on your desired outcome
132
+
133
+
**Do Nothing** = Creates instance and doesnt start the instance or application
134
+
**Start Instance** = Creates and starts the instance but doesnt start the application automatcially
135
+
**Start instance & update application** = Creates & Starts the instance and performs an application update.
136
+
**Full Instance & application startup** = Creates & Starts the instance and starts & updates the application and starts the application everytime the instance starts. (Providing no additional setup is required on the customers behalf such as EULA acknowledgement or Steam sign in)
137
+
138
+
- Set the **Required Tags** field as per below
139
+
- If you are running AMP in **Standalone** or Hybrid mode, enter the value ‘Local’
140
+
- If you are running AMP in **Controller/Target** mode, enter the Tag value that you have set on a Target within the AMP panel
132
141
- 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.
142
+
- The **Update Every Tim**e option tells AMP if the application should be updated everytime the instance is started in teh future
143
+
- The **Mode** selection allows you to specify how teh Endpoints are displayed in the Client section of WHMCS. For example:
144
+
145
+
**Standalone URL** will be displayed as https://yourdomain.com:25565
146
+
**Target/Node IP Address** will be displayed as 0.0.0.0:25565
147
+
133
148
- Now select your preference for the Automatic Setup
134
149
135
-
22. Click Save Changes
150
+
22. Click **Save Changes**
136
151
137
-
Don’t forget to set the other configurations in the other tabs for this product such as pricing.
152
+
⚠️ Don’t forget to set the other configurations in the other tabs for this product such as pricing.
138
153
139
154
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.
140
155
141
156
<h2>Configurable Options</h2>
142
157
143
158
You can set custom configuration options within WHMCS for settings such as RAM Allocation & CPU Allocation.
144
159
145
-
1. Navigate to System Settings -> Products & Services -> Configurable Options
146
-
2. Click on Create a New Group and give it a name such as ‘AMP Product Options’
2. Click on **Create a New Group** and give it a name such as ‘AMP Product Options’
147
162
3. From the Assigned Products select the products that these configurable options applies to
148
-
4. Click on Add New Configurable Option
149
-
5. Enter the configrable option that you would like to set from the list below and click Save Changes
163
+
4. Click on **Add New Configurable Option**
164
+
5. Enter the configrable option that you would like to set from the list below and click **Save Changes**
150
165
151
166
<h3> Example Configurable Options</h3>
152
167
@@ -165,11 +180,3 @@ You can set custom configuration options within WHMCS for settings such as RAM A
165
180
Q: Do I need to set a Product Welcome Email in each product?
166
181
167
182
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.
168
-
169
-
Q: Why does the WHMCS module show the instance is running straight away but then after a few seconds show as stopped?
170
-
171
-
A: Mike is aware of this issue and will hopefully be resolved in the future
172
-
173
-
Q: How can I change the URL that is displayed for the Endpoints in the welcome email or client section?
174
-
175
-
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