QUOTAWATCH
Section: File Formats (5)
Index
NAME
/etc/quotawatch/ - the quotawatch configuration files
DESCRIPTION
The files located in the /etc/quotawatch directory are used to configure
various aspects of quotawatch. Some of these files are only required if
quotawatch(8) is executed with the --notify
or -n option. The files are used in the generation of content that is included in the customisable
notification emails that can be sent to users and site administrators. Within all these files, any lines beginning with the
# symbol are treated as comments and ignored by quotawatch. Additional to the information provided
here, there are more instructions to help you edit the configurations within the files themselves.
FILES
/etc/quotawatch/quotawatch.conf- The quotawatch.conf file lets you optionally provide details that can control certain aspects of quotawatch. Within this file, for example, you can provide a Company Name, which can be inserted into the notification email messages when quotawatch runs. Any options in this file can be left blank, and quotawatch will use default values.
/etc/quotawatch/mail.siteadmin-
The message body that is sent to a site administrator when a site alert is triggered is defined in this file.
You can customise this file so that the message can contain anything you wish. The message can make use of
any of the message variables listed in the next section.
You can also set a 'From' address to be used on the email. This can be used to make the email appear to have been sent by somebody more familiar to the user than 'root@hostname'. This address can simply take the form of an email address, or you can set it up as 'Real Name <email.address@domain.com>'.
Finally, you can change what the subject of the notification emails will be. If this option is left empty, a default subject of 'Disk Quota Warning' will be used. /etc/quotawatch/mail.user-
The message body that is sent to a user when a user alert is triggered is defined in this file.
You can customise this file so that the message can contain anything you wish. The message can make use of
any of the message variables listed in the next section.
You can also set a 'From' address to be used on the email. This can be used to make the email appear to have been sent by somebody more familiar to the user than 'root@hostname'. This address can simply take the form of an email address, or you can set it up as 'Real Name <email.address@domain.com>'.
Finally, you can change what the subject of the notification emails will be. If this option is left empty, a default subject of 'Disk Quota Warning' will be used. /var/lib/quotawatch/alerted-
This file keeps a record of users/sites that have triggered alerts when quotawatch has been run with the logging
option turned on. The location of this file can be changed by editing the
AlertLogPathoption in quotawatch.conf. This is not a human-readable log file. You should never need to look at the contents.
MAIL VARIABLES
There are several variables available to you to use in your user/site admin notification emails. These variables will take on values when quotawatch generates the warning emails.
--USER--- the account name of the offending user
--DOMAIN--- the domain name of the relevant over-quota user
--QSIZE--- the value of the user's disk quota (in megabytes)
--QUSAGEMB--- the current usage (in megabytes)
--QUSAGEPC--- the current usage (percentage value)
--QAVAIL-- or --QAVAILMB--- the remaining disk space available to the user (in megabytes)
--QAVAILPC--- the available disk quota (percentage value)
--COMPANY--- your company name (defined in quotawatch.conf)
AUTHOR
Tim Littlemore (tim@littlemore-email.co.uk)
BUGS
Please report bugs, problems with documentation or feature requests to quotawatch@1steasy.com or quotawatch@littlemore-email.co.uk
Index
This document was created by man2html, using the manual pages - then tweaked a lot!
top