|
administrators
|
[]
|
ARRAY of STRINGS
|
You may set administrators to a list of usernames
matching those used by Basic Auth (i.e. via htpasswd). Any users not
listed are considered to be read-only Operators. Requires that the
enableRBAC setting be enabled (set to
1) and that Basic Auth in the web server has been
properly configured. Added in v1.0.8
|
[ "user1", "user2", "user3" ],
|
N
|
|
apiAuth
|
0
|
BOOLEAN
|
Enabling API Authentication adds the Basic Auth user and password to
every API call. You must define and activate the API auth in the
Tungsten INI. Added in v1.0.10
|
1
|
Y
|
|
apiVersion
|
1
|
INTEGER
|
Define the API Version to use (1 or 2). Added in v1.0.10
|
2
|
Y
|
|
apiSSL
|
0
|
BOOLEAN
|
Enabling API SSL uses the https protocol instead of http to make API
calls. Added in v1.0.10
|
1
|
Y
|
|
apiPassword
|
None
|
STRING
|
The API Password is required when API Authentication is enabled.
Added in v1.0.10
|
{api password}
|
Y
|
|
apiUser
|
None
|
STRING
|
The API User is required when API Authentication is enabled. Added
in v1.0.10
|
{api user name}
|
Y
|
|
auditDir
|
{WEBROOT}/audit.d
|
STRING
|
Use auditDir to change the location of the
temporary audit files. Added in v1.0.10
|
{WEBROOT}/audit.d
|
N
|
|
autoLockAll
|
1
|
BOOLEAN
|
Automatically lock the Dashboard during ANY non-read-only action to
prevent other users from performing any non-read-only actions on
this cluster.
|
1
|
Y
|
|
autoLockHeartbeat
|
0
|
BOOLEAN
|
Automatically lock the Dashboard during heartbeat actions to prevent
other users from performing any non-read-only actions on this
cluster. Overridden by autoLockAll
|
0 if $autoLockAll=1, otherwise
1
|
Y
|
|
autoRefreshDelay
|
0
|
INTEGER Seconds
|
Controls the Auto-Refresh feature. By default the Auto-refresh
feature is disabled (i.e. set to zero seconds). To have the
Auto-Refresh feature enabled upon initial page load, set
autoRefreshDelay to one of the Auto-Refresh time
interval values (see autoRefreshList).
|
0
|
Y
|
|
autoRefreshList
|
[5, 10, 30, 60, 120, 300]
|
Seconds as an array of INTEGERs
|
The list of time intervals in seconds shown on the Auto-Refresh
dropdown menu. autoRefreshList values less than 3
seconds are strongly discouraged.
|
[5, 7, 10, 15, 20, 30, 60, 120, 300, 600]
|
N
|
|
autoUnlockAll
|
0
|
BOOLEAN
|
Under normal circumstances, you should not need to get a lock, since
all operations automatically attempt to obtain a lock for efficiency
purposes. This has the side-effect of leaving your session in a
locked state. You may set autoUnlockAll to 1 to
automatically unlock the Dashboard after issuing any command.
|
1
|
Y
|
|
autoUnlockHeartbeat
|
0
|
BOOLEAN
|
Under normal circumstances, you should not need to get a lock, since
all operations automatically attempt to obtain a lock for efficiency
purposes. This has the side-effect of leaving your session in a
locked state. You may set autoUnlockHeartbeat to
1 to automatically unlock the Dashboard after issuing a heartbeat
command.
|
1
|
Y
|
|
connectorPort
|
8096
|
INTEGER
|
The connectorPort value is used to determine what
port to communicate with the Connector upon when performing
auto-configuration and auto-define, as well as populating form
fields in other places. Only change this if you have changed the API
listener port for the Connector as well. Added in v1.0.10
|
8096
|
N
|
|
curlTimeoutGET
|
10
|
INTEGER Seconds
|
The timeout used when curl connects to the manager for a
GET-specific API call, in seconds. Added in v1.0.10
|
10
|
Y
|
|
curlTimeoutPOST
|
60
|
INTEGER Seconds
|
The timeout used when curl connects to the manager for a
POST-specific API call, in seconds. Added in v1.0.10
|
60
|
Y
|
|
customerEmail
|
None
|
STRING
|
Use the customerEmail to pre-populate the Tungsten
Dashboard diagnostic upload form customer email field. Added in
v1.0.9
|
{Your customer email address}
|
Y
|
|
dashboardMaintenanceScreen
|
0
|
BOOLEAN
|
You may set dashboardMaintenanceScreen to 1 to
display a "Maintenance-In-Progress" message.
|
0
|
N
|
|
disableConfigDisplay
|
0
|
BOOLEAN
|
Set disableConfigDisplay to 1 to prevent the menu
choice for Tools -> Display Configuration from appearing. Added
in v1.0.8
|
0, 1if you do not wish
read-only access to the configuration via the browser.
|
Y
|
|
disableSettingsEdit
|
0
|
BOOLEAN
|
You can disable the editing of settings in the browser by changing
the value of disableSettingsEdit to
1 in the config.php file, in
the "settings": { } stanza. Added in v1.0.9
|
0, 1 if you do not wish to
allow settings to be changed via the browser interface.
|
N
|
|
disableTooltips
|
0
|
BOOLEAN
|
Set disableConfigDisplay to 1 to prevent the
formatted hover-over help tooltips from appearing. Added in v1.0.8
|
0, 1 if you do not wish
read-only access to the configuration via the browser.
|
Y
|
|
downloadAccessKey
|
{Obtain from Support}
|
STRING
|
Use downloadAccessKey to enable the Tungsten
Dashboard self-update feature. Requires
downloadSecretKey.
|
{Assigned Download Key}
|
N
|
|
downloadSecretKey
|
{Obtain from Support}
|
STRING
|
Use downloadSecretKey to enable the Tungsten
Dashboard self-update feature. Requires
downloadAccessKey.
|
{Assigned Download Secret}
|
N
|
|
enableAudit
|
0
|
BOOLEAN
|
Enables the admin command audit trail feature. Added in v1.0.10
|
1
|
Y
|
|
enableAutoConfiguration
|
0
|
BOOLEAN
|
Use enableAutoConfiguration to enable the Tungsten
Dashboard auto-configuration feature. Attempts to connect to the
Manager on localhost to determine the cluster to display. Related
options are managerPort and
useHAProxy. Added in v1.0.9
|
1
|
Y
|
|
enableDebug
|
0
|
BOOLEAN
|
Set enableDebug to 1 to get
additional logging information and use the debug software versions
when checking for an available update. Added in v1.0.9
|
0
|
Y
|
|
enableExpertMode
|
0
|
BOOLEAN
|
enableExpertMode disables both confirmation prompts
when Deleting All Definitions. Added in v1.0.9
|
0
|
Y
|
|
enableGrafana
|
0
|
BOOLEAN
|
You may set enableGrafana to 1 to display a
"Grafana" button in the top menu, which when clicked will open an
iframe to "http://{Dashboard_Server_Hostname}:3000". Added in
v1.0.10
|
0, 1 if you have Grafana available
|
Y
|
|
enablePrometheus
|
0
|
BOOLEAN
|
You may set enablePrometheus to 1 to display a
"Prometheus" button in the top menu, which when clicked will open an
iframe to "http://{Dashboard_Server_Hostname}:9090". Added in
v1.0.10
|
0, 1 if you have Prometheus available
|
Y
|
|
enableRBAC
|
0
|
BOOLEAN
|
You may set enableRBAC to 1 to enable the use of
Role-Based Access Control. Requires that the
administrators setting be populated and that
Basic Auth in the web server has been enabled or no actions will be
allowed. Added in v1.0.8
|
1
|
N
|
|
enableNotes
|
0
|
BOOLEAN
|
You may set enableNotes to 1 to allow text notes
to be saved on a per-node basis Added in v1.0.10
|
1
|
Y
|
|
enableUpdates
|
1
|
BOOLEAN
|
You may set enableUpdates to 0
in the config.php file, in the
"settings": { } stanza to disable the Dashboard
self-update feature. When enableUpdates is set to
1 (enabled, default), two other values are
needed, downloadAccessKey and
downloadSecretKey. Added in v1.0.9
|
1
|
N
|
|
enableURLDisplay
|
0
|
BOOLEAN
|
You may set enableURLDisplay to 1 to enable the
display of the back-end API calls for transparency and learning.
Added in v1.0.10
|
1
|
Y
|
|
jumpToTopOnMsg
|
1
|
BOOLEAN
|
The Dashboard places all messages at the top of the center scroll
window (for now). If you have scrolled down to view information
below the fold, and execute a command, it is possible the message
will be obscured. When jumpToTopOnMsg is set to
the default of 1, the center portal will auto-scroll to the top so
the message is visible. Set jumpToTopOnMsg to 0
to disable this behavior and leave the window where it is after a
command is selected.
|
0 if you prefer to scroll on your own, when you
are ready to do so
|
Y
|
|
flagOnLagColor
|
warning
|
STRING
|
Use flagOnLagColor to define the row background
color when flagOnLagDelay is active. One of: danger, warning or info
Requires flagOnLagDelay > 0. Added in v1.0.10
|
info
|
Y
|
|
flagOnLagDelay
|
0
|
INTEGER Seconds
|
The value used when comparing the replica's seqno to the primary's
seqno. If the difference is larger than this value, then set the row
background to the danger color. Set to zero (0) to disable. Added in
v1.0.10
|
60
|
Y
|
|
lockBaseDir
|
{WEBROOT}
|
STRING
|
Use lockBaseDir to change the location of the
temporary lock files. The default lockBaseDir is
{WEBROOT}, making the default lock directory
{WEBROOT}/locks/, (i.e. a
lockBaseDir of /tmp will
yield a lock directory of /tmp/locks).
|
{WEBROOT}
|
N
|
|
managerPort
|
8090
|
INTEGER
|
The managerPort value is used to determine what
port to communicate with the Manager upon when performing
auto-configuration and auto-define, as well as populating form
fields in other places. Only change this if you have changed the API
listener port for the Manager as well. Added in v1.0.9
|
8090
|
N
|
|
msgFadeOutTimer
|
60
|
INTEGER Seconds
|
Use msgFadeOutTimer to automatically close
messages after the defined timeout in seconds. Added in v1.0.7
|
60
|
Y
|
|
navButtonFormat
|
icon
|
STRING
|
Use navButtonFormat to control the Cluster View
control buttons style on the third navigation bar. You may specify
one of: "icon", "text",
"text,icon" or "icon,text"
|
icon,text until the icons become familiar, then
the default value of icon
|
Y
|
|
noteGlyphicon
|
comment
|
STRING
|
Use noteGlyphicon to specify the note-per-node
Glyphicon. Added in v1.0.10
|
comment
|
N
|
|
notesDir
|
{WEBROOT}/notes.d
|
STRING
|
Use notesDir to change the location of the
temporary notes files. Added in v1.0.10
|
{WEBROOT}/notes.d
|
N
|
|
replicatorPort
|
8097
|
INTEGER
|
The replicatorPort value is used to determine what
port to communicate with the Replicator upon when performing
auto-configuration and auto-define, as well as populating form
fields in other places. Only change this if you have changed the API
listener port for the Replicator as well. Added in v1.0.10
|
8097
|
N
|
|
sortByConfigOrderNotAlpha
|
0
|
BOOLEAN
|
The sortByConfigOrderNotAlpha controls the
Cluster View sort. By default the list of cluster services is sorted
alphabetically. Set sortByConfigOrderNotAlpha to
1 for the cluster services to be displayed in the order listed in
the config.php file. Added in v1.0.8
|
1 if you prefer the clusters to display in the
order listed in the config.php file.
|
N
|
|
startExpanded
|
0
|
BOOLEAN
|
Use startExpanded to control the initial display
of the cluster nodes. The default of 0 hides the cluster nodes. Set
this option to 1 for all nodes to be visible upon initial load.
|
1
|
Y
|
|
tabUpdateRate
|
30
|
INTEGER Seconds
|
The default Tab Badge update rate is 30 seconds. The Tab Bar and
associated badges are located in navigation bar two. You may disable
it by setting tabUpdateRate to zero (0). You may
change the refresh rate in seconds by specifying a non-zero value.
|
30
|
Y
|
|
tmpDir
|
/tmp
|
STRING
|
Use tmpDir to specify where downloaded software
packages are saved to by the Tungsten Dashboard self-update feature.
Added in v1.0.9
|
/tmp
|
N
|
|
uploadAccessKey
|
{Shipped Upload Key}
|
STRING
|
Use uploadAccessKey to enable the Tungsten
Dashboard self-diagnostic feature. Requires
uploadSecretKey. Added in v1.0.9
|
Same as default
|
N
|
|
uploadSecretKey
|
{Shipped Upload Secret}
|
STRING
|
Use uploadSecretKey to enable the Tungsten
Dashboard self-diagnostic feature. Requires
uploadAccessKey. Added in v1.0.9
|
Same as default
|
N
|
|
useHAProxy
|
0
|
BOOLEAN
|
The useHAProxy value is used to determine how to
calculate ports when performing auto-configuration and auto-define.
Set the value to 1 to both set the base
managerPort to 8201 (as of v1.0.11-2, previous value was 8091), and
determine the manager port number automatically during various
operations based on calulations using the base managerPort. Set the
value to 0 (default) to use the base managerPort
of 8090 with no attempt to auto-define the port. You can enable this
option by changing the "Using HA Proxy?" setting via the Dashboard
settings page in the browser, or changing the value in the
config.php file, in the "settings": {
} stanza. Added in v1.0.9
|
1
|
Y
|
|
windowTitle
|
Tungsten Dashboard
|
STRING
|
Use windowTitle to change the browser window
title from the default of "Tungsten Dashboard". Added in v1.0.8
|
Tungsten Dashboard | {Your Env Here}
|
Y
|
|
yamlDir
|
{WEBROOT}/yaml.d
|
STRING
|
Use yamlDir to change the location of the
temporary yaml files. Added in v1.0.10
|
{WEBROOT}/yaml.d
|
N
|