Chapter 49: Controller: /nodeworx/reseller/packages Up Part II: NodeWorx API Spec Chapter 51: Controller: /nodeworx/shell 

50 Controller: /nodeworx/settings

Required Permissions "SETTINGS"
Action: edit
Added in version 4.7.0-339
Description Edit misc interworx settings.
Input Parameters
Name Type Notes Required?
iworx.license_key string Description
Changing this to an invalid key will lock you out of NodeWorx. Be very sure of what you are doing.
Example Default Value
INTERWORX_APIDOC2
No*
iworx_debug integer Description
This option will enable more detailed error messages.
Help Entry
####
Example Values
1, 0
Example Default Value
1
No*
iworx_debug_templates integer Description
This option turns on a pop-up window with information available to template designers.
Example Values
1, 0
Example Default Value
0
No*
form_xhr_validate integer Description
When enabled, forms are validated line-by-line as the user inputs data.
Example Values
1, 0
Example Default Value
1
No*
form_check_all integer Description
Sets the threshold for showing "check all" helpers for groups of checkboxes
Example Default Value
7
No*
form_xhr_log_reload integer Description
Sets how many seconds the log-viewer forms will wait until refreshing the log. Default: 5
Example Default Value
5
No*
iworx_default_timezone string Description
The global timezone to be used within InterWorx.
Example Values
Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, ...
Example Default Value
America/New_York
No*
constants_date_format string Description
Compatible with PHP’s strftime() function. Controls the format of displayed dates in the interface. Default is %Y-%m-%d.
Example Default Value
%Y-%m-%d
No*
constants_time_format string Description
Compatible with PHPs strftime() function. Controls the format of displayed times in the interface. Default is %H:%M:%S.
Example Default Value
%H:%M:%S
No*
constants_datetime_format string Description
Compatible with PHP’s strftime() function. Controls the format of displayed dates with times in the interface. Default is %Y-%m-%d %H:%M:%S.
Example Default Value
%Y-%m-%d %H:%M:%S
No*
thousands_sep string Description
The character that will be used as the thousands separator.
Example Values
comma, period, space
Example Default Value
comma
No*
constants_dec_point string Description
The character that will be used as the decimal point.
Example Default Value
.
No*
qmail_use_senderip integer Description
When Sender IP is enabled, mail will be sent from the SiteWorx account’s IP address.
Example Values
1, 0
Example Default Value
1
No*
mail_default_from string Description
Email address used as the sender for notification emails
Example Default Value
selenium@interworx.com
No*
mail_default_from_name string Description
Name used as the sender for notification emails
Example Default Value
NodeWorx Server Manager
No*
horde_enabled integer Description
Display Horde in the webmail selector. NOTE: This does not uninstall the interworx-horde RPM
Example Values
1, 0
Example Default Value
1
No*
roundcube_enabled integer Description
Display Roundcube in the webmail selector. NOTE: This does not uninstall the interworx-roundcube RPM’
Example Values
1, 0
Example Default Value
1
No*
squirrelmail_enabled integer Description
Display SquirrelMail in the webmail selector. NOTE: this does not uninstall the interworx-squirrelmail RPM
Example Values
1, 0
Example Default Value
1
No*
webmail_default string Description
The webmail client that is pre-selected by default at /webmail.
Example Values
horde, roundcube, squirrelmail
Example Default Value
horde
No*
nodeworx_login_autocomplete integer Description
Allow autocomplete on the NodeWorx login form.
Example Values
1, 0
Example Default Value
1
No*
iworx.templates_nodeworx string Description
Theme to use before users are logged into NodeWorx.
Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
heliotrope
No*
iworx.language_nodeworx string Description
Language to use before users are logged into NodeWorx.
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
support.url_user string Description
Link to use for NodeWorx support. NOTE: this may be overridden in custom templates.
Example Default Value
http://www.interworx.com/support/faq/topics/nodeworx-faq/
No*
nodeworx_siteworx_accounts_perpage integer Example Default Value
20
No*
siteworx_login_autocomplete integer Description
Allow autocomplete on the SiteWorx login form.
Example Values
1, 0
Example Default Value
1
No*
iworx.templates_siteworx string Description
Theme to use before users are logged into SiteWorx.
Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
heliotrope
No*
iworx.language_siteworx string Description
Language to use before users are logged into SiteWorx.
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
support.url_siteworx_user string 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, 0
Example 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, 0
Example Default Value
1
No*
iworx_fileman integer Description
Enable or Disable the control panel file manager server-wide.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_siteworx_schedule integer Description
If enabled, SiteWorx accounts will be permitted to schedule SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_daily integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule daily SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_weekly integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule weekly SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_monthly integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule monthly SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_use_user_quota integer Description
If enabled, SiteWorx backup storage will apply against the SiteWorx account storage quota.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_rotate_max integer 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
No*
conf.editing_http integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
conf.editing_ftp integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
conf.editing_ssh integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
stats.awstats_enabled integer Description
This globally disables AWStats log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.analog_enabled integer Description
This globally disables Analog log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.webalizer_enabled integer Description
This globally disables Webalizer log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.realtime_mem_chart string Description
Controls the style of the memory graph in the NodeWorx overview page.
Example Values
simple, advanced
Example Default Value
simple
No*
rrd_ping_host string Description
Website used for measuring ping latency.
Example Default Value
yahoo.com
No*
stats.realtime_default_network_interface string 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, lo
Example 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
No*
apache_sni_enabled integer Description
SNI, or Server Name Indication, allows multiple SSL certificates to be installed on one IP address. For more information, see: http://en.wikipedia.org/wiki/Server_Name_Indication
Example Values
1, 0
Example Default Value
1
No*
iworx.passwords_threshold integer Description
Prevent users from setting passwords below this strength threshold. Common passwords will still be blocked from use.
Example Values
0, 1, 2, 3, 4
Example Default Value
0
No*
iworx.passwords_length integer Description
The minimum allowable length for user passwords.
Example Default Value
6
No
quota_partition string Description
Partition where user home folders reside. Used for calculating storage quotas, etc.
Example Values
/, /dev/shm, /boot
Example Default Value
/
No*
quota_quota-overflow-pct integer Description
The percentage by which a SiteWorx account may temporarily exceed the assigned storage quota.
Example Default Value
25
No*
quota_grace_time integer Description
The amount of time a SiteWorx account may temporarily exceed the assigned storage quota. 604800 = 7 days, 259200 = 3 days, 86400 = 1 day, etc.
Example Default Value
604800
No*
dir_tmp string Description
Directory to use for temporary files.
Example Default Value
/tmp
No*
domain-blacklist struct (string) Description
A list of domains that cannot be created in SiteWorx for security purposes.
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’iworx_version’ => ’6.0.13’,
’iworx_rpm.release’ => ’6.0.13-1384’,
’iworx.license_key’ => ’INTERWORX_APIDOC2’,
’iworx_debug’ => ’1’,
’iworx_debug_templates’ => ’0’,
’form_xhr_validate’ => ’1’,
’form_check_all’ => ’7’,
’form_xhr_log_reload’ => ’5’,
’iworx_default_timezone’ => ’America/New_York’,
’constants_date_format’ => ’%Y-%m-%d’,
’constants_time_format’ => ’%H:%M:%S’,
’constants_datetime_format’ => ’%Y-%m-%d %H:%M:%S’,
’thousands_sep’ => ’comma’,
’constants_dec_point’ => ’.’,
’qmail_use_senderip’ => ’1’,
’mail_default_from’ => ’selenium@interworx.com’,
’mail_default_from_name’ => ’NodeWorx Server Manager’,
’horde_enabled’ => ’1’,
’roundcube_enabled’ => ’1’,
’squirrelmail_enabled’ => ’1’,
’webmail_default’ => ’horde’,
’nodeworx_login_autocomplete’ => ’1’,
’iworx.templates_nodeworx’ => ’heliotrope’,
’iworx.language_nodeworx’ => ’en-us’,
’support.url_user’ => ’http://www.interworx.com/support/faq/topics/nodeworx-faq/’,
’nodeworx_siteworx_accounts_perpage’ => ’20’,
’siteworx_login_autocomplete’ => ’1’,
’iworx.templates_siteworx’ => ’heliotrope’,
’iworx.language_siteworx’ => ’en-us’,
’support.url_siteworx_user’ => ’http://www.interworx.com/support/faq/topics/siteworx-faq/’,
’siteworx_show_box_size’ => ’1’,
’siteworx.logs_savexferlogs’ => ’7’,
’siteworx.logs_saveerrlogs’ => ’7’,
’siteworx_allow_crossaccount_subdomains’ => ’1’,
’iworx_fileman’ => ’1’,
’iworx.backup_siteworx_schedule’ => ’1’,
’iworx.backup_enable_daily’ => ’1’,
’iworx.backup_enable_weekly’ => ’1’,
’iworx.backup_enable_monthly’ => ’1’,
’iworx.backup_use_user_quota’ => ’1’,
’iworx.backup_rotate_max’ => ’25’,
’conf.editing_http’ => ’1’,
’conf.editing_ftp’ => ’1’,
’conf.editing_ssh’ => ’1’,
’stats.awstats_enabled’ => ’1’,
’stats.analog_enabled’ => ’1’,
’stats.webalizer_enabled’ => ’1’,
’stats.realtime_mem_chart’ => ’simple’,
’rrd_ping_host’ => ’yahoo.com’,
’stats.realtime_default_network_interface’ => ’eth0’,
’apache.file_vhost-base’ => ’/home/interworx/etc/vhost-base.conf’,
’apache_sni_enabled’ => ’1’,
’iworx.passwords_threshold’ => ’0’,
’iworx.passwords_length’ => ’6’,
’quota_partition’ => ’/’,
’quota_quota-overflow-pct’ => ’25’,
’quota_grace_time’ => ’604800’,
’dir_tmp’ => ’/tmp’,
’domain-blacklist’ =>
array (
0 => ’gmail.com’,
1 => ’yahoo.com’,
2 => ’hotmail.com’,
3 => ’gmx.de’,
4 => ’googlemail.com’,
5 => ’mail.ru’,
6 => ’web.de’,
7 => ’live.com’,
8 => ’aol.com’,
9 => ’gmx.net’,
10 => ’yandex.ru2’,
11 => ’me.com’,
12 => ’msn.com’,
13 => ’comcast.net’,
14 => ’hushmail.com’,
15 => ’yahoo.de’,
16 => ’hotmail.co.uk’,
17 => ’lavabit.com’,
18 => ’sbcglobal.net’,
19 => ’safe-mail.net’,
20 => ’ymail.com’,
21 => ’yahoo.co.uk’,
22 => ’mac.com’,
23 => ’qq.com’,
24 => ’gmx.com’,
25 => ’hotmail.de’,
26 => ’ya.ru’,
27 => ’rambler.ru’,
28 => ’o2.pl’,
29 => ’abv.bg’,
30 => ’freenet.de’,
31 => ’mailinator.com’,
32 => ’gmx.at’,
33 => ’cox.net’,
34 => ’rocketmail.com’,
35 => ’bk.ru’,
36 => ’ukr.net’,
37 => ’163.com’,
38 => ’arcor.de’,
39 => ’mail.com’,
40 => ’list.ru’,
41 => ’att.net’,
42 => ’aim.com’,
43 => ’live.co.uk’,
44 => ’inbox.ru’,
45 => ’verizon.net’,
46 => ’126.com’,
47 => ’hush.com’,
48 => ’t-online.de’,
49 => ’free.fr’,
50 => ’shaw.ca’,
51 => ’wp.pl’,
52 => ’hotmail.fr’,
53 => ’yahoo.com.au’,
54 => ’live.de’,
55 => ’yahoo.ca’,
56 => ’btinternet.com’,
57 => ’iki.fi’,
58 => ’hotmail.it’,
59 => ’yahoo.it’,
60 => ’mail.bg’,
61 => ’live.com.au’,
62 => ’fastmail.fm’,
63 => ’yahoo.fr’,
64 => ’seznam.cz’,
65 => ’gmx.ch’,
66 => ’bellsouth.net’,
67 => ’online.de’,
68 => ’live.se’,
69 => ’zoho.com’,
70 => ’tiscali.it’,
71 => ’pobox.com’,
72 => ’nym.hush.com’,
73 => ’i2pmail.org’,
74 => ’earthlink.net’,
75 => ’tut.by’,
76 => ’libero.it’,
77 => ’juno.com’,
78 => ’hush.ai’,
79 => ’snkmail.com’,
80 => ’charter.net’,
81 => ’sina.com’,
82 => ’riseup.net’,
83 => ’centrum.cz’,
84 => ’yahoo.es’,
85 => ’yahoo.com.vn’,
86 => ’yahoo.com.cn’,
87 => ’mit.edu’,
88 => ’live.dk’,
89 => ’live.ca’,
90 => ’inbox.lv’,
91 => ’i.ua’,
92 => ’telus.net’,
93 => ’telia.com’,
94 => ’telenet.be’,
95 => ’optonline.net’,
96 => ’klzlk.com’,
97 => ’yahoo.se’,
98 => ’yahoo.com.ar’,
99 => ’sharedaddy.com’,
100 => ’rochester.rr.com’,
101 => ’prime.gushi.org’,
102 => ’yahoo.com.br’,
103 => ’tlen.pl’,
104 => ’sporktronics.com’,
105 => ’spamgourmet.com’,
106 => ’live.nl’,
107 => ’live.fr’,
108 => ’inbox.com’,
109 => ’hmamail.com’,
110 => ’email.com’,
111 => ’bluewin.ch’,
112 => ’google.com’,
113 => ’excite.com’,
114 => ’address.com’,
115 => ’altavista.net’,
116 => ’netscape.net’,
117 => ’netscape.com’,
118 => ’attracta.com’,
),
),
)
 Chapter 49: Controller: /nodeworx/reseller/packages Up Part II: NodeWorx API Spec Chapter 51: Controller: /nodeworx/shell 

(C) 2017 by InterWorx LLC