9. Files and directories

This is an overview of the files and directories used by Beltane.

Beltane configuration file ($HOME/.beltanerc)

This is the configuration file for Beltane. It is located in the home directory of the user under whose UID Beltane is running (i.e. the php scripts are executed) — this user can be set via the configure option --with-user=USERNAME upon istallation. You can use the Configure button in the upper left panel to interactive change configuratioin settings in this file (see Section 4).

Data directory (/var/lib/yule)

This is the data directory of the yule log server. Here, configuration files and file signature databases of samhain clients are stored.

Beltane needs read/write access to this directory in order to be able to update the clients file signature databases. See Section 2.8.4 for details.

Client list (/var/lib/yule/profiles/yulerc.install.db)

This is an XML file holding a list of installed clients. This file is automatically created if you use the samhain deploy script to deploy samhain clients to remote machines. Otherwise, a dummy file will be created by Beltane. You would then need to fill in details by hand, using the Add function in the Clients panel. See also Section 3.2.

Undo file (/var/lib/yule/file.last.log)

This file is used internally by Beltane to undo the last update of (a) file signature database(s).

Yule pid file (/var/run/yule.pid)

This file is created by the server with permissions of -rw-r----- and holds its PID. It is used by Beltane to determine the server status. It should be readable by the user under whose UID Beltane is running (i.e. Beltane and yule should be in the same group).

Yule status file (/var/lib/yule/yule.html)

This is the server status file, which provides some basic information on the server and the active clients. It is created by the server with permissions of -rw-r----- and should be readable by the user under whose UID Beltane is running (i.e. Beltane and yule should be in the same group).