wilde: utils/admin save-annotations.README,NONE,1.1

[cvs at intevation.de]

Author: wilde

Update of /kolabrepository/utils/admin
In directory doto:/tmp/cvs-serv9679

Added Files:
	save-annotations.README 
Log Message:
Short documentation for save-annotations.sh


--- NEW FILE: save-annotations.README ---
save-annotations
================

Backup annotations.db and check if it's broken.

The cyrus imap annotations.db is known to get corrupted easily and
hard to be recovered. <https://intevation.de/roundup/kolab/issue840>
Therefor this script can be installed on an kolab-server as a cronjob
to backup the annotations.db and warn the administrator if the current
annotations.db is broken.

The warning will be sent by email, so make sure you can read your
mails even when the kolab-server fails!


Installation
------------

- Edit save-annotations.sh: read the comments and set the variables on
  the top of the script to meaningful values.  Most defaults should be
  sensible for a standard kolab installation.

- Make save-annotations.sh executable:
  chmod 755 save-annotations.sh

- Copy (as root) save-annotations.sh anywhere you like, eg:
  cp save-annotations.sh /kolab/sbin

- Make an entry in /etc/crontab to run save-annotations.sh on an
  regular basis.  If the last working update is not up to date
  recovering the lost information will be difficult and painful, so
  more often is better.
  This example runs save-annotations every hour:
  0 * * * *   kolab-r /kolab/sbin/save-annotations.sh

Now: read your mails, and if the annotations.db gets corrupted put the
last working backup in place:
zcat PATH/TO/BACKUP/annotations.db-20060124-08:01:01.gz >/kolab/var/imapd/annotations.db