This page describe step by step how to do a basic installation of Domestik server.

Lua is a lightweight, versatile and portage language. Having a very small footprint, it was the ideal language for writing Domestik's client.

Installing and configuring Lua is clearly out of the scope of this documentation. Have a look on your own OS documentation or here for Gentoo (in French).

Some modules are required :

• luasocket - network connectivity
• luafilesystem - file management
• dkjson - Json manipulation
• luaposix - POSIX calls

If they are not packaged for your OS, you can install them manually using luarocks :

luarocks install luasocket

For security reason, create a dedicated user with reduced rights

useradd --comment "Domestik's user" --gid nogroup --system --no-user-group --shell /sbin/nologin --home-dir /dev/null domestik

Dowload the tarball from Sourceforge and install in in /usr/local (it will create /usr/local/Domestik).
Alternatively, you may use an SVN snapshot.

When Domestik daemon is starting, it scans /usr/local/Domestik/Client/Probes directory and load all probes it found. Consequently, if you want to disable a probe, simply move the related file to /usr/local/Domestik/Client/inactive_Probes and restart the daemon.

Probes for which the filename is starting with linux_* may be ... linux dependent. it's mostly because they are relying on procfs filesystem.

Following probes need a special attention :

This probe will monitor hardware figures, using LM sensors. So you need first to install LM sensors and configure it for your system.

Then hardware sensors will be exposed in /sysfs and then integrated in Domestik.

Based on discovered sensors and sysfs documentation, feed probes_list. For each probe, you have to provide 2 functions :

• the 1st one determines error condition. Provided err_alarm() follows SysFS definition : it checks first if the hardware exposes errors (*_alarm file). If this file doesn't exist, it checks actual value versus content of *_crit file.
• the 2nd function allows you to format the output.

You can provide or a function, or the name of a function which is defined inside funcs table.

The configuration provided for AK-47 motherboard that containing lot of sensors.

This probe allows to monitor the presence and resources consumed by some processes.

The configuration is done by the table process_tracking_list for which keys are process name. For each processes, 2 functions have to be provided :

1. track_it : is this process' resources tracked or not, with following possible values :
• false : no tracking
• true : data, stack and number of instances tracked
• custom tracking function. As input, it got an array of pid, as output it has to provide an array containing { data, stack, instances_number }
2. alert : do we have to raise an alert for this process, with following possible values :
• false : we don't want to be alerted for this process.
• true : send an alert if this process is not running
• custom tracking function : with as input an array likes { { data, stack, instances }, array of process numbers }, and as output, an error string or nil if no error to raise.

You can provide or a function, or the name of a function which is defined inside funcs table.

Install hddtemp and start it in daemon mode.

Follows the following procedure :

1. Install smartmontools
2. Create /usr/local/share/smartlog.sh helper script and make it executable

#!/bin/sh
# Notify smartd's errors

echo "$SMARTD_DEVICESTRING" "$SMARTD_MESSAGE" > /tmp/smartd.msg

3. in smartd.conf, the only active line has to be

DEVICESCAN -m <nomailer> -M exec /usr/local/share/smartlog.sh

4. restart smartd

Logon on administrative page of Domestik's server and create an user for your host.

Modify Client/dmkcheck & Client/dmkcheckd with the account you just created.

It's time to see if the configuration is working :

/usr/local/Domestik/Client/dmkcheck
*I* Loading linux_memory ...
*I* Loading linux_cpuload ...
*I* Loading smart ...
*I* Loading filesystem ...
*I* Loading hddtemp ...
*E* Processing error :    200

The last line is the important one : 200 is the HTML return code to say "ok, operation successful". Any other return code means your facing a problem as in the following example :

 ./dmkcheck
*I* Loading linux_memory ...
*I* Loading linux_cpuload ...
*I* Loading hddtemp ...
*I* Loading linux_hardware ...
*I* Loading smart ...
*I* Loading filesystem ...
*E* Communication layer error - Return code :    401    *F* You must logon to access to this page

In this case, the password is probably wrong. Based on information you got after the error code ... be imaginative.

Some startup scripts are provided in .../Client/Share/startscript. Which script to use depend on your OS. And obviously the installation has to be done as root.

If for whatever reason you can't or don't want use starting script, you may :

• launch .../Client/dmkcheckd in your desktop startup procedure (yes, you guessed it : you need having a look on your DE documentation). As example :
• part of ~/.xinitrc (for almost all Xorg based DE)
• part of ~/.config/lxsession/LXDE/autostart for LXDE
• for most advanced DE like XFCE, Gnome or KDE, launch it as a service in the session manager.
• ... 
• Last but not least, launch .../Client/dmkcheckd & in a shell. It will survive until you close it.
  

cp /usr/local/Domestik/Client/Share/startscript/dmkcheckd.openrc /etc/init.d/dmkcheckd
rc-update add dmkcheckd default
 * service dmkcheckd added to runlevel default

And then finally ... launch it

/etc/init.d/dmkcheckd start
 * Caching service dependencies ...            [ ok ]
 * Starting Domestik's daemon ...              [ ok ]

cp /usr/local/Domestik/Client/Share/startscript/dmkcheckd.upstart /etc/init/dmkcheckd.conf

and launch it

start dmkcheckd

cp /usr/local/Domestik/Client/Share/startscript/dmkcheckd.lsb /etc/init.d/dmkcheckd
update-rc.d  dmkcheckd defaults

And then finally ... launch it

/etc/init.d/dmkcheckd start
 * Starting Domestik monitoring tool daemon: dmkcheckd