The InterWorx API is a fantastic resource for developers to easily and rapidly achieve integration of InterWorx into their own products. The InterWorx API also allows the technically savvy webhost to automate custom tasks that might otherwise be too difficult or cumbersome to perform manually. It allows complete and total control over almost every aspect that a user would have access to if they were performing the actions themselves through the web interface. It is capable of feeding the same information that a user would see inside the control panel to your own application. The main reason that the API is so robust is that the NodeWorx and SiteWorx web interfaces are API clients themselves - InterWorx operates as an abstracted application model behind the API. That means all new features are added to the API first before they are even accessible in the web interface and that means you will rarely have to wait for something that you can do in the interface to become available in the API.

The API is based on open standards known collectively as “Web Services,” which include XMLRPC, SOAP, and the Web Services Definition Language (WSDL). These standards are supported by a wide range of development tools on a variety of platforms. Since the API requests and responses in the InterWorx API follow current standards, any programming language with the appropriate library support can be used.

SOAP WSDL Point of Contact

https://%%SERVERNAME%%:2443/soap?wsdl

XMLRPC Point of Contact

https://%%SERVERNAME%%:2443/xmlrpc

where %%SERVERNAME%% is the IP or Hostname of the InterWorx server.

The Two API’s

The API is divided into 2 parts just like panel. There is the NodeWorx API which allows you to perform server administration tasks and manage resellers or SiteWorx accounts just like you would in NodeWorx and there’s also a SiteWorx API which pertains to a specific SiteWorx acccount and allows you to perform tasks related to that SiteWorx account. For example to edit a SiteWorx account’s usage quota you’d use the NodeWorx API but to add a new e-mail account you’d use the SiteWorx API.

Authentication

There are three ways to authenticate with the API. The easiest way is to use the e-mail and password of a NodeWorx user and you will be able to perform the actions that the user is permitted to make. You can also use the reseller’s NodeWorx API key. The reseller system is explained in more detail in the Reseller System Guide. This is often preferred because often users lose or change their passwords which would break integration. The API key, on the other hand, will only change if perhaps it is compromised or the NodeWorx reseller wants to discontinue allowing access to a 3rd party application. Lastly, you can use the session ID which might be preferable in instances where the user clicks a button in a plugin and their session ID is passed to your application to provide temporary access to their panel’s functions.

The one thing to remember, though, is when using the SiteWorx API, you must specify a domain to work on or the API won’t know which SiteWorx account you are referring to.

#!/usr/bin/perl -w
#You must install the RPC::XML perl module.
require RPC::XML;
require RPC::XML::Client;
# This is the connection to the XMLRPC service to communicate with the API
$cli = RPC::XML::Client->new('https://%%SERVERNAME%%:2443/xmlrpc');
#This is the API key stuct, pass authentication information here.
$apikey = RPC::XML::struct->new({
'email' => RPC::XML::string->new('siteworx@siteworx.com'),
'password' => RPC::XML::string->new('yourpassword'),
'domain' =>RPC::XML::string->new('%%YOURDOMAIN%%')
});
#This is the API controller
$ctrl_name = RPC::XML::string->new('/siteworx/email/alias');
#This is the API Action
$action = RPC::XML::string->new('add');
#This is how you pass the input, in a struct.
$input = RPC::XML::struct->new({
'username' => RPC::XML::string->new('example'),
'forwardsto' => RPC::XML::string->new('someone@somewhere.com')
});
#This generates a pointer to an RPC::XML::struct object, which contains
# the API's output
#Be aware that even actions that require no input still require the parameter
#Just pass in an empty array
my $resp = $cli->send_request('iworx.route',
$apikey,
$ctrl_name,
$action,
$input);
#value() gives a pointer to a native PERL hash table. This will contain
# the "status" and "payload" keys if the XMLRPC communication with the
# API was successful. If there was a problem and you sent bad data to
# the API, they keys will be "faultString" and "faultCode". You may
# want to do some error checking here.
my $results = $resp->value();
#This assumes that we communicated properly with the API, and got a valid
#response from it.
#We check the key "status". If it's 0, the add alias worked out!
if ($results->{status} == 0){
print "Success!\n";
} else {
print "Failure!\n";
}
#This is here to print out the payload. The payload can be delivered in an
#array or as a string, depending which controller/action you are using.
if (ref($results->{payload}) eq 'ARRAY') {
print "Payload is an array.\n";
my @payload = @{$results->{payload}};
foreach (@payload)
{
my @key = @{$_};
print "@key" . "\n";
}
} else {
print "Payload is a string.\n";
print $results->{payload};
}

Help Entry
The first nameserver to be used for requesting zone data for a given zone. For redundancy, a second (though equally authoritative) nameserver is required.Example Default Value
ns1.interworx.com

No*

ns2

string

Help Entry
The second nameserver to be used for requesting zone data for a given zone. An optional (equally authoritative) third nameserver can be provided for additional redundancy.Example Default Value
ns2.interworx.com

No*

ns3

string

Help Entry
Similar to the secondary nameserver, but it is only used if the primary and secondary server fail.

Description
In SecondsHelp Entry
Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours).Example Default Value
7200

No*

retry

integer

Description
In SecondsHelp Entry
Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes).Example Default Value
300

No*

expire

integer

Description
In SecondsHelp Entry
Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers.Example Default Value
1209600

No*

negative_ttl

integer

Description
In SecondsHelp Entry
Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided.Example Default Value
10800

No*

enforce_rfc1912_cname

integer

Help Entry
RFC1912 states "A CNAME record is not allowed to coexist with any other data." In certain circumstances, you MAY want to relax this restriction if you understand the ramifications.Example Values
1, 0Example Default Value
1

Description
In SecondsHelp Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.Example Default Value
43200

No*

order

integer

Help Entry
An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order.Example Default Value
10

No*

preference

integer

Help Entry
An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record.Example Default Value
100

No*

flag

string

Example Values
S, A, U, P

Yes

service

string

No

regex

string

No

replacement

string

Help Entry
The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN).

Help Entry
The IP Data for a PTR record can be entered in several formats.<ul><li>Normal IPv4 - 1.2.3.4</li><li>Normal IPv6 - beef::12fe</li><li>Hostname - 4.3.2.1.in-addr.arpa</li><li>RFC4183-style - 4.3/29.2.1.in-addr.arpa</li></ul>

No*

ttl

integer

Description
In SecondsHelp Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.Example Default Value
43200

Help Entry
Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly.

Yes

email

string

Help Entry
This is the e-mail address listed on your SOA record. Enter it as a normal e-mail address (user@domain.com) and not in the typical SOA style of (user.domain.com).

Yes

refresh

integer

Description
In SecondsHelp Entry
Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours).

Yes

retry

integer

Description
In SecondsHelp Entry
Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes).

Yes

expiration

integer

Description
In SecondsHelp Entry
Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers.

Yes

negative_ttl

integer

Description
In SecondsHelp Entry
Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided.

Description
In SecondsHelp Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.Example Default Value
43200

No*

order

integer

Help Entry
An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order.Example Default Value
10

No*

preference

integer

Help Entry
An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record.Example Default Value
100

No*

flag

string

Example Values
S, A, U, PExample Default Value
S

No*

service

string

No

regex

string

Example Default Value
!^.*$!sip:info@example.com!

No

replacement

string

Help Entry
The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN).Example Default Value
_sip._udp.example.com

Help Entry
The IP Data for a PTR record can be entered in several formats.<ul><li>Normal IPv4 - 1.2.3.4</li><li>Normal IPv6 - beef::12fe</li><li>Hostname - 4.3.2.1.in-addr.arpa</li><li>RFC4183-style - 4.3/29.2.1.in-addr.arpa</li></ul>Example Default Value
4.3.2.1.in-addr.arpa

No*

ttl

integer

Description
In SecondsHelp Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.Example Default Value
43200

Help Entry
Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly.Example Default Value
{domain}

No*

email

string

Help Entry
This is the e-mail address listed on your SOA record. Enter it as a normal e-mail address (user@domain.com) and not in the typical SOA style of (user.domain.com).Example Default Value
testmaster@{domain}

No*

refresh

integer

Description
In SecondsHelp Entry
Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours).Example Default Value
7200

No*

retry

integer

Description
In SecondsHelp Entry
Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes).Example Default Value
300

No*

expiration

integer

Description
In SecondsHelp Entry
Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers.Example Default Value
1209600

No*

negative_ttl

integer

Description
In SecondsHelp Entry
Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided.Example Default Value
10800

Help Entry
Enter the domain you would like to do DNS for in this box. Be sure that you DO NOT include the ’www’ prefix. The domain should be in the format: yourdomain.com. All top level domain (TLD) extensions are valid (i.e. yourdomain.co.uk).<br /><br />NOTE: If you are editing the zone after its creation, you will not be able to change the domain name; you will have to delete it and create a new one.

Yes

ipaddr

string

Help Entry
IPv4 address to use for variable replacement in DNS Templates.

Yes

ipv6_address

string

Help Entry
IPv6 address to use for variable replacement in DNS Templates.

No

email

string

Help Entry
Email address to use for variable replacement in DNS Templates.

No

Action: delete

Added in version 4.7.0-339

Description Delete a DNS Zone.

Input Parameters

Name

Type

Notes

Required?

zone_id

struct (integer)

Yes

Action: edit

Added in version 4.7.0-339

Description Edit a DNS Zone SOA information.

Warning This action has been deprecated as of version 4.8.0-393. 2011-03-21 Use Ctrl_Nodeworx_DnsRecord::editSOA() instead

Input Parameters

Name

Type

Notes

Required?

zone_id

integer

Yes

nameserver

string

Description
Leave blank for defaultHelp Entry
Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly.Example Default Value
{domain}

No*

contact

string

Description
Leave blank for defaultHelp Entry
This is the e-mail address listed on your SOA record. Enter it as a normal e-mail address (user@domain.com) and not in the typical SOA style of (user.domain.com).Example Default Value
testmaster@{domain}

No*

refresh

integer

Description
In SecondsHelp Entry
Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours).Example Default Value
7200

No*

retry

integer

Description
In SecondsHelp Entry
Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes).Example Default Value
300

No*

expire

integer

Description
In SecondsHelp Entry
Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers.Example Default Value
1209600

No*

negative_ttl

integer

Description
In SecondsHelp Entry
Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided.Example Default Value
10800

Help Entry
When debug mode is enabled, all firewall rules are flushed every 5 minutes to prevent being locked out of the server due to a firewall misconfiguration.Example Values
1, 0Example Default Value
0

Help Entry
Defines if the firewall should block all private ipv4 addresses (reserved address space, generally unroutable on the internet). If the server sites behind a NAT or other routing setup that would make use of private addressing, leave this option ’Off’.Example Values
1, 0Example Default Value
0

No*

max_sessions

integer

Help Entry
Defines the maximum number of connection tracking entries that can be handled by the firewall simultaneously.Example Default Value
34576

# Configure both the RSA and DSA host keys, using the same host key
# files that OpenSSH uses.
SFTPHostKey /etc/ssh/ssh_host_rsa_key
SFTPHostKey /etc/ssh/ssh_host_dsa_key

# Configure the file used for comparing authorized public keys of users.
SFTPAuthorizedUserKeys file:~/.sftp/authorized_keys

# Enable compression
SFTPCompression delayed

# Allow the same number of authentication attempts as OpenSSH.
#
# It is recommended that you explicitly configure MaxLoginAttempts
# for your SSH2/SFTP instance to be higher than the normal
# MaxLoginAttempts value for FTP, as there are more ways to authenticate
# using SSH2.
MaxLoginAttempts 6
</VirtualHost>
</IfModule>

Help Entry
This directive sets the maximum configured value for MaxClients for the lifetime of the web server process.Example Default Value
256

No*

maxclients

integer

Help Entry
The MaxClients directive sets the limit on the number of simultaneous requests that will be served.Example Default Value
256

No*

startservers

integer

Help Entry
The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending on the load, there is usually little reason to adjust this parameter.Example Default Value
8

Help Entry
This monitors the number of idle threads on a per-child basis. If there are too many idle threads in that child, the server will begin to kill threads within that child.Example Default Value
20

No*

maxrequestsperchild

integer

Description
0 is UnlimitedHelp Entry
This directive sets the limit on the number of requests that an individual child server process will handle.Example Default Value
4000

No*

timeout

integer

Help Entry
This is the length of time before the web server kills the thread handling your connection.Example Default Value
60

Help Entry
The Keep-Alive extension to HTTP/1.0 and the persistent connection feature of HTTP/1.1 provide long-lived HTTP sessions which allow multiple requests to be sent over the same TCP connection.Example Default Value
100

No*

keepalivetimeout

integer

Help Entry
The number of seconds the web server will wait for a subsequent request before closing the connection. Once a request has been received, the timeout value specified by the timeout directive applies.Example Default Value
15

Description Displays the information available to the action "autoRestart".

Sample output

array (

’status’ => 0,
’payload’ =>
array (
’apache_autorestart’ => ’0’,
),
)

Action: queryEditConf

Added in version 5.1.0-838

Description Displays the information available to the action "editConf".

Sample output

array (

’status’ => 0,
’payload’ =>
array (
’file’ => ’/etc/httpd/conf/httpd.conf’,
’file_content’ => ’#
# This is the main Apache server configuration file. It contains the
# configuration directives that give the server its instructions.
# See <URL:http://httpd.apache.org/docs/2.2/> for detailed information.
# In particular, see
# <URL:http://httpd.apache.org/docs/2.2/mod/directives.html>
# for a discussion of each configuration directive.
#
#
# Do NOT simply read the instructions in here without understanding
# what they do. They\’re here only as hints or reminders. If you are unsure
# consult the online docs. You have been warned.
#
# The configuration directives are grouped into three basic sections:
# 1. Directives that control the operation of the Apache server process as a
# whole (the \’global environment\’).
# 2. Directives that define the parameters of the \’main\’ or \’default\’ server,
# which responds to requests that aren\’t handled by a virtual host.
# These directives also provide default values for the settings
# of all virtual hosts.
# 3. Settings for virtual hosts, which allow Web requests to be sent to
# different IP addresses or hostnames and have them handled by the
# same Apache server process.
#
# Configuration and logfile names: If the filenames you specify for many
# of the server\’s control files begin with "/" (or "drive:/" for Win32), the
# server will use that explicit path. If the filenames do *not* begin
# with "/", the value of ServerRoot is prepended — so "logs/foo.log"
# with ServerRoot set to "/etc/httpd" will be interpreted by the
# server as "/etc/httpd/logs/foo.log".
#

### Section 1: Global Environment
#
# The directives in this section affect the overall operation of Apache,
# such as the number of concurrent requests it can handle or where it
# can find its configuration files.
#

#
# Don\’t give away too much information about all the subcomponents
# we are running. Comment out this line if you don\’t mind remote sites
# finding out what major optional modules you are running
ServerTokens OS

#
# ServerRoot: The top of the directory tree under which the server\’s
# configuration, error, and log files are kept.
#
# NOTE! If you intend to place this on an NFS (or otherwise network)
# mounted filesystem then please read the LockFile documentation
# (available at <URL:http://httpd.apache.org/docs/2.2/mod/mpm_common.html#lockfile>);
# you will save yourself a lot of trouble.
#
# Do NOT add a slash at the end of the directory path.
#
ServerRoot "/etc/httpd"

#
# PidFile: The file in which the server should record its process
# identification number when it starts. Note the PIDFILE variable in
# /etc/sysconfig/httpd must be set appropriately if this location is
# changed.
#
PidFile run/httpd.pid

#
# Timeout: The number of seconds before receives and sends time out.
#
Timeout 60

#
# KeepAlive: Whether or not to allow persistent connections (more than
# one request per connection). Set to "Off" to deactivate.
#
KeepAlive off

#
# MaxKeepAliveRequests: The maximum number of requests to allow
# during a persistent connection. Set to 0 to allow an unlimited amount.
# We recommend you leave this number high, for maximum performance.
#
MaxKeepAliveRequests 100

#
# KeepAliveTimeout: Number of seconds to wait for the next request from the
# same client on the same connection.
#
KeepAliveTimeout 15

#
# If you wish httpd to run as a different user or group, you must run
# httpd as root initially and it will switch.
#
# User/Group: The name (or #number) of the user/group to run httpd as.
# . On SCO (ODT 3) use "User nouser" and "Group nogroup".
# . On HPUX you may not be able to use shared memory as nobody, and the
# suggested workaround is to create a user www and use that user.
# NOTE that some kernels refuse to setgid(Group) or semctl(IPC_SET)
# when the value of (unsigned)Group is above 60000;
# don\’t use Group #-1 on these systems!
#
User apache
Group apache

### Section 2: \’Main\’ server configuration
#
# The directives in this section set up the values used by the \’main\’
# server, which responds to any requests that aren\’t handled by a
# <VirtualHost> definition. These values also provide defaults for
# any <VirtualHost> containers you may define later in the file.
#
# All of these directives may appear inside <VirtualHost> containers,
# in which case these default settings will be overridden for the
# virtual host being defined.
#

#
# ServerAdmin: Your address, where problems with the server should be
# e-mailed. This address appears on some server-generated pages, such
# as error documents. e.g. admin@your-domain.com
#
ServerAdmin root@localhost

#
# ServerName gives the name and port that the server uses to identify itself.
# This can often be determined automatically, but we recommend you specify
# it explicitly to prevent problems during startup.
#
# If this is not set to valid DNS name for your host, server-generated
# redirections will not work. See also the UseCanonicalName directive.
#
# If your host doesn\’t have a registered DNS name, enter its IP address here.
# You will have to access it by its address anyway, and this will make
# redirections work in a sensible way.
#
#ServerName www.example.com:80

#
# UseCanonicalName: Determines how Apache constructs self-referencing
# URLs and the SERVER_NAME and SERVER_PORT variables.
# When set "Off", Apache will use the Hostname and Port supplied
# by the client. When set "On", Apache will use the value of the
# ServerName directive.
#
UseCanonicalName Off

#
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory, but
# symbolic links and aliases may be used to point to other locations.
#
DocumentRoot "/var/www/html"

#
# Each directory to which Apache has access can be configured with respect
# to which services and features are allowed and/or disabled in that
# directory (and its subdirectories).
#
# First, we configure the "default" to be a very restrictive set of
# features.
#
<Directory />
Options FollowSymLinks
AllowOverride All
</Directory>

#
# Note that from this point forward you must specifically allow
# particular features to be enabled - so if something\’s not working as
# you might expect, make sure that you have specifically enabled it
# below.
#

#
# This should be changed to whatever you set DocumentRoot to.
#
<Directory "/var/www/html">

#
# Possible values for the Options directive are "None", "All",
# or any combination of:
# Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews
#
# Note that "MultiViews" must be named *explicitly* — "Options All"
# doesn\’t give it to you.
#
# The Options directive is both complicated and important. Please see
# http://httpd.apache.org/docs/2.2/mod/core.html#options
# for more information.
#
Options Indexes FollowSymLinks

#
# AllowOverride controls what directives may be placed in .htaccess files.
# It can be "All", "None", or any combination of the keywords:
# Options FileInfo AuthConfig Limit
#
AllowOverride None

#
# Controls who can get stuff from this server.
#
Order allow,deny
Allow from all

</Directory>

#
# UserDir: The name of the directory that is appended onto a user\’s home
# directory if a ~user request is received.
#
# The path to the end user account \’public_html\’ directory must be
# accessible to the webserver userid. This usually means that ~userid
# must have permissions of 711, ~userid/public_html must have permissions
# of 755, and documents contained therein must be world-readable.
# Otherwise, the client will only receive a "403 Forbidden" message.
#
# See also: http://httpd.apache.org/docs/misc/FAQ.html#forbidden
#
<IfModule mod_userdir.c>
#
# UserDir is disabled by default since it can confirm the presence
# of a username on the system (depending on home directory
# permissions).
#
#UserDir disabled

#
# To enable requests to /~user/ to serve the user\’s public_html
# directory, remove the "UserDir disabled" line above, and uncomment
# the following line instead:
#
UserDir public_html

</IfModule>

#
# Control access to UserDir directories. The following is an example
# for a site where these directories are restricted to read-only.
#
#<Directory /home/*/public_html>
# AllowOverride FileInfo AuthConfig Limit
# Options MultiViews Indexes SymLinksIfOwnerMatch IncludesNoExec
# <Limit GET POST OPTIONS>
# Order allow,deny
# Allow from all
# </Limit>
# <LimitExcept GET POST OPTIONS>
# Order deny,allow
# Deny from all
# </LimitExcept>
#</Directory>

#
# DirectoryIndex: sets the file that Apache will serve if a directory
# is requested.
#
# The index.html.var file (a type-map) is used to deliver content-
# negotiated documents. The MultiViews Option can be used for the
# same purpose, but it is much slower.
#
DirectoryIndex index.html index.html.var

#
# AccessFileName: The name of the file to look for in each directory
# for additional configuration directives. See also the AllowOverride
# directive.
#
AccessFileName .htaccess

#
# The following lines prevent .htaccess and .htpasswd files from being
# viewed by Web clients.
#
<Files ~ "^\\.ht">
Order allow,deny
Deny from all
Satisfy All
</Files>

#
# DefaultType is the default MIME type the server will use for a document
# if it cannot otherwise determine one, such as from filename extensions.
# If your server contains mostly text or HTML documents, "text/plain" is
# a good value. If most of your content is binary, such as applications
# or images, you may want to use "application/octet-stream" instead to
# keep browsers from trying to display binary files as though they are
# text.
#
DefaultType text/plain

#
# The mod_mime_magic module allows the server to use various hints from the
# contents of the file itself to determine its type. The MIMEMagicFile
# directive tells the module where the hint definitions are located.
#
<IfModule mod_mime_magic.c>
# MIMEMagicFile /usr/share/magic.mime
MIMEMagicFile conf/magic
</IfModule>

#
# HostnameLookups: Log the names of clients or just their IP addresses
# e.g., www.apache.org (on) or 204.62.129.132 (off).
# The default is off because it\’d be overall better for the net if people
# had to knowingly turn this feature on, since enabling it means that
# each client request will result in AT LEAST one lookup request to the
# nameserver.
#
HostnameLookups Off

#
# EnableMMAP: Control whether memory-mapping is used to deliver
# files (assuming that the underlying OS supports it).
# The default is on; turn this off if you serve from NFS-mounted
# filesystems. On some systems, turning it off (regardless of
# filesystem) can improve performance; for details, please see
# http://httpd.apache.org/docs/2.2/mod/core.html#enablemmap
#
#EnableMMAP off

#
# EnableSendfile: Control whether the sendfile kernel support is
# used to deliver files (assuming that the OS supports it).
# The default is on; turn this off if you serve from NFS-mounted
# filesystems. Please see
# http://httpd.apache.org/docs/2.2/mod/core.html#enablesendfile
#
#EnableSendfile off

#
# ErrorLog: The location of the error log file.
# If you do not specify an ErrorLog directive within a <VirtualHost>
# container, error messages relating to that virtual host will be
# logged here. If you *do* define an error logfile for a <VirtualHost>
# container, that host\’s errors will be logged there and not here.
#
ErrorLog logs/error_log

#
# The location and format of the access logfile (Common Logfile Format).
# If you do not define any access logfiles within a <VirtualHost>
# container, they will be logged here. Contrariwise, if you *do*
# define per-<VirtualHost> access logfiles, transactions will be
# logged therein and *not* in this file.
#
#CustomLog logs/access_log common

#
# If you would like to have separate agent and referer logfiles, uncomment
# the following directives.
#
#CustomLog logs/referer_log referer
#CustomLog logs/agent_log agent

#
# For a single logfile with access, agent, and referer information
# (Combined Logfile Format), use the following directive:
#
CustomLog logs/access_log combined

#
# Optionally add a line containing the server version and virtual host
# name to server-generated pages (internal error documents, FTP directory
# listings, mod_status and mod_info output etc., but not CGI generated
# documents or custom error documents).
# Set to "EMail" to also include a mailto: link to the ServerAdmin.
# Set to one of: On | Off | EMail
#
ServerSignature On

#
# Aliases: Add here as many aliases as you need (with no limit). The format is
# Alias fakename realname
#
# Note that if you include a trailing / on fakename then the server will
# require it to be present in the URL. So "/icons" isn\’t aliased in this
# example, only "/icons/". If the fakename is slash-terminated, then the
# realname must also be slash terminated, and if the fakename omits the
# trailing slash, the realname must also omit it.
#
# We include the /icons/ alias for FancyIndexed directory listings. If you
# do not use FancyIndexing, you may comment this out.
#
Alias /icons/ "/var/www/icons/"

#
# ScriptAlias: This controls which directories contain server scripts.
# ScriptAliases are essentially the same as Aliases, except that
# documents in the realname directory are treated as applications and
# run by the server when requested rather than as documents sent to the client.
# The same rules about trailing "/" apply to ScriptAlias directives as to
# Alias.
#
ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"

#
# "/var/www/cgi-bin" should be changed to whatever your ScriptAliased
# CGI directory exists, if you have that configured.
#
<Directory "/var/www/cgi-bin">
AllowOverride None
Options None
Order allow,deny
Allow from all
</Directory>

#
# Redirect allows you to tell clients about documents which used to exist in
# your server\’s namespace, but do not anymore. This allows you to tell the
# clients where to look for the relocated document.
# Example:
# Redirect permanent /foo http://www.example.com/bar

#
# AddIcon* directives tell the server which icon to show for different
# files or filename extensions. These are only displayed for
# FancyIndexed directories.
#
AddIconByEncoding (CMP,/icons/compressed.gif) x-compress x-gzip

#
# ReadmeName is the name of the README file the server will look for by
# default, and append to directory listings.
#
# HeaderName is the name of a file which should be prepended to
# directory indexes.
ReadmeName README.html
HeaderName HEADER.html

#
# IndexIgnore is a set of filenames which directory indexing should ignore
# and not include in the listing. Shell-style wildcarding is permitted.
#
IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

#
# LanguagePriority allows you to give precedence to some languages
# in case of a tie during content negotiation.
#
# Just list the languages in decreasing order of preference. We have
# more or less alphabetized them here. You probably want to change this.
#
LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW

#
# ForceLanguagePriority allows you to serve a result page rather than
# MULTIPLE CHOICES (Prefer) [in case of a tie] or NOT ACCEPTABLE (Fallback)
# [in case no accepted languages matched the available variants]
#
ForceLanguagePriority Prefer Fallback

#
# Specify a default charset for all content served; this enables
# interpretation of all content as UTF-8 by default. To use the
# default browser choice (ISO-8859-1), or to allow the META tags
# in HTML content to override this choice, comment out this
# directive:
#
AddDefaultCharset UTF-8

#
# AddEncoding allows you to have certain browsers uncompress
# information on the fly. Note: Not all browsers support this.
# Despite the name similarity, the following Add* directives have nothing
# to do with the FancyIndexing customization directives above.
#
#AddEncoding x-compress .Z
#AddEncoding x-gzip .gz .tgz

#
# AddHandler allows you to map certain file extensions to "handlers":
# actions unrelated to filetype. These can be either built into the server
# or added with the Action directive (see below)
#
# To use CGI scripts outside of ScriptAliased directories:
# (You will also need to add "ExecCGI" to the "Options" directive.)
#
#AddHandler cgi-script .cgi

#
# For files that include their own HTTP headers:
#
#AddHandler send-as-is asis

#
# Filters allow you to process content before it is sent to the client.
#
# To parse .shtml files for server-side includes (SSI):
# (You will also need to add "Includes" to the "Options" directive.)
#
AddType text/html .shtml
AddOutputFilter INCLUDES .shtml

#
# Putting this all together, we can internationalize error responses.
#
# We use Alias to redirect any /error/HTTP_<error>.html.var response to
# our collection of by-error message multi-language collections. We use
# includes to substitute the appropriate text.
#
# You can modify the messages\’ appearance without changing any of the
# default HTTP_<error>.html.var files by adding the line:
#
# Alias /error/include/ "/your/include/path/"
#
# which allows you to create your own set of files by starting with the
# /var/www/error/include/ files and
# copying them to /your/include/path/, even on a per-VirtualHost basis.
#

### Section 3: Virtual Hosts
#
# VirtualHost: If you want to maintain multiple domains/hostnames on your
# machine you can setup VirtualHost containers for them. Most configurations
# use only name-based virtual hosts so the server doesn\’t need to worry about
# IP addresses. This is indicated by the asterisks in the directives below.
#
# Please see the documentation at
# <URL:http://httpd.apache.org/docs/2.2/vhosts/>
# for further details before you try to setup virtual hosts.
#
# You may use the command line option \’-S\’ to verify your virtual host
# configuration.

#
# Use name-based virtual hosting.
#
#NameVirtualHost *:80
#
# NOTE: NameVirtualHost cannot be used without a port specifier
# (e.g. :80) if mod_ssl is being used, due to the nature of the
# SSL protocol.
#

Help Entry
The method the web service uses to connect to PHP. InterWorx strongly recommends avoiding mod_php, which executes all sites as the Apache user and presents a security risk.Example Values
mod_php, mod_suphp, php-fpmExample Default Value
mod_suphp

Description
Leave blank for defaultHelp Entry
This is the web location that the browser will be redirected to if they navigate directly to the IP address in their browser, i.e. http://203.0.113.22/. If you chose a blank value, the request will display a "default" splash page. The files for the default splash page are at /var/www/html/. You can choose one of the domains on that IP address, or any other domain you prefer.

Description
CIDR NotationHelp Entry
Use Classless Inter Domain Routing (CIDR) notation to designate a block of IPs to use in the pool - for example, 2001:db8::/32. The CIDR is used to define the size of the pool to pull from, not the netmask of the resulting IPs.

Yes

cidr

integer

Description
CIDR NotationHelp Entry
Netmask to use with IPs pulled from the pool.Example Default Value
128

No*

subpool_size

integer

Description
CIDR NotationHelp Entry
This value determines the size of smaller, dedicated Subpools that will be generated from the parent. Each Subpool will be dedicated to a single SiteWorx account, allowing easier management of IPv6 networking. To disable the feature, leave the Subpool Size the same as the CIDR of the Pool itself.

Yes

device

string

Example Values
eth0, lo

Yes

gateway

string

Yes

distribution_policy

string

Help Entry
The Distribution Policy controls how IPv6 Addresses are assigned from the pool.Example Values
random, sequentialExample Default Value
sequential

Help Entry
The default domain appending to any address that does not include a domain portion (i.e. a missing @domain.com will be translated to use the default domain).Example Default Value
unit.interworx.com

Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSmtp::updateInbound

Input Parameters

Name

Type

Notes

Required?

smtp_greeting

string

Help Entry
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server. This must begin with a fully qualified domain name (FQDN) per RFC 2821.Example Default Value
p1.unit.interworx.com InterWorx-CP SMTP Server

No*

concurrency_incoming

integer

Help Entry
The total number of inbound remote connections allowed simultaneously.Example Default Value
20

Help Entry
The MTA level blacklist allows you to blacklist e-mail addresses at a very low level so they are denied before further processing takes place.Example Default Value
[".*\\ @.*","!.*@.*\\..*",".*%.*"]

No

realtime_sbl_blacklists

struct (string)

Example Default Value
["bl.spamcop.net"]

No

cascade_to_nodes

integer

Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manuallyExample Values
1

Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSend::update

Input Parameters

Name

Type

Notes

Required?

concurrency_remote

integer

Help Entry
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time.Example Default Value
255

No*

timeout_remote

integer

Description
In SecondsHelp Entry
"Timeout Remote" changes the amount of time that Qmail will wait for a remote connection to respond to most communications.Example Default Value
600

No*

timeout_connect

integer

Description
In SecondsHelp Entry
"Timeout Connect" changes the amount of time that Qmail will wait for a remote connection to an SMTP server.Example Default Value
60

No*

queue_lifetime

integer

Description
In SecondsHelp Entry
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged.Example Default Value
604800

No*

smtp_routes

struct (string)

Help Entry
Artificial SMTP routes. If the domain matches the host, qmail-remote will connect to relay, as if host had relay as its only MX Record. The syntax for this field is [domain]:[destination server] and [domain] may be blank if you want all mail to be routed to [destination server]

No

cascade_to_nodes

integer

Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manuallyExample Values
1

Help Entry
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time.Example Default Value
255

No*

timeout_remote

integer

Description
In SecondsHelp Entry
"Timeout Remote" changes the amount of time that Qmail will wait for a remote connection to respond to most communications.Example Default Value
600

No*

timeout_connect

integer

Description
In SecondsHelp Entry
"Timeout Connect" changes the amount of time that Qmail will wait for a remote connection to an SMTP server.Example Default Value
60

No*

queue_lifetime

integer

Description
In SecondsHelp Entry
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged.Example Default Value
604800

No*

smtp_routes

struct (string)

Help Entry
Artificial SMTP routes. If the domain matches the host, qmail-remote will connect to relay, as if host had relay as its only MX Record. The syntax for this field is [domain]:[destination server] and [domain] may be blank if you want all mail to be routed to [destination server]

No

cascade_to_nodes

integer

Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manuallyExample Values
1

Help Entry
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server. This must begin with a fully qualified domain name (FQDN) per RFC 2821.Example Default Value
p1.unit.interworx.com InterWorx-CP SMTP Server

No*

concurrency_incoming

integer

Help Entry
The total number of inbound remote connections allowed simultaneously.Example Default Value
20

Help Entry
The MTA level blacklist allows you to blacklist e-mail addresses at a very low level so they are denied before further processing takes place.Example Default Value
[".*\\ @.*","!.*@.*\\..*",".*%.*"]

No

realtime_sbl_blacklists

struct (string)

Example Default Value
["bl.spamcop.net"]

No

cascade_to_nodes

integer

Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manuallyExample Values
1

Description
Port 587 RecommendedHelp Entry
This is the port for running your alternate SMTP server. The default (and recommended) port is 587 but can be any usable port on the box.Example Default Value
587

Help Entry
Use the dropdown to enable or disable Bayes scanning. Given training, Bayes will learn which emails are most likely spam and most likely ham (not spam) and deal with these emails according to your preferences.Example Values
1, 0Example Default Value
1

No*

bayes_auto_learn

integer

Help Entry
Use the dropdown to enable or disable Bayes auto learning. If enabled, the system will automatically train the Bayes database by analyzing messages that have a score that strongly suggests that they are spam or non-spam.Example Values
1, 0Example Default Value
1

No*

bayes_imap_training

integer

Help Entry
Use the dropdown to enable or disable IMAP training. With Bayes IMAP training enabled, there will be two folders created for all e-mail accounts on the system: "Learn Spam" and "Learn Ham". You can then put SPAM emails in the "Learn Spam" folder and non-spam in the "Learn Ham" folder. This will train the Bayes system on which emails are Spam and which are Ham (not Spam). The training occurs once daily, after which the folders’ contents are purged.Example Values
1, 0Example Default Value
1

No*

bayes_imap_training_limit

integer

Description
Per DayHelp Entry
The maximum number of e-mails that will be trained from each of the IMAP Training Folders, "Learn Spam" and "Learn Ham," each day.Example Default Value
250

No*

global_bayes_database

integer

Help Entry
Use the dropdown to enable or disable the Bayes global database. If enabled, all the Bayes data will be stored as a single global user. If disabled, each e-mail box user will have their own Bayes database to store Bayesian data. "Disabled" is considered more effective for fighting Spam, but requires all e-mail users to train their messages individually, and uses more disk space, compared to the global database option.Example Values
1, 0Example Default Value
0

Help Entry
Use the whitelist text field to enter email addresses or domains that are valid to send email from on a server-wide level.

No

global_blacklist

struct (string)

Help Entry
Use the blacklist text field to enter email addresses or domains that are not valid to send email from on a server-wide level. To block all emails from a domain, use ’*’, as in ’*@domain.com’.

No

trusted_networks

struct (string)

Help Entry
Relay hosts added here are considered to not be potentially operated by spammers, open relays, or open proxies.

No

Action: updateOptions

Added in version 4.7.0-339

Description Update spamassassin options.

Input Parameters

Name

Type

Notes

Required?

smtp_level_scanning

integer

Help Entry
This option will scan all e-mail using the SpamAssassin content filter as the e-mail enters the server. The SMTP connection will be dropped only if the Spam Score is higher than the SMTP Spam Score option below. Otherwise, the e-mail will still be delivered to the recipient.<br><br><strong>WARNING</strong>: You may not want to enable this setting. It has no bearing on the SpamAssassin setting in SiteWorx, so e-mail messages may be scanned twice if this setting is enabled.Example Values
1, 0Example Default Value
0

No*

smtp_level_spam_score

double

Help Entry
<b>SMTP Spam Score.</b> This is the SpamAssassin score threshold at which the SMTP server will reject a message before local delivery begins. If you do not want to block any spam at the SMTP level, use a very high number.Example Default Value
95

No*

spam_max_filesize

double

Help Entry
Set the maximum message size to be scanned — any bigger than this threshold and the message will be returned unprocessed.Example Default Value
262144

No*

rewrite_header_subject

string

Help Entry
Emails marked as Spam will have the email subject rewritten with what is entered here.

No

report_safe

integer

Help Entry
This option sets the method of delivering the actual e-mail spam message. The email can be sent unchanged but with the subject rewritten, it can be attached to an email from SpamAssassin, or it can be attached as plain text to an email from SpamAssassin.Example Values
0, 1, 2Example Default Value
1

Description Lists the service name - ie "httpd" instead of "web server".

Sample output

array (

’status’ => 0,
’payload’ => ’mysqld’,
)

Action: listServicePage

Added in version 4.7.0-339

Description Lists the page that controls the service.

Sample output

array (

’status’ => 0,
’payload’ => ’/nodeworx/mysql’,
)

Action: nickname

Added in version 4.7.0-339

Description Change a mysql server’s nickname.

Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::nickname

Input Parameters

Name

Type

Notes

Required?

server

string

Help Entry
Select the database server from the list that you would like to use.Example Values
localhost

Yes

Action: options

Added in version 4.7.0-339

Description Configure various mysql service options.

Input Parameters

Name

Type

Notes

Required?

max_connections

integer

Help Entry
The number of connections to the MySQL server allowed at once.Example Default Value
151

No*

max_connect_errors

integer

Help Entry
If set, the server blocks further connections from a remote host when the number of interrupted connections from that host exceeds this number. You can unblock a host with the command FLUSH HOSTS.Example Default Value
10

No*

connect_timeout

integer

Description
In SecondsHelp Entry
The number in seconds of MySQL connection timeout. This is also used for the first answer from the server.Example Default Value
10

No*

wait_timeout

integer

Description
In SecondsHelp Entry
The number of seconds the server waits for activity on a connection before closing it.Example Default Value
28800

No*

key_buffer_size

integer

Description
In BytesHelp Entry
This is the memory buffer shared by all threads. Other buffers used by the server are allocated as needed.Example Default Value
8384512

No*

sort_buffer_size

integer

Description
In BytesHelp Entry
The size of the buffer used when sorting table data. The default value is 1MB. This option is available only for isamchk.Example Default Value
2097144

No*

read_buffer_size

integer

Description
In BytesHelp Entry
The size of the buffer used to store data being read from files. The default value is 260KB. This option is available only for isamchk.Example Default Value
131072

No*

max_allowed_packet

integer

Description
In BytesHelp Entry
Set the maximum packet length to send to or receive from the server. The default value is 16MB.Example Default Value
1048576

No*

thread_cache_size

integer

Help Entry
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.Example Default Value
0

No*

table_open_cache

integer

Help Entry
Set the number of open tables cached. Table cache is related to max connections. For example, for 200 concurrent running connections, you should have a table cache of at least 200 * N, where N is the maximum number of tables in a join. You also need to reserve some extra file descriptors for temporary tables and files.Example Default Value
64

No*

query_cache_limit

integer

Description
In BytesHelp Entry
Set the maximum size of individual query results that can be cached. The default value is 1MB.Example Default Value
1048576

No*

query_cache_size

integer

Description
In BytesHelp Entry
Set the size of the query cache. Setting it to 0 disables the query cache. The default cache size is 0.Example Default Value
0

No*

cascade_to_nodes

integer

Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manuallyExample Values
1

Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed

Yes

OPT_EMAIL_AUTORESPONDERS

integer

Help Entry
The number of e-mail autoresponders, also called robots, allowed

Yes

OPT_EMAIL_BOXES

integer

Help Entry
The number of POP3/IMAP e-mail boxes allowed

Yes

OPT_EMAIL_GROUPS

integer

Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed

Yes

OPT_FTP_ACCOUNTS

integer

Help Entry
The number of FTP accounts allowed

Yes

OPT_MYSQL_DBS

integer

Help Entry
The number of MySQL databases allowed

Yes

OPT_MYSQL_DB_USERS

integer

Help Entry
The number of MySQL users allowed

Yes

OPT_POINTER_DOMAINS

integer

Help Entry
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.

Yes

OPT_SLAVE_DOMAINS

integer

Help Entry
The number of secondary domains allowed. Sometimes called "add-on" domains.

Yes

OPT_SUBDOMAINS

integer

Help Entry
The number of subdomains allowed

Yes

OPT_BACKUP

integer

Help Entry
Enables the ability to backup the accountExample Values
1, 0

Yes

OPT_CGI_ACCESS

integer

Help Entry
Indicator of whether or not CGI script access is enabledExample Values
1, 0

Yes

OPT_CRONTAB

integer

Help Entry
Access to CrontabExample Values
1, 0

Yes

OPT_DNS_RECORDS

integer

Help Entry
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)Example Values
1, 0

Yes

OPT_SSL

integer

Help Entry
Enable SSL CertificatesExample Values
1, 0

Yes

OPT_BURSTABLE

integer

Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.Example Values
1, 0

Yes

OPT_SAVE_XFER_LOGS

integer

Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.Example Values
1, 0

Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.Example Values
1, 0Example Default Value
1

No*

OPT_SAVE_XFER_LOGS

integer

Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.Example Values
1, 0Example Default Value
1

Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.Example Values
, Package By Test

No

create_package

integer

Example Values
1

No

new_package_name

string

No

RSL_OPT_STORAGE

double

Description
MegabytesHelp Entry
The amount of storage allocated to this reseller

Yes

RSL_OPT_BANDWIDTH

double

Description
Gigabytes / MonthHelp Entry
The amount of bandwidth per month allocated to this reseller

Yes

RSL_OPT_EMAIL_ALIASES

integer

Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_AUTORESPONDERS

integer

Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_BOXES

integer

Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_GROUPS

integer

Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller

Yes

RSL_OPT_FTP_ACCOUNTS

integer

Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller

Yes

RSL_OPT_MYSQL_DBS

integer

Help Entry
The number of MySQL databases allowed allowed across all accounts owned by this reseller

Yes

RSL_OPT_MYSQL_DB_USERS

integer

Help Entry
The number of MySQL users allowed across all accounts owned by this reseller

Yes

RSL_OPT_POINTER_DOMAINS

integer

Help Entry
The number of pointer domains allowed across all accounts owned by this reseller

Yes

RSL_OPT_SITEWORX_ACCOUNTS

integer

Help Entry
The number of SiteWorx accounts this reseller can create

Yes

RSL_OPT_SLAVE_DOMAINS

integer

Help Entry
The number of secondary domains allowed across all accounts owned by this reseller

Yes

RSL_OPT_SUBDOMAINS

integer

Help Entry
The number of subdomains allowed across all accounts owned by this reseller

Yes

RSL_OPT_OVERSELL_STORAGE

integer

Help Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.Example Values
1, 0Example Default Value
1

No*

RSL_OPT_OVERSELL_BANDWIDTH

integer

Help Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.Example Values
1, 0Example Default Value
1

Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.Example Values
, Package By Test

Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_AUTORESPONDERS

integer

Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_BOXES

integer

Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_GROUPS

integer

Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_FTP_ACCOUNTS

integer

Help Entry
The number of FTP accounts allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_MYSQL_DBS

integer

Help Entry
The number of MySQL databases allowed allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_MYSQL_DB_USERS

integer

Help Entry
The number of MySQL users allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_POINTER_DOMAINS

integer

Help Entry
The number of pointer domains allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_SITEWORX_ACCOUNTS

integer

Help Entry
The number of SiteWorx accounts this reseller can createExample Default Value
999999999

No*

RSL_OPT_SLAVE_DOMAINS

integer

Help Entry
The number of secondary domains allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_SUBDOMAINS

integer

Help Entry
The number of subdomains allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_OVERSELL_STORAGE

integer

Description
MegabytesHelp Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.Example Values
1, 0Example Default Value
1

No*

RSL_OPT_OVERSELL_BANDWIDTH

integer

Description
Gigabytes / MonthHelp Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.Example Values
1, 0Example Default Value
1

Description
MegabytesHelp Entry
The amount of storage allocated to this reseller

Yes

RSL_OPT_OVERSELL_STORAGE

integer

Description
MegabytesHelp Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.Example Values
1, 0

Yes

RSL_OPT_BANDWIDTH

double

Description
Gigabytes / MonthHelp Entry
The amount of bandwidth per month allocated to this reseller

Yes

RSL_OPT_OVERSELL_BANDWIDTH

integer

Description
Gigabytes / MonthHelp Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.Example Values
1, 0

Yes

RSL_OPT_EMAIL_ALIASES

integer

Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_AUTORESPONDERS

integer

Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_BOXES

integer

Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller

Yes

RSL_OPT_EMAIL_GROUPS

integer

Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller

Yes

RSL_OPT_FTP_ACCOUNTS

integer

Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller

Yes

RSL_OPT_MYSQL_DBS

integer

Help Entry
The number of MySQL databases allowed allowed across all accounts owned by this reseller

Yes

RSL_OPT_MYSQL_DB_USERS

integer

Help Entry
The number of MySQL users allowed across all accounts owned by this reseller

Yes

RSL_OPT_POINTER_DOMAINS

integer

Help Entry
The number of pointer domains allowed across all accounts owned by this reseller

Yes

RSL_OPT_SITEWORX_ACCOUNTS

integer

Help Entry
The number of SiteWorx accounts this reseller can create

Yes

RSL_OPT_SLAVE_DOMAINS

integer

Help Entry
The number of secondary domains allowed across all accounts owned by this reseller

Yes

RSL_OPT_SUBDOMAINS

integer

Help Entry
The number of subdomains allowed across all accounts owned by this reseller

Description
MegabytesHelp Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.Example Values
1, 0Example Default Value
1

Description
Gigabytes / MonthHelp Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.Example Values
1, 0Example Default Value
1

No*

RSL_OPT_EMAIL_ALIASES

integer

Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_AUTORESPONDERS

integer

Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_BOXES

integer

Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_EMAIL_GROUPS

integer

Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_FTP_ACCOUNTS

integer

Help Entry
The number of FTP accounts allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_MYSQL_DBS

integer

Help Entry
The number of MySQL databases allowed allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_MYSQL_DB_USERS

integer

Help Entry
The number of MySQL users allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_POINTER_DOMAINS

integer

Help Entry
The number of pointer domains allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_SITEWORX_ACCOUNTS

integer

Help Entry
The number of SiteWorx accounts this reseller can createExample Default Value
999999999

No*

RSL_OPT_SLAVE_DOMAINS

integer

Help Entry
The number of secondary domains allowed across all accounts owned by this resellerExample Default Value
999999999

No*

RSL_OPT_SUBDOMAINS

integer

Help Entry
The number of subdomains allowed across all accounts owned by this resellerExample Default Value
999999999

Description
Link to use for SiteWorx support. NOTE: this may be overridden in custom templates.Example Default Value
http://www.interworx.com/support/faq/topics/siteworx-faq/

No*

siteworx_show_box_size

integer

Description
Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes.Help Entry
Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes.Example Values
1, 0Example Default Value
1

No*

siteworx.logs_savexferlogs

integer

Description
Defines how many days to keep daily transfer logs on SiteWorx accounts before purging them.Example Default Value
7

No*

siteworx.logs_saveerrlogs

integer

Description
Defines how many days to keep daily error logs on SiteWorx accounts before purging them.Example Default Value
7

No*

siteworx_allow_crossaccount_subdomains

integer

Description
Having subdomains split to their own SiteWorx accounts is desirable in many cases - for example, it allows the subdomain to run under its own Unix User for security. However, a malicious user could create their own Secondary Domain to hijack a subdomain of another account.Example Values
1, 0Example Default Value
1

Description
This number ONLY applies to backups stored in the "default" backup storage location for a given account (/home/user/domain/iworx-backup). Scheduled backups that are transferred via the SCP or FTP transfer mechanisms are NOT rotated.Help Entry
Indicates the maximum number of backups to keep before removing old backups.Example Default Value
25

Description
This is the default network device used for charts. Updating this value may not show an immediate change: chart images are cached for a short time.Example Values
eth0, loExample Default Value
eth0

No*

apache.file_vhost-base

string

Description
File to use as the template for creating virtual hosts when creating SiteWorx accounts and secondary domains.Example Default Value
/home/interworx/etc/vhost-base.conf

Help Entry
Enter the domain name you would like to setup a SiteWorx account for on this line. You should enter the domain name only, WITHOUT the ’www’ prefix (i.e. yourdomain.com and NOT www.yourdomain.com). If you would like to setup an account with a prefix, (i.e. games.yourdomain.com) you can do that here, and it will make a SiteWorx account for that domain. You can also setup yourdomain.com and then add a ’games’ subdomain from within SiteWorx if you prefer.

Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.Example Values
, unlimited, fifteens

Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.Example Values
1, 0Example Default Value
0

No*

OPT_SAVE_XFER_LOGS

integer

Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.Example Values
1, 0Example Default Value
0

Help Entry
A ’nickname’ can be given to each SiteWorx account holder. This field is optional.Example Default Value
Example User

No

email

string

Help Entry
Enter the e-mail address of this SiteWorx account holder. This will serve as a contact address for the account and will be used by the account holder to log into SiteWorx.Example Default Value
user@example.com

Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.Example Values
__example.com, unlimited, fifteensExample Default Value
__example.com

Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.Example Values
1, 0Example Default Value
1

No*

OPT_SAVE_XFER_LOGS

integer

Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.Example Values
1, 0Example Default Value
1

# This is the sshd server system-wide configuration file. See
# sshd_config(5) for more information.

# This sshd was compiled with PATH=/usr/local/bin:/bin:/usr/bin

# The strategy used for options in the default sshd_config shipped with
# OpenSSH is to specify options with their default value where
# possible, but leave them commented. Uncommented options change a
# default value.

#Port 22
#AddressFamily any
#ListenAddress 0.0.0.0
#ListenAddress ::

# Disable legacy (protocol version 1) support in the server for new
# installations. In future the default will change to require explicit
# activation of protocol 1
Protocol 2

# For this to work you will also need host keys in /etc/ssh/ssh_known_hosts
#RhostsRSAAuthentication no
# similar for protocol version 2
#HostbasedAuthentication no
# Change to yes if you don\’t trust ~/.ssh/known_hosts for
# RhostsRSAAuthentication and HostbasedAuthentication
#IgnoreUserKnownHosts no
# Don\’t read the user\’s ~/.rhosts and ~/.shosts files
#IgnoreRhosts yes