Permalink
Browse files

2005-11-23 Alexis Sukrieh <sukria@backup-manager.org>

	* backup-manager:
	  + Added the copyright/licence notice.
	* doc/user-guide.sgml:
	  + Better (really better) structure, that begins to be something...
	* Makefile
	  + The clean target now cleans doc/



git-svn-id: svn://svn.backup-manager.org/backup-manager/trunk@256 2e458433-d701-0410-9826-f9b593394a3c
  • Loading branch information...
1 parent fdc87e9 commit 3398e1622f5f6a8b8ae6389b9e17b84d4566ac81 sukria committed Nov 23, 2005
Showing with 148 additions and 42 deletions.
  1. +9 −0 ChangeLog
  2. +1 −0 Makefile
  3. +15 −12 backup-manager
  4. +123 −30 doc/user-guide.sgml
View
@@ -1,3 +1,12 @@
+2005-11-23 Alexis Sukrieh <sukria@backup-manager.org>
+
+ * backup-manager:
+ + Added the copyright/licence notice.
+ * doc/user-guide.sgml:
+ + Better (really better) structure, that begins to be something...
+ * Makefile
+ + The clean target now cleans doc/
+
2005-11-10 Alexis Sukrieh <sukria@sukria.net>
* backup-manager.conf.tpl:
View
@@ -85,4 +85,5 @@ clean:
rm -f build-stamp
rm -rf debian/backup-manager
$(MAKE) -C po clean
+ $(MAKE) -C doc clean
View
@@ -1,20 +1,23 @@
#!/bin/bash
-#####################################################
-# Backup Manager
+
+# Copyright (C) 2005 The Backup Manager Authors
+# See the AUTHORS file for details.
#
-# This is the main backup-manager script.
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
#
-# It will read the conf file $conffile
-# to know what to do and will then either :
-# . generate archives in the format you choose
-# . upload them to remote hosts with ftp or scp
-# . clean up the archive repository
-# . burn the backup-repo to a CDR/CDRW
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# This program is free software and is available
-# under the terms of the GNU General Public License.
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
-######################################################
+# This is the main backup-manager script.
set -e
View
@@ -13,6 +13,29 @@
<!ENTITY FIXME "<em>FIXME:</em>&nbsp;">
]>
+
+<!-- Template of a configuration key description
+
+ Please, follow this template for *each* configuration key
+ this will allow us to make a nice appendix later, think to our
+ users ;-)
+
+<sect1 id="BM_MYCONFIGURATION_KEY"><tt>BM_MYCONFIGURATION_KEY</tt>
+
+<p>
+<em>Type: TYPE, default: <tt>DEFAULT</tt>.</em>
+
+<p>
+Description
+
+<p>
+Example:
+
+<example>
+</example>
+
+-->
+
<debiandoc>
<book>
<title>&bmngr; &bmngr-version; User Guide
@@ -85,34 +108,51 @@ you want to give any comments, suggestions, or criticisms please send an
email to the development list, backup-manager-devel@backup-manager.org, or submit
a bug report against the "Documentation" product, in the bug tracking system.
-<chapt id="design">Global Design
+<chapt id="design">Repository and Archives
<p>
&bmngr; stores <em>archives</em> it builds in a <em>repository</em>.
-<em>Archives</em> are built by using a <em>backup method</em>. Each
-<em>method</em> has a special meaning and behaviour.
-A <em>backup scenario</em> is described in a configuration file that contains
-<em>configuration keys</em>.
+<em>Archives</em> are built by using a <em>backup method</em>.
<sect id="archive-repo">The Repository
+<!-- -->
+<sect1 id="BM_REPOSITORY_ROOT"><tt>BM_REPOSITORY_ROOT</tt>
+
+<p>
+<em>Type: string, default: <tt>/var/archives</tt>.</em>
+
<p>
The repository is the place in your filesystem
where every archives are stored.
This is a particular place for &bmngr;, it will be cleaned during backup
sessions: archives older than the authorized lifetime will be purged.
-This place is defined with the configuration key <tt>BM_REPOSITORY_ROOT</tt>.
+If the repository does not exist, it will be created at runtime.
+
+<p>
+Isolating the repository on a dedicated partition is a good idea. This can
+prevent the repository from eating all the disk space of the partition.
+With a bad configuration file, backup sessions can lead to huge archives,
+for many reasons, so take care).
<p>
Example:
+<example>
+export BM_REPOSITORY_ROOT="/var/archives"
+</example>
+
+<sect1 id="BM_REPOSITORY_SECURE"><tt>BM_REPOSITORY_SECURE</tt>
+
<p>
-<tt>export BM_REPOSITORY_ROOT="/var/archives"</tt>
+<em>Type: boolean, default: <tt>true</tt>.</em>
<p>
For security reasons, the repository can be accessible by a specific user/group
pair. This will prevent the archives from being readable (and writable) by any user
in the system. This mode is enabled by default (owned by <tt>root:root</tt>).
+
+<p>
To enable this mode, set the configuration key <tt>BM_REPOSITORY_SECURE</tt>
to <tt>yes</tt>, then update <tt>BM_REPOSITORY_USER</tt> and
<tt>BM_REPOSITORY_GROUP</tt> to your needs.
@@ -121,16 +161,11 @@ to <tt>yes</tt>, then update <tt>BM_REPOSITORY_USER</tt> and
Example:
<example>
-export BM_REPOSITORY_SECURE="yes"
+export BM_REPOSITORY_SECURE="true"
export BM_REPOSITORY_USER="root"
export BM_REPOSITORY_GROUP="root"
</example>
-<p>
-Isolating the repository on a dedicated partition is a good idea. This can
-prevent the repository from eating all the disk space of the parent partition
-(<tt>/var</tt> for insance) if the configuration file leads to huge archives.
-
<sect id="archives">Archives
<p>
@@ -139,6 +174,11 @@ will always be named like the following: <tt>prefix-name-date.filetype</tt>.
An archive is a file that contains data, it can be compressed or not, in a binary
form or not.</em>
+<sect1 id="BM_ARCHIVE_PURGEDUPS"><tt>BM_ARCHIVE_PURGEDUPS</tt>
+
+<p>
+<em>Type: boolean, default: <tt>true</tt>.</em>
+
<p>
If disk usage matters in your backup strategy, you might find useful to use
&bmngr;'s duplicates purging feature. When an archive is generated, &bmngr;
@@ -149,20 +189,56 @@ This is useful if you don't want to have twice the same archive in the
repository.
<p>
+Example:
+
+<example>
+export BM_ARCHIVE_PURGEDUPS="true"
+
+# ls -l /var/archives
+wrw-rw---- 1 root root 138 2005-11-15 10:46 host-etc.20051115.tar.gz
+wrwxrwxrwx 1 root root 51 2005-11-17 10:31 host-etc.20051116.tar.gz -> /var/archives/host-etc.20051117.tar.gz
+-rw-rw---- 1 root root 137 2005-11-17 10:31 host-etc.20051117.tar.gz
+</example>
+
+<sect1 id="BM_ARCHIVE_TTL"><tt>BM_ARCHIVE_TTL</tt>
+
+<p>
+<em>Type: integer, default: <tt>5</tt>.</em>
+
+<p>
One of the main concept behind the handling of the repository is to purge
deprecated archives automatically. The purge session is always performed
when you launch &bmngr;. During this phase, every archives older than the
authorized lifetime are droped.
<p>
-<list>
-<item><tt>BM_ARCHIVE_PREFIX</tt>: String. This is the prefix used for naming
-archives (Default is the hostname).
-<item><tt>BM_ARCHIVE_TTL</tt>: Integer. The authorized lifetime (in days) for an archive.
-Every archive older than this age are droped during the purge phase.
-<item><tt>BM_ARCHIVE_PURGEDUPS</tt>: Boolean. If set to <tt>yes</tt> the
-duplicates purging feature is enabled.
-</list>
+Example:
+
+<example>
+export BM_ARCHIVE_TTL="5"
+</example>
+
+<sect1 id="BM_ARCHIVE_PREFIX"><tt>BM_ARCHIVE_PREFIX</tt>
+
+<p>
+<em>Type: string, default: <tt>$HOSTNAME</tt>.</em>
+
+<p>
+This is the prefix used for naming archives.
+
+<p>
+Example:
+
+<example>
+export BM_ARCHIVE_PREFIX="$HOSTNAME"
+
+# echo $HOSTNAME
+ouranos
+# ls /var/archives
+ouranos-20051123.md5
+ouranos-usr-local-src.20051123.tar.gz
+ouranos-etc.20051123.tar.gz
+</example>
<chapt id="methods">Backup Methods
@@ -177,12 +253,23 @@ The method you choose must be defined in the configuration key
you want to use. Take care to put every configuration keys needed by all the
methods you choose.
+<p>
+A couple of other configuration keys may be needed depending on the method you
+choose.
+
+<p>
+Example:
+
+<example>
+export BM_ARCHIVE_METHOD="tarball-incremental mysql"
+</example>
+
<sect id="tarball">Tarballs
<sect1 id="tarball-desc">Description
<p>
-<em>Method name: <tt>tarball</tt>, configuration keys prefix: <tt>BM_TARBALL</tt>.</em>
+<em>Method name: <tt>tarball</tt>, configuration key prefix: <tt>BM_TARBALL</tt>.</em>
<p>
If all you want to do is to handle a couple of tarballs of your file system, you
@@ -216,7 +303,8 @@ Suggested value: <tt>long</tt>.
<sect1 id="BM_TARBALL_FILETYPE"><tt>BM_TARBALL_FILETYPE</tt>
-<p>Type: enum.
+<p>
+<em>Type: enum(tar, tar.gz, tar.bz2, zip), default: <tt>tar.gz</tt>.</em>
<p>
Basically, this configuration key defines the filetype of the resulting archive.
@@ -230,7 +318,8 @@ For the best compression rate, choose <tt>tar.bz2</tt>.
<sect1 id="BM_TARBALL_DUMPSYMLINKS"><tt>BM_TARBALL_DUMPSYMLINKS</tt>
-<p>Type: boolean, to enable put "<tt>true</tt>", to disable put "<tt>false</tt>".
+<p>
+<em>Type: boolean, default: <tt>true</tt>.</em>
<p>
It is possible, when generating the tarball (or the zip file) to dereference the
@@ -244,14 +333,16 @@ In most of the cases, you should not use this feature.
<sect1 id="BM_TARBALL_DIRECTORIES"><tt>BM_TARBALL_DIRECTORIES</tt>
-<p>Type: space separated list.
+<p>
+<em>Type: space-separated list, default: <tt>""</tt>.</em>
<p>
You certainly want to backup something, don't you? So here is the place where
you put that precious list of locations.
<p>
Example:
+
<example>
export BM_TARBALL_DIRECTORIES="/etc /home /var/log/apache"
</example>
@@ -285,7 +376,8 @@ backups be made.
<sect1 id="BM_TARBALLINC_MASTERDATETYPE"><tt>BM_TARBALLINC_MASTERDATETYPE</tt>
-<p>Type: <tt>enum(weekly, monthly)</tt>.
+<p>
+<em>Type: enum(weekly, monthly), default: <tt>weekly</tt>.</em>
<p>
This is the type of frequency you want to use. If you choose <tt>weekly</tt>,
@@ -296,7 +388,8 @@ the day number will be between 1 and 31.
<sect1 id="BM_TARBALLINC_MASTERDATEVALUE"><tt>BM_TARBALLINC_MASTERDATEVALUE</tt>
-<p>Type: <tt>integer</tt>.
+<p>
+<em>Type: integer, default: <tt>1</tt>.</em>
<p>
The number of the day when making full backups. Note that its meaning directly
@@ -305,9 +398,9 @@ For instance, 1 means <em>"monday"</em> if you
choose a weekly frequency, but it means <em>"the first day of the month"</em>
if you choose a monthly frequency.
-<sect id="mysql">MySQL databases
-<sect id="svn">Subversion repositories
-<sect id="pipe">Generic methods
+<sect1 id="mysql">MySQL databases
+<sect1 id="svn">Subversion repositories
+<sect1 id="pipe">Generic methods
<chapt id="exports">Exports
<sect id="media">Media

0 comments on commit 3398e16

Please sign in to comment.