diff --git a/debian/templates b/debian/templates index 07763d5..cfd285b 100644 --- a/debian/templates +++ b/debian/templates @@ -1,31 +1,37 @@ Template: metche/email Type: string Default: root -Description: Send the reports to this email address. - By default, metche is run periodically by a cron job which returns - reports containing changes made to: - - the changelog file(s), - - the watched directory, - - the list of installed Debian packages. - This option indicates to which email address those reports will be - sent and typically corresponds to your collective administration - mailing-list address. +Description: E-mail address receiving metche reports + metche monitors "system state" changes. With default settings, one hour + after the last change has been recorded, an e-mail report is sent discribing + changes to: + - files inside the watched directory (/etc by default), + - user maintainted changelog file(s) (if configured to do so), + - the list of installed Debian packages (if configured to do so). . - Note: metche is also able to use GnuPG to encrypt the email it sends, - but does not by default. See the man page and the configuration file - for more details. + Please enter the e-mail that should receive these reports. It typically + corresponds to the alias or mailling-list used by system administators for + this computer. + . + Note: by default, metche does not send detailed diffs describing files changes + as this can leak confidential information. If you want to use this feature, + we strongly encourage you to turn on GPG encryption at the same time. + See the metche(8) man page and the configuration file for more details. Template: metche/changelog/type Type: select Choices: Single changelog file, Multiple changelog files, No changelog monitoring Description: Changelog monitoring type. - Metche monitors changelogs written by the administrators of the - system, these changelogs contain comments describing the changes made - to the system. You can choose between two different types of - monitoring: - - Single changelog file monitoring or - - Multiple changelog files monitoring, in which each "Changelog" - file in sub-directories of a given directory will be monitored. + metche can monitor one or more changelogs written by the system + administrators. + . + These changelogs should contain comments describing the changes made + to the system. The easiest way to organize these comments is to put them all + together in one file. + . + Another possibility is to have a subdirectory for each administrative tasks + with a file named "Changelog". This way, you can store source code or + configuration examples along the documentation on how they have been used. Template: metche/changelog/file Type: string @@ -35,5 +41,5 @@ Template: metche/changelog/directory Type: string Description: Changelog directory to be monitored. - This option sets the path of the changelogs directory. Each + This option sets the path of the changelogs root directory. Each "Changelog" file should be in a sub-directory of this directory. diff --git a/metche-manpage.sgml b/metche-manpage.sgml index eea1897..11e50ac 100644 --- a/metche-manpage.sgml +++ b/metche-manpage.sgml @@ -16,7 +16,6 @@ metche - -h host cron report @@ -41,7 +40,7 @@ metche is a tool meant to facilitate collective sysadmin by monitoring changes in the system configuration. - At least, metche monitors one directory, usually + metche basic usage is to monitor changes in a directory, usually /etc ; optionally, metche can also monitor: @@ -82,21 +81,15 @@ A notification is also sent when a new stable state is saved. - - WATCHED_DIR and CHANGELOG_DIR options - can me customized in metche's configuration file, as well as a few other - ones. + metche's configuration is read from + /etc/metche.conf. Various settings like changelog + monitoring or time between system state switches are described + there. OPTIONS - - If -h HOST is specified, - /etc/metche/HOST.conf is used instead of - /etc/metche.conf. This, along with the - VSERVER_EXEC_PREFIX option, allows to monitor several - vservers running on a system. One of the following commands must be specified on the command line: @@ -137,17 +130,23 @@ + + FILES + /etc/metche.conf contains metche configuration. + - FILES - /etc/metche.conf or - /etc/metche/*.conf : configuration file(s) + When configured to monitor one changelog, + CHANGELOG_FLE (default + /root/Changelog). + - CHANGELOG_DIR/*/Changelog - (default : /root/changelogs), if Changelog monitoring - is enabled : Changelog files location + When configured to monitor multiple changelogs, + CHANGELOG_DIR/*/Changelog + (default : /root/changelogs). - BACKUP_DIR : directory containing - the backups + System states are saved in + BACKUP_DIR (default + /var/lib/metche. SECURITY