Outdated Resource Warning!
This is documentation for legacy version 0.x
releases. If you are using 1.x see the wiki
Using the administration page users with the appropriate privilege are able to control and configure the FreeNATS system and environment as well as check for updates.
Users can be created, modified and destroyed. An administrator user can access all functionality, power users can create and edit notes/tests but cannot view the administrator interface and normal users can only read/view node and test information.
Through this interface you can view the raw test run output (clicking run/XXX on the left) or the relevant system log entries for the test run (system logs on the right).
Alert actions (described in the alerts and alert actions section of the documentation) can be created and modified here.
The system logs contain relevant system information to the appropriate log level (configured as a variable - see below). Through the log interface the system log can be filtered for event level (0 is fatal, 10 is debug info only), module or event type.
Variables control the system. To delete a variable simply save it with a blank variable name.
Admin SQL Console
the system event logger level (10 is log everything, 1 almost nothing), around 5 is a good idea (default 5)
- retain.alert, retain.record, retain.testrun, retain.syslog
number of days to retain old alerts (default 356), test records (default 356), test run (default 30) and system log (default 30) data respectively
- site.admin, site.email
site admin and contact details to be displayed in error pages (not yet implemented)
Date-time formatting string for use in displays where: H hours, i minutes, s seconds, d day of month, m number of month, Y full year, y small year. For example "H:i:s d/m/Y" is the site default, "H:i:s m/d/Y" would be the American format.
- site.text.passed, site.text.failed, site.text.warning, site.text.untested
If set override the normal status texts on system pages (including views), designed for multi-lingual support
- site.enable, site.enable.interactive, site.enable.tester, site.enable.web
Anything enabled, web interface enabled for non-admin users, tested enabled and able to run and web interface enabled for everyone respectively. REQUIRED
name to display for the site of the FreeNATS install (not yet implemented)
If set to 1 will enable the administration SQL console (see below) (default 0)
- site.graph.public, site.graph.key
If site.graph.public is set to 1 then test graphs will be available to unauthenticated browsers (for views etc). Unauthenticated browsers must provide a key (if site.graph.key) is set in the URI variable graphkey.
For some edit dialogues show update/created/deleted messages in a popup as well as at the top of the page if 1 (default off)
- api.public, api.key
If api.public is set to 1 then the API will be available to unauthenticated browsers. Unauthenticated browsers must provide a key (if api.key) is set in the URI variable apikey.
time in seconds to wait for an ICMP (ping) response before declaring the test timed out (can be overridden by test-specific setting) (default 10)
Number of times to attempt the NODE ping test (will always try once and only retry if it fails) - to accomodate occasional random ICMP loss (default 2)
If set (1) will return MilliSeconds (1000ths of a second) for ping and ICMP tests (and will show this as the unit in appropriate displays) (default 0)
Default site wide http timeout setting (can be overridden on a per-test basis). Uses PHP site default if unset. Relies on being able to ini_set the PHP stream timeout. (default PHP site setting)
Default site wide SMTP timeout setting for use in SMTP tests (can be overridden on a per-test basis). Defaults to 20 seconds if unset or 0.
Default site wide IMAP timeout setting (can be overridden on a per-test basis). Defaults to PHP site setting if 0 or unset.
Default site wide MySQL timeout setting (can be overridden on a per-test basis). Uses PHP site default if unset.
Delay in seconds between test-threaded spawning each individual node tester session to the background (can be floating point) no delay if unset or 0
Delay in seconds between tester doing each test in series on a node (can be floating point) no delay if unset or 0
if 1 will participate in the tracker program by "pinging" a script on the freenats project homepage when pages are viewed.
If the site.enable.adminsql variable is set (1) then admin users can access the admin SQL console. This will execute SQL directly on the
database using the configured FreeNATS SQL user/pass/db settings.
This can be used for debugging and manual node alternations etc...
Warning: this is advanced functionality and misuse could well cause a major system fault.
The system status display allows admin users to view some important FreeNATS information on the status of the underlying
database and some other items. You can also optimise tables with shown freespace through this interface.