| Table of Contents |
|---|
About Interworx
Interworx is a smart, scalable and reliable web hosting control panel and is becoming increasingly popular. Learn more about Interworx on their website at http://www.interworx.com/.
Supported Features
| Create | Cancel | Suspend | Unsuspend | Management | Config Options |
|---|---|---|---|---|---|
| YES | YES | YES | YES | YES | NO |
Management Features
This module supports the following management features within the client area:
- Change Interworx Password
Installing Interworx
To install the Interworx module, visit [Settings] > [Company] > [Modules] > Available, and click the "Install" button for Interworx.
A message will be displayed, indicating that the module was successfully installed. Then click the "Add Server" button.
Enter the details for your Interworx Server.
| Field Name | Description |
|---|---|
| Server Label | Enter a label for this Interworx server, it can be anything you like. |
| Hostname | Enter the FQDN hostname for your Interworx server, ie "server1.domain.com". |
| Port Number | Enter the port number for Interworx. The default secure port is 2443. |
| Remote Key | Enter the Remote Key as found in Interworx under NodeWorx > API Key. |
| Use SSL when connecting to the API | Check this option to use SSL for all API requests to your Interworx server. This is highly recommended. If enabled, please ensure that the "Port Number" specified above is the SSL port. |
| Debugging | It may be necessary to debug module calls. Select "Log" to log to the module log in Blesta under Tools > Logs > Module, or "Print" to print to the screen. The "None" option is recommended, and will log only standard calls to the module log. |
| Account Limit | Enter the maximum number of accounts that should be added to this Interworx server. |
| Name servers | Enter the name servers that should be used for this server. These will be available to the package welcome email to the client. |
| Notes | Enter any notes that pertain to this server for future reference. |
After filling out these options, click "Add Server" to add your Interworx server.
Server Groups
Server groups are useful for categorizing Interworx servers. When creating a Package, a specific server, or a server group may be selected for provisioning. Blesta will automatically select an Interworx server to provision with when a server group is chosen.
To add a server group, from the Interworx overview at [Settings] > [Company] > [Modules] > Interworx, click "Add Server Group", then enter the details.
| Option | Details |
|---|---|
| Group Name | Enter the name for this server group. |
| Add Order | Choose how servers in this group will be selected for provisioning. Currently, first non-full server is the only add order. |
| Assigned Servers | Select servers under "Available Servers" and click to move them to the left column to add them to the group. |
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 | A Configurable Option Group may be selected if previously created, but this module does not support configurable options during provisioning. |
| Module | Select "Interworxl" for the module. |
Module Options
The Module Options section consists of the following options, which are specific to Interworx:
Field Name | Description |
|---|---|
| Server Group | Select "Any" if you wish to specify a specific server, or select the Server Group to provision from. Selecting a group means that accounts will be provisioned from the group. Selecting a group is recommended. |
| Server | If "Any" is selected above, select the server this package will use to provision accounts. |
| Account Type | Select "Standard" if this is a standard Interworx account, or "Reseller" if it's a reseller account. |
| Interworx Package | Select the Interworx Package to use when configuring accounts. These values are pulled from "Packages" under SiteWorx in Interworx, or "Packages" under Resellers in Interworx depending upon the Account Type selected above. |
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
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.
Your Interworx account is now active, details below:
Domain: {service.interworx_domain}
Username: {service.interworx_username}
Password: {service.interworx_password}
To log into Interworx, please visit https://{module.host_name}:2443/siteworx/.
Please update your name servers as soon as possible to the following:
{% for name_server in module.name_servers %}
Name server: {name_server} {% endfor %}
Thank you for your business!
When creating or editing a package that uses this module, the following tags will be available:
| Tags | Description | Notes |
|---|---|---|
| {module.host_name} | The host name of the server that the service was provisioned on | e.g. "domain.com" |
| {module.name_servers} | An array of available name servers for this module | Array elements must be looped over in the email template. See below for an example. |
| {module.notes} | The notes set on the module row | |
| {package.type} | The package meta type | e.g. "standard" or "reseller" |
| {package.package} | The Interworx package ID; represents the selected Interworx package name | e.g. "1" |
| {service.interworx_username} | The service field for the Interworx account username | |
| {service.interworx_password} | The service field for the Interworx account password | |
| {service.interworx_domain} | The service field for the Interworx domain | e.g. "domain.com" |
| {service.interworx_email} | The service field for the Inteworx email address |
Displaying Name Servers in the Welcome Email
The {module.name_servers} tag must be iterated over to display the name servers. Email tag usage is elaborated upon on the Customizing Emails page.
Consider an example where the module has two name servers set, named "ns1.domain.com" and "ns2.domain.com". The following can be added to the email template to output the name servers:
{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}
The welcome email will display this as:
Name server: ns1.domain.com Name server: ns2.domain.com
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
Be sure that Interworx's web server options is set to gracefully restart in your Interworx account. If Interworx does not gracefully restart, it is possible that Blesta will not be notified of services created in Interworx, thus causing the service to exist in Interworx but not be added in Blesta.
The only thing left to do is to add this Package Group to an order form so clients may place orders for your Interworx servers. See Creating an Order Form for more details.