Controller: Settings

API Controller /nodeworx/settings
Required Permissions ["SETTINGS"]
Action Description
edit Edit misc interworx settings.

Action: edit

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_COS5_INST
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 popup 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 the time in seconds the log-viewer forms will wait until refreshing the log. Default: 5
Example Default Value
5
No*
constants_date_format string
Description
Compatible with PHPs 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 PHPs 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*
constants_thousands_sep string
Description
The character that will be used as the thousands separator.
Example Default Value
,
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
0
No*
mail_default_from string
Description
Email address used as the sender for notification emails
Example Default Value
apidocs@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
Yes
iworx.templates_nodeworx string
Description
Theme to use before users are logged in to NodeWorx.
Example Values
blue_steel, calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
Example Default Value
interworx
No*
iworx.language_nodeworx string
Description
Language to use before users are logged in to NodeWorx.
Example Values
cs, en-us, fr, de, hu, it, pl, pt, sk, es, sv, tr
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://interworx.com/support/docs/iworx-cp/sysadmin/unified
No*
nodeworx_siteworx_accounts_perpage integer
Example Default Value
20
No*
iworx.templates_siteworx string
Description
Theme to use before users are logged in to SiteWorx.
Example Values
blue_steel, calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
Example Default Value
interworx
No*
iworx.language_siteworx string
Description
Language to use before users are logged in to SiteWorx.
Example Values
cs, en-us, fr, de, hu, it, pl, pt, sk, es, sv, tr
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://interworx.com/support/docs/iworx-cp/webadmin/unified
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*
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_rotate_max integer
Description
This number is 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, sit0
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*
rubyonrails_enabled integer
Description
With this option you can enable or disable Ruby on Rails support. This option being active is dependent on ruby, rails, gem, and rake being installed to the system. Full activation of Rails will require that Passenger is installed and configured on the server.
Example Values
1, 0
Example Default Value
1
No*
rubyonrails_allow_user_gems integer
Description
Allow SiteWorx users to install and update their own gems. Note: turning this option off will only hide the GUI, if the SiteWorx user has shell access they can still use the gem command if they have permissions to use it
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
/, /boot, /dev/shm
Example Default Value
/
No*
dir_tmp string
Description
Directory to use for temporary files.
Example Default Value
/tmp
No*
* indicates that it's actually required, but probably already has a valid default value