Karolina: /* Groups */

2025-11-03T12:05:27Z

‎Groups

Karolina: /* Management */

2025-11-03T11:57:12Z

‎Management

Karolina: Created page with "
2025-11-03T11:40:34Z

Created page with "<meta name="keywords" content="modulesgarden app templates, modulesgarden app templates configuration, modulesgarden app templates management, modulesgarden app templates guid..."

New page
<meta name="keywords" content="modulesgarden app templates, modulesgarden app templates configuration, modulesgarden app templates management, modulesgarden app templates guide, modulesgarden app templates examples, modulesgarden app templates cloud-init, modulesgarden app templates documentation, modulesgarden app templates wiki, whmcs app templates, whmcs app templates guide, whmcs app templates docs"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The App Templates Feature Used Across VPS Modules."></meta>

=About App Templates Tool=
{|
|style="padding: 10px 0px 30px 0px;"|The ''App Templates'' tool allows you to manage ready-to-use application templates that clients can install directly on their virtual machines. 
Templates are created in the '''Applications''' tab and grouped in the '''Groups''' tab, which can later be assigned to products. 
This feature provides a simple way to manage templates and organize groups, ensuring clients can deploy preconfigured applications on their VPS with ease.
|}

=Management=
{|
|style="padding: 10px 0px 30px 15px;"|The '''App Templates''' section in the admin area consists of two main parts: '''Applications''' and '''Groups'''. 
You can create templates under the '''Applications''' tab and gather them into groups under the '''Groups''' tab. 
For clients to install applications on their VPS, the product must include an '''[[#ATC|Application Group]]''' and allow '''[[#CAF|App Templates]]''' in the client area.
|}

==Applications==
{|
|style="padding: 10px 0px 15px 15px;"|Read the guide carefully as it explains the key functions of the ''App Templates'' feature. 
You can hide the information panel after reading by clicking the “Hide” button.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_8.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Switch between ''Applications'', ''ISO Images'', ''Operating Systems'', and ''Snapshots'' using the available tabs. 
Keep in mind that the applications section differs per module. The following example comes from the Vultr VPS module.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_9.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Use the refresh button to download and update the list of templates from your connected platform.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_10.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Once the templates are loaded, you can use the action buttons to edit, duplicate, or delete them. 
Mass action buttons are also available for bulk operations.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_11.png]]
|}

==Groups==
{|
|style="padding: 10px 0px 15px 15px;"|After preparing your templates, group them to make them available to clients through selected products. 
Go to '''App Templates → Groups''' and click on '''Create'''.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_15.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|When creating a group, provide:
'''Name'''
'''Description'''
'''Templates''' to include
|}

{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_16.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|You can edit or delete groups individually or use mass actions to manage several at once.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_17.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|To make templates available for installation, go to the product’s [[#ATC|module settings]] and select the desired groups under '''App Templates Configuration → Default Application Group'''. 
Also, ensure that the '''App Templates''' option is enabled under '''Client Area Features'''.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_19.png]]
|}

==Advanced Configuration==
{|
|style="padding: 10px 0px 30px 15px;"|The ''App Templates'' feature supports detailed configuration, including manual application addition, user-data scripting, and advanced variables. The examples below illustrate these options.
|}

===Adding Applications Manually===
{|
|style="padding: 10px 0px 15px 15px;"|1. You can manually add a single application instead of importing all templates at once. 
1. Navigate to '''App Templates → Applications''' and click on '''Create'''.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_1.png]]
|}
{|
|style="padding: 0px 0px 5px 15px;"|2. List the supported applications provided by your virtualization platform’s API. 
Each platform has different API endpoints to retrieve application data. 
In the case of '''Vultr''', the command to access the list can be found in the [https://www.vultr.com/api/#tag/application/operation/list-applications official documentation]. 

Make sure to include your API Key, the request looks like this:
curl "https://api.vultr.com/v2/applications" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Example result:

{
"applications": [
{
"id": 1,
"name": "LEMP",
"short_name": "lemp",
"deploy_name": "LEMP on CentOS 6 x64",
"type": "one-click",
"vendor": "vultr",
"image_id": ""
}
|}

{|
|style="padding: 0px 0px 15px 15px;"|3. Enter the application details such as '''Name''', '''Description''', '''Status''', and optionally assign an '''icon'''. 
We recommend using the ''name'' or ''deploy_name'' from the API response for easier reference.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|4. Edit your new application and open the '''Setting Details''' section. 
Create entries based on the API output - each entry corresponds to a parameter used when deploying the application.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_3.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|For example, if the API returns:
"id": 1,
"image_id": "",
"user_data": ""
then create fields such as ''id'', ''image_id'', and optionally ''user_data'' if supported.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_5.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Each field includes:
'''Name''' – the parameter name (same as in the API)
'''Default Value''' – the API’s value or your preferred default
'''Visibility''' – whether the client can modify the value
'''Validation''' – optional [https://laravel.com/docs/11.x/validation Laravel validation rule], e.g. `required`
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:VT_19_14_6.png]]
|}

===Including Cloud-Init / User-Data Scripts===
{|
|style="padding: 0px 0px 15px 15px;"|If the selected application or system image supports ''user-data'' or ''cloud-init'' scripts, the ''user_data'' field will appear automatically. 
This field lets you execute initialization tasks such as writing configuration files or running commands on first boot.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_7.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Example:

#cloud-config
write_files:
- path: /etc/motd
content: |
Welcome to your server, {$client.email}!

runcmd:
- apt update
- apt install nginx -y
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_8.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|If ''Visibility'' is enabled, the client can modify the script before deployment. Otherwise, it will execute silently on creation.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:VT_19_14_9.png]]
|}

===How To Use Variables===
{|
|style="padding: 0px 0px 15px 15px;"|You can use merge fields (variables) to dynamically insert values into script content or configuration fields. 
Supported variables depend on the module and provisioning context. Examples include:
'''{$service.id}''' - the WHMCS service ID
* '''{$client.email}''' - client’s email address
* '''{$password}''' - the generated password for the instance
* '''{$hostname}''' - server hostname
* '''{$domain}''' - domain name of the service

Variables can be used in any editable text field, for example:

write_files:
- path: /etc/motd
content: |
Welcome to {$hostname} managed by {$client.email}!
|}

@@ Line 13: / Line 13: @@
 |style="padding: 10px 0px 30px 15px;"|The '''App Templates''' section in the admin area consists of two main parts: '''Applications''' and '''Groups'''.<br/>
 You can create templates under the '''Applications''' tab and gather them into groups under the '''Groups''' tab.<br/>
-For clients to install applications on their VPS, the product must include an '''[[#ATC|Application Group]]''' and allow '''[[#CAF|App Templates]]''' in the client area.
+For clients to install applications on their VPS, the product must include an '''[[#Groups|Application Group]]''' and allow '''[[#Applications|App Templates]]''' in the client area.
 |}

@@ Line 72: / Line 72: @@
 |style="padding: 0px 0px 15px 15px;"|To make templates available for installation, go to the product’s [[#ATC|module settings]] and select the desired groups under '''App Templates Configuration → Default Application Group'''.<br/>
 Also, ensure that the '''App Templates''' option is enabled under '''Client Area Features'''.
 |}
 {|

App Templates Tool - Revision history

Karolina: /* Groups */

Karolina: /* Management */