Controller: /nodeworx/settings

Required Permissions

SETTINGS

Action: edit

Added in Version

4.7.0-339

Description

Edit misc interworx settings.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

iworx.license_key

string

No*

INTERWORX_APIDOC2

Changing this to an invalid key will lock you out of NodeWorx. Be very sure of what you are doing.

iworx_debug

integer

No*

1, 0

0

This option will enable more detailed error messages.

iworx_debug_templates

integer

No*

1, 0

0

This option turns on a pop-up window with information available to template designers.

form_xhr_validate

integer

No*

1, 0

1

When enabled, forms are validated line-by-line as the user inputs data.

form_check_all

integer

No*

7

Sets the threshold for showing “check all” helpers for groups of checkboxes

form_xhr_log_reload

integer

No*

5

Sets how many seconds the log-viewer forms will wait until refreshing the log. Default: 5

iworx_default_timezone

string

No*

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, …

America/New_York

The global timezone to be used within InterWorx.

constants_date_format

string

No*

%Y-%m-%d

Compatible with PHP’s strftime() function. Controls the format of displayed dates in the interface. Default is %Y-%m-%d.

constants_time_format

string

No*

%H:%M:%S

Compatible with PHPs strftime() function. Controls the format of displayed times in the interface. Default is %H:%M:%S.

constants_datetime_format

string

No*

%Y-%m-%d %H:%M:%S

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.

thousands_sep

string

No*

comma, period, space

comma

The character that will be used as the thousands separator.

constants_dec_point

string

No*

.

The character that will be used as the decimal point.

qmail_use_senderip

integer

No*

1, 0

1

When Sender IP is enabled, mail will be sent from the SiteWorx account’s IP address.

mail_default_from

string

No*

apidocs@interworx.com

Email address used as the sender for notification emails

mail_default_from_name

string

No*

NodeWorx Server Manager

Name used as the sender for notification emails

mailman_enabled

integer

No*

1, 0

1

Display mailing lists in SiteWorx/NodeWorx. NOTE: This does not uninstall the mailman RPM

horde_enabled

integer

No*

1, 0

1

Display Horde in the webmail selector. NOTE: This does not uninstall the interworx-horde RPM

roundcube_enabled

integer

No*

1, 0

1

Display Roundcube in the webmail selector. NOTE: This does not uninstall the interworx-roundcube RPM’

webmail_default

string

No*

horde, roundcube

roundcube

The webmail client that is pre-selected by default at /webmail.

nodeworx_login_autocomplete

integer

No*

1, 0

1

Allow autocomplete on the NodeWorx login form.

iworx.language_nodeworx

string

No*

cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh

en-us

Language to use before users are logged into NodeWorx.

support.url_user

string

No*

https://appendix.interworx.com/current/nodeworx/

Link to use for NodeWorx support. NOTE: this may be overridden in custom templates.

nodeworx_siteworx_accounts_perpage

integer

No*

20

siteworx_login_autocomplete

integer

No*

1, 0

1

Allow autocomplete on the SiteWorx login form.

iworx.language_siteworx

string

No*

cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh

en-us

Language to use before users are logged into SiteWorx.

support.url_siteworx_user

string

No*

https://appendix.interworx.com/current/siteworx/

Link to use for SiteWorx support. NOTE: this may be overridden in custom templates.

siteworx_show_box_size

integer

No*

1, 0

1

Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes. - Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes.

siteworx.logs_savexferlogs

integer

No*

7

Defines how many days to keep daily transfer logs on SiteWorx accounts before purging them.

siteworx.logs_saveerrlogs

integer

No*

7

Defines how many days to keep daily error logs on SiteWorx accounts before purging them.

siteworx_allow_crossaccount_subdomains

integer

No*

1, 0

1

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.

iworx_fileman

integer

No*

1, 0

1

Enable or Disable the control panel file manager server-wide.

iworx.backup_siteworx_schedule

integer

No*

1, 0

1

If enabled, SiteWorx accounts will be permitted to schedule SiteWorx backups.

iworx.backup_enable_daily

integer

No*

1, 0

1

If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule daily SiteWorx backups.

iworx.backup_enable_weekly

integer

No*

1, 0

1

If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule weekly SiteWorx backups.

iworx.backup_enable_monthly

integer

No*

1, 0

1

If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule monthly SiteWorx backups.

iworx.backup_use_user_quota

integer

No*

1, 0

1

If enabled, SiteWorx backup storage will apply against the SiteWorx account storage quota.

iworx.backup_rotate_max

integer

No*

25

Indicates the maximum number of backups to keep before removing old backups. - 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.

conf.editing_http

integer

No*

1, 0

1

Controls whether the config file can be edited through the web interface

conf.editing_ftp

integer

No*

1, 0

1

Controls whether the config file can be edited through the web interface

conf.editing_ssh

integer

No*

1, 0

1

Controls whether the config file can be edited through the web interface

stats.awstats_enabled

integer

No*

1, 0

1

This globally disables AWStats log analysis.

stats.analog_enabled

integer

No*

1, 0

1

This globally disables Analog log analysis.

stats.webalizer_enabled

integer

No*

1, 0

1

This globally disables Webalizer log analysis.

stats.realtime_mem_chart

string

No*

simple, advanced

simple

Controls the style of the memory graph in the NodeWorx overview page.

rrd_ping_host

string

No*

yahoo.com

Website used for measuring ping latency.

stats.realtime_default_network_interface

string

No*

eth0, lo

eth0

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.

apache.file_vhost-base

string

No*

/home/interworx/etc/vhost-base.conf

File to use as the template for creating virtual hosts when creating SiteWorx accounts and secondary domains.

apache_sni_enabled

integer

No*

1, 0

1

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

autossl-domain-blacklist

struct (string)

No*

[“example.com”]

A list of domains InterWorx will not attempt to automatically install Let’s Encrypt SSL certificates for.

iworx.passwords_threshold

integer

No*

0, 1, 2, 3, 4

0

Prevent users from setting passwords below this strength threshold. Common passwords will still be blocked from use.

iworx.passwords_length

integer

No

6

The minimum allowable length for user passwords.

quota_partition

string

No*

/dev, /dev/shm, /run, /sys/fs/cgroup, /, /run/user/0

/

Partition where user home folders reside. Used for calculating storage quotas, etc.

quota_quota-overflow-pct

integer

No*

25

The percentage by which a SiteWorx account may temporarily exceed the assigned storage quota.

dir_tmp

string

No*

/tmp

Directory to use for temporary files.

lostpass_domain

string

No*

temp.iwx.io

This setting overrides the domain set in the lost reset password email. This is typically the hostname of the server. - Override the domain used in the lost password reset email.

domain-blacklist

struct (string)

No*

[“gmail.comnnyahoo.comnnhotmail.comnngmx.denngooglemail.comnnmail.runnweb.dennlive.comnnaol.comnngmx.netnnyandex.runnme.comnnmsn.comnncomcast.netnnhushmail.comnnyahoo.dennhotmail.co.uknnlavabit.comnnsbcglobal.netnnsafe-mail.netnnymail.comnnyahoo.co.uknnmac.comnnqq.comnngmx.comnnhotmail.dennya.runnrambler.runno2.plnnabv.bgnnfreenet.dennmailinator.comnngmx.atnncox.netnnrocketmail.comnnbk.runnukr.netnn163.comnnarcor.dennmail.comnnlist.runnatt.netnnaim.comnnlive.co.uknninbox.runnverizon.netnn126.comnnhush.comnnt-online.dennfree.frnnshaw.cannwp.plnnhotmail.frnnyahoo.com.aunnlive.dennyahoo.cannbtinternet.comnniki.finnhotmail.itnnyahoo.itnnmail.bgnnlive.com.aunnfastmail.fmnnyahoo.frnnseznam.cznngmx.chnnbellsouth.netnnonline.dennlive.sennzoho.comnntiscali.itnnpobox.comnnnym.hush.comnni2pmail.orgnnearthlink.netnntut.bynnlibero.itnnjuno.comnnhush.ainnsnkmail.comnncharter.netnnsina.comnnriseup.netnncentrum.cznnyahoo.esnnyahoo.com.vnnnyahoo.com.cnnnmit.edunnlive.dknnlive.canninbox.lvnni.uanntelus.netnntelia.comnntelenet.bennoptonline.netnnklzlk.comnnyahoo.sennyahoo.com.arnnsharedaddy.comnnrochester.rr.comnnprime.gushi.orgnnyahoo.com.brnntlen.plnnsporktronics.comnnspamgourmet.comnnlive.nlnnlive.frnninbox.comnnhmamail.comnnemail.comnnbluewin.chnngoogle.comnnexcite.comnnaddress.comnnaltavista.netnnnetscape.netnnnetscape.comnnattracta.com”]

A list of domains that cannot be created in SiteWorx for security purposes.

ui_dark_mode

integer

No*

0, 1

0

Controls the default User Interface mode for users who have not made explicit selections.

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

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' => '7.13.34',
    'iworx_rpm.release' => '7.13.34-2685',
    'iworx.license_key' => 'INTERWORX_APIDOC2',
    'iworx_debug' => '0',
    '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' => '[email protected]',
    'mail_default_from_name' => 'NodeWorx Server Manager',
    'mailman_enabled' => '1',
    'horde_enabled' => '1',
    'roundcube_enabled' => '1',
    'webmail_default' => 'roundcube',
    'nodeworx_login_autocomplete' => '1',
    'iworx.templates_nodeworx' => 'interworx',
    'iworx.language_nodeworx' => 'en-us',
    'support.url_user' => 'https://appendix.interworx.com/current/nodeworx/',
    'nodeworx_siteworx_accounts_perpage' => '20',
    'siteworx_login_autocomplete' => '1',
    'iworx.templates_siteworx' => 'interworx',
    'iworx.language_siteworx' => 'en-us',
    'support.url_siteworx_user' => 'https://appendix.interworx.com/current/siteworx/',
    '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',
    'autossl-domain-blacklist' =>
    array (
      0 => 'example.com',
    ),
    'iworx.passwords_threshold' => '0',
    'iworx.passwords_length' => '6',
    'quota_partition' => '/',
    'quota_quota-overflow-pct' => '25',
    'dir_tmp' => '/tmp',
    'lostpass_domain' => 'temp.iwx.io',
    '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.ru',
      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',
    ),
    'ui_dark_mode' => '0',
  ),
  'reply_code' => 205,
)

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, …

Action: setGlobalConfig

Added in Version

n/a

Description

Set a config value globally.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

config_name

struct (string)

No*

config_value

struct (string)

No

* indicates that it’s actually required, but probably already has a valid default value.

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.