summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2017-06-28 08:02:13 +0000
committerintrigeri <intrigeri@boum.org>2017-06-28 08:02:13 +0000
commit062424dd2230fdd641a256908e60350a5e8c01d9 (patch)
tree7589de717e643f07d9ee8698abedbe1ea31e817e
parente655d3d78f5fc1a7e53d119e1455cf0ceeb2ad19 (diff)
parent1f24b282bfa5807eba07dd84ad276da7dfc33a26 (diff)
Updated version 1.2.3 from 'upstream/metche_1.2.3'
with Debian dir bb8e4224599b3c77cdc8542046f86759b3800378
-rw-r--r--Changelog7
-rw-r--r--README6
-rwxr-xr-xmetche2
-rw-r--r--metche.8136
-rw-r--r--metche.8.markdown128
5 files changed, 139 insertions, 140 deletions
diff --git a/Changelog b/Changelog
index 0539b41..5d8327c 100644
--- a/Changelog
+++ b/Changelog
@@ -1,3 +1,10 @@
+1.2.3 (2017 06 27)
+
+ * Update URLs: Redmine → Gitlab.
+ * Tell mutt *not* to save outgoing email.
+ This fixes Debian bug #657071.
+ * Bypass root's mutt configuration file.
+
1.2.2 (2012 06 02)
* Ignore changes to $WATCHED_DIR itself.
diff --git a/README b/README
index ff23349..6fffe8b 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
metche - reducing root bus factor
-homepage: https://labs.riseup.net/code/projects/metche
-Git repository: git://labs.riseup.net/metche.git
+homepage: https://0xacab.org/metche/metche/
+Git repository: https://0xacab.org/metche/metche.git
dev team: metche AT lists DOT riseup DOT net
,-------------------------------------------------------------------------------
@@ -36,7 +36,7 @@ periodically :
to $BACKUP_DIR (default: /var/lib/metche).
- send a nicely formatted email to a defined email address, listing the last
changes that have been made to the system.
- See https://labs.riseup.net/code/projects/metche for an example.
+ See https://0xacab.org/metche/metche for an example.
,-------------------------------------------------------------------------------
| BASIC USAGE
diff --git a/metche b/metche
index 4bf511c..e3836c4 100755
--- a/metche
+++ b/metche
@@ -82,7 +82,7 @@ add_header() {
_mail() {
local subject="$1"
if which mutt > /dev/null ; then
- LC_ALL="$LOCALE" mutt -s "$subject" "$EMAIL_ADDRESS"
+ LC_ALL="$LOCALE" mutt -F/dev/null -e 'set record="/dev/null"' -s "$subject" "$EMAIL_ADDRESS"
elif which mail > /dev/null ; then
LC_ALL="$LOCALE" mail -s "$subject" "$EMAIL_ADDRESS"
elif [ -x /usr/sbin/sendmail ]; then
diff --git a/metche.8 b/metche.8
deleted file mode 100644
index ececd17..0000000
--- a/metche.8
+++ /dev/null
@@ -1,136 +0,0 @@
-.TH METCHE 8 "June 5, 2011" "metche user manual"
-.SH NAME
-.PP
-metche - reducing root bus factor
-.SH SYNOPSIS
-.IP
-.nf
-\f[C]
-metche\ [-h\ VSERVER]\ report\ (stable|testing|unstable)-YYYYMMDDHHMM
-metche\ [-h\ VSERVER]\ list
-metche\ [-h\ VSERVER]\ stabilize\ testing-YYYYMMDDHHMM
-\f[]
-.fi
-.SH DESCRIPTION
-.PP
-metche is a tool meant to ease collective system administration by
-monitoring changes in the system configuration.
-.PP
-metche basic usage is to monitor changes in a directory, usually
-\f[C]/etc\f[]; optionally, metche can also monitor:
-.IP \[bu] 2
-one or more user maintained changelog files,
-.IP \[bu] 2
-the state of Debian packages and versions.
-.PP
-metche should be installed with a cronjob that regularly runs to
-automatically save the system state as needed.
-These states are saved in a way similar to the Debian development model:
-.IP \[bu] 2
-\f[I]unstable\f[] states are saved as soon as a change is detected.
-They are kept until a new \f[I]testing\f[] state appears.
-.IP \[bu] 2
-\f[I]testing\f[] states is created from the last \f[I]unstable\f[] state
-that has not been changed after a short amount of time (by default, one
-hour).
-Old \f[I]unstable\f[] states are deleted afterwards.
-.IP \[bu] 2
-\f[I]stable\f[] states are created from the last \f[I]testing\f[] state,
-either manually, or after a long amount of time (by default, 3 days).
-Old \f[I]testing\f[] states are deleted afterwards.
-.PP
-When a new \f[I]testing\f[] state is saved, an email is sent to a
-configurable address, giving an overwiew of the differences with the
-previous \f[I]testing\f[].
-A notification is also sent when a new \f[I]stable\f[] state is saved.
-.PP
-metche\[aq]s configuration is read from \f[C]/etc/metche.conf\f[].
-Various settings like changelog monitoring or time between system state
-switches are described there.
-.SH OPTIONS
-.PP
-If \f[C]-h\ VSERVER\f[] is specified, the VServer \f[I]VSERVER\f[] is
-operated on instead of the host system.
-This, along with the \f[C]VSNAMES\f[] option, allows one to monitor
-several VServers running on the system.
-.PP
-One of the following commands must be specified on the command line:
-.TP
-.B report
-When run with the \f[I]report\f[] command, metche displays a report
-against the specified saved state, or if unspecified, against the latest
-testing state.
-This is useful when you have broken your system and want to know which
-changes have been made since a given, known working, system state.
-.RS
-.RE
-.TP
-.B list
-When run with the \f[I]list\f[] command, metche displays a list of all
-the saved states.
-.RS
-.RE
-.TP
-.B stabilize
-When run with the \f[I]stabilize\f[] command, metche turns a "testing
-state" into a "stable state".
-By default, it will use the last "testing state", but this can be
-overridden by giving a specific state as argument.
-.RS
-.RE
-.TP
-.B cron
-This command should not be called manually, but used from a cronjob.
-When called, it can perform various operations like: saving "unstable",
-"testing" or "stable" states as needed and sending reports and
-notification if configured to do so.
-This command does not support the \f[C]-h\f[] option.
-.RS
-.RE
-.SH FILES
-.PP
-\f[C]/etc/metche.conf\f[] contains metche configuration.
-.PP
-When configured to monitor one changelog, \f[C]CHANGELOG_FILE\f[]
-(default: \f[C]/root/Changelog\f[]).
-.PP
-When configured to monitor multiple changelogs,
-\f[C]CHANGELOG_DIR/*/Changelog\f[] (default: \f[C]/root/changelogs\f[]).
-.PP
-System states are saved in \f[C]BACKUP_DIR\f[] (default:
-\f[C]/var/lib/metche\f[]).
-.SH SECURITY
-.PP
-metche is able to use GnuPG to encrypt the email it sends, but does not
-by default; just enable the \f[C]ENCRYPT_EMAIL\f[] configuration option,
-and make sure \f[C]EMAIL_ADDRESS\f[]\[aq] public key is in root\[aq]s
-keyring, trusted enough to be used blindly by metche.
-If \f[C]EMAIL_ADDRESS\f[] is an email alias or mailing-list\[aq]s
-address, you probably want to use the \f[C]group\f[] option in
-\f[C]/root/.gnupg/gpg.conf\f[] so that metche reports are encrypted for
-every person subscribed to this alias or mailing-list; for more
-information, see \f[C]gpg(1)\f[].
-.PP
-When \f[C]DO_DETAILS\f[] is enabled and \f[C]ENCRYPT_EMAIL\f[] is
-disabled, metche sends in \f[I]clear text email\f[] the changes made to
-the watched directory...
-either make sure that the \f[C]EXCLUDES\f[] configuration variable
-prevents it to send sensitive information, or triple check that secure
-connections will be used end-to-end on the email path.
-If unsure, set \f[C]EMAIL_ADDRESS\f[] configuration variable to a local
-mailbox.
-Please note that \f[C]EMAIL_ADDRESS\f[] is not used for VServers: a
-VServer\[aq]s report messages are sent to its root email address.
-.PP
-metche stores, in \f[C]BACKUP_DIR\f[] (default:
-\f[C]/var/lib/metche\f[]), various backups of \f[C]WATCHED_DIR\f[].
-Make sure that this backup place is at least as secured as the source.
-.SH BUGS
-.PP
-See metche\[aq]s ticket
-system (https://labs.riseup.net/code/projects/metche/issues) for known
-bugs, missing features, and the development road-map.
-.SH AUTHORS
-metche and this manual page were written by the boum.org collective, and
-are now maintained by the metche developers collective
-<metche@lists.riseup.net>.
diff --git a/metche.8.markdown b/metche.8.markdown
new file mode 100644
index 0000000..ec4effb
--- /dev/null
+++ b/metche.8.markdown
@@ -0,0 +1,128 @@
+% METCHE(8) metche user manual
+% metche and this manual page were written by the boum.org collective, and are now maintained by the metche developers collective <metche@lists.riseup.net>
+% June 5, 2011
+
+NAME
+====
+
+metche - reducing root bus factor
+
+SYNOPSIS
+========
+
+ metche [-h VSERVER] report (stable|testing|unstable)-YYYYMMDDHHMM
+ metche [-h VSERVER] list
+ metche [-h VSERVER] stabilize testing-YYYYMMDDHHMM
+
+DESCRIPTION
+===========
+
+metche is a tool meant to ease collective system administration by
+monitoring changes in the system configuration.
+
+metche basic usage is to monitor changes in a directory, usually
+`/etc`; optionally, metche can also monitor:
+
+ * one or more user maintained changelog files,
+ * the state of Debian packages and versions.
+
+metche should be installed with a cronjob that regularly runs to
+automatically save the system state as needed. These states are saved
+in a way similar to the Debian development model:
+
+ * _unstable_ states are saved as soon as a change is detected. They
+ are kept until a new _testing_ state appears.
+ * _testing_ states is created from the last _unstable_ state that has
+ not been changed after a short amount of time (by default, one
+ hour). Old _unstable_ states are deleted afterwards.
+ * _stable_ states are created from the last _testing_ state, either
+ manually, or after a long amount of time (by default, 3 days). Old
+ _testing_ states are deleted afterwards.
+
+When a new _testing_ state is saved, an email is sent to a
+configurable address, giving an overwiew of the differences with the
+previous _testing_. A notification is also sent when a new _stable_
+state is saved.
+
+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 VSERVER` is specified, the VServer _VSERVER_ is operated on
+instead of the host system. This, along with the `VSNAMES` option,
+allows one to monitor several VServers running on the system.
+
+One of the following commands must be specified on the command line:
+
+report
+: When run with the _report_ command, metche displays a report
+ against the specified saved state, or if unspecified, against the
+ latest testing state. This is useful when you have broken your
+ system and want to know which changes have been made since a
+ given, known working, system state.
+
+list
+: When run with the _list_ command, metche displays a list of all
+ the saved states.
+
+stabilize
+: When run with the _stabilize_ command, metche turns a "testing
+ state" into a "stable state". By default, it will use the last
+ "testing state", but this can be overridden by giving a specific
+ state as argument.
+
+cron
+: This command should not be called manually, but used from a
+ cronjob. When called, it can perform various operations like:
+ saving "unstable", "testing" or "stable" states as needed and
+ sending reports and notification if configured to do so. This
+ command does not support the `-h` option.
+
+FILES
+=====
+
+`/etc/metche.conf` contains metche configuration.
+
+When configured to monitor one changelog, `CHANGELOG_FILE` (default:
+`/root/Changelog`).
+
+When configured to monitor multiple changelogs,
+`CHANGELOG_DIR/*/Changelog` (default: `/root/changelogs`).
+
+System states are saved in `BACKUP_DIR` (default: `/var/lib/metche`).
+
+SECURITY
+========
+
+metche is able to use GnuPG to encrypt the email it sends, but does
+not by default; just enable the `ENCRYPT_EMAIL` configuration option,
+and make sure `EMAIL_ADDRESS`' public key is in root's keyring,
+trusted enough to be used blindly by metche. If `EMAIL_ADDRESS` is an
+email alias or mailing-list's address, you probably want to use the
+`group` option in `/root/.gnupg/gpg.conf` so that metche reports are
+encrypted for every person subscribed to this alias or mailing-list;
+for more information, see `gpg(1)`.
+
+When `DO_DETAILS` is enabled and `ENCRYPT_EMAIL` is disabled, metche
+sends in _clear text email_ the changes made to the watched
+directory... either make sure that the `EXCLUDES` configuration
+variable prevents it to send sensitive information, or triple check
+that secure connections will be used end-to-end on the email path. If
+unsure, set `EMAIL_ADDRESS` configuration variable to a local mailbox.
+Please note that `EMAIL_ADDRESS` is not used for VServers: a
+VServer's report messages are sent to its root email address.
+
+metche stores, in `BACKUP_DIR` (default: `/var/lib/metche`), various
+backups of `WATCHED_DIR`. Make sure that this backup place is at least
+as secured as the source.
+
+BUGS
+====
+
+See [metche's ticket system] for known bugs, missing features, and the
+development road-map.
+
+[metche's ticket system]: https://0xacab.org/metche/metche/issues