| Table of Contents |
|---|
Download from Github
This module can be downloaded from https://github.com/blesta/module-vesta
About Vesta
VestaCP is free shared hosting panel. Learn more about VestaCP on their website at http://vestacp.com/.
Supported Features
| Create | Cancel | Suspend | Unsuspend | Management | Config Options |
|---|---|---|---|---|---|
| YES | YES | YES | YES | NO | YES |
Installing Vesta
To install the Vesta module, visit [Settings] > [Company] > [Modules] > Available, and click the "Install" button for Vesta.
A message will be displayed, indicating that the module was successfully installed. Then click the "Add Server" button.
Enter the details for your VestaCP server.
| Field Name | Description |
|---|---|
| Server Label | Enter a label for this VestaCP server, it can be anything you like. |
| Hostname | Enter the hostname for your VestaCP server, ie "vestacp.mydomain.com". |
| User Name | Enter the username for your VestaCP server, usually "admin". |
| Port | Enter the port for your VestaCP server, usually "8083". |
| Use SSL? | Check the box labeled "Use SSL when connecting to the API (recommended)" to connect over SSL/TLS. |
| Password | Enter the password for the User Name specified above for VestaCP. |
After filling out these options, click "Add Server" to add your Vesta server.
Configurable Options Overview
This module supports configurable options. Configurable Options override any matching Package settings.
| Option Name | Possible Values | Recommended Field Type | Description |
|---|---|---|---|
ssh_access | string = "enable" | Checkbox, Dropdown | Determines whether the account will have SSH access. |
Creating Configurable Options
The following steps describe how to create configurable options. This section describes the following:
- Creating a Configurable Option Group
- Creating Configurable Options, and assigning them to the Group (repeat this step as necessary to create all Configurable Options required)
Creating an Option Group
To create a Configurable Option Group, visit [Packages] > Options, and click the "Create Group" button.
<-- image -->
| Field Name | Description |
|---|---|
| Name | Enter a name for this group. |
| Description | Enter a description for this group (optional). |
| Package Membership | Leave this section blank, we will add the options to the group when creating the options instead. If you have already created the options, you may add them to the group on this step. |
After filling out these options, click the "Create Group" button to create the Option Group.
Creating a Configurable Option
To create a Configurable Option, visit [Packages] > Options, and click the "Create Option" button.
<!-- image -->
| Field Name | Description |
|---|---|
| Label | Enter a label, which will appear above or next to this form field. |
| Name | Enter a name, which is the form field name. (Important! This should match an Option Name described above. The module requires specific naming.) |
| Type | Select the field type from "Checkbox", "Radio", "Drop-down", and "Quantity". |
| Options Section | Set pricing information within the Options section. The fields required here may vary depending on the "Type" selected above. |
| Group Membership Section | Add this Configurable Option to the previously created Option Group by moving the Group from the right to the left in the multi-select box. |
After filling out these options, click the "Create Package Option" button to create the Option. Repeat as necessary to create all of the configurable options you wish to make available to the client during checkout.
Sample Configurable Options
The following are sample configurations for each of the supported configurable options listed above, and may serve as good examples for getting started.
| Option Name | Sample Configuration Screenshot (Click for full size) |
|---|---|
| ssh_access | <!-- image --> |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
Creating a Package consists of several sections:
Basic
The Basic section consists of the following options:
| Field Name | Description |
|---|---|
| Package Name | Enter the name of this Package, it will be visible wherever services are listed and on any order forms. |
| Status | "Active" is the default, "Inactive", and "Restricted" are also available. |
| Quantity Available | If this Package has a limited quantity available, enter the quantity, or leave it as "Unlimited". |
| Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order forms. |
| Configurable Options | Select the Configurable Option Group you created previously, to make those options available for this package. |
| Module | Select "Vesta" for the module. |
Module Options
The Module Options section consists of the following options, which are specific to Vesta:
| Field Name | Description |
|---|---|
| Server Group | Select your VestaCP Server Group, or select "Any". |
| Server | Select the VestaCP Server (If "Any" is selected from the Server Group, otherwise this will not be displayed) |
| Vesta Package Name | Enter the Package Name as displayed in your VestaCP control panel under Packages that you would like to use. |
Pricing
| Field Name | Description |
|---|---|
| Term | Enter the term for the desired pricing option. For example, if you wish to create a 3 month pricing option, enter 3 here. |
| Period | Select the period for this pricing option. "Day", "Week", "Month", "Year", and "One time" are options. The client will be invoiced every "term period", for example every 3 months if 3 is entered for term, and Month is selected for period. |
| Currency | Select the currency this pricing option is available for. |
| Price | Enter the price for this pricing option. |
| Setup Fee | If there is a setup fee, enter it here. |
| Cancellation Fee | If there is a fee to cancel early, enter it here. |
Click the "Add Additional Price" to add more pricing options. It's common for people to create 1 Month, 3 Month, 6 Month, and 1 Year price options. There are many possible combinations.
Welcome Email
<!-- image -->
The "Tags" section describes tags that may be used in the welcome email. The welcome email content is inserted into the "Service Creation" email template under [Settings] > [Company] > [Emails] > Service Creation. Only details unique to this service should be entered into the welcome email section for the package.
Sample Email
This sample email could be used in the Package Welcome Email section to help you get started. Be sure to enter content for your welcome email in both the HTML and Text sections.
Thank you for choosing us for your VestaCP Hosting!
Here are the details for your server:
VestaCP URL: https://{module.host_name}:{module.port}
Domain Name: {service.domain}
User Name: {service.username}
Password: {service.password}
Group Membership
If this is the first Package you are creating with this module, select the "Create a New Group" option, and enter a Group name. If you are adding a subsequent Package and wish for it to be part of the same group, select "Select from Available Groups", and move the group from the right to the left of the multi-select box.
When finished, click "Create Package" to create this package.
Final Steps
The only thing left to do is to add this Package Group to an order form so clients may place orders for your VestaCP servers. See Creating an Order Form for more details.
Common Errors
Error: DNS_RECORDS limit is reached :: upgrade user package
In VestaCP, under "Packages" edit the affected packages and increase the values as they relate to domains, including "Web Domains".