Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Remove configuration examples (moved into rear documentation)

  • Loading branch information...
commit 55a98504106a66d2f9d759a2a6c79641f54897bd 1 parent 98844ef
Dag Wieers authored

Showing 1 changed file with 0 additions and 186 deletions. Show diff stats Hide diff stats

  1. +0 186 usr/share/rear/doc/configuration-examples.txt
186 usr/share/rear/doc/configuration-examples.txt
... ... @@ -1,186 +0,0 @@
1   -= Configuration examples
2   -:data-uri:
3   -:doctype: article
4   -:icons:
5   -:iconsdir: /usr/share/asciidoc/images/icons
6   -:lang: en
7   -:quirks:
8   -
9   -This document explains the various use-cases and how to configure them in
10   -Rear. The configuration is performed by changing _/etc/rear/local.conf_ or
11   -_/etc/rear/site.conf_.
12   -
13   -There are two important variables that influence Rear and the Rear rescue
14   -image. Set +OUTPUT+ to your preferred boot method and define +BACKUP+ for your
15   -favorite +BACKUP+ strategy.
16   -
17   -In most cases only these two settings are required.
18   -
19   -
20   -== Rescue media (OUTPUT)
21   -The +OUTPUT+ variable defines where the rescue image should be send to.
22   -Possible +OUTPUT+ setting are:
23   -
24   -OUTPUT=ISO::
25   -Create a bootable ISO9660 image on disk as _rear-$(hostname).iso_
26   -
27   -OUTPUT=PXE::
28   -Create on a remote PXE/NFS server the required files (such as configuration
29   -file, kernel and initrd image
30   -
31   -OUTPUT=OBDR::
32   -Create a bootable OBDR tape including the backup archive. Specify the OBDR
33   -tape device by using +TAPE_DEVICE+.
34   -
35   -OUTPUT=USB::
36   -Create a bootable USB disk (using extlinux). Specify the USB storage device by
37   -using +USB_DEVICE+.
38   -
39   -=== Using ISO as output method
40   -When using +OUTPUT=ISO+ you should provide the backup target location through
41   -the +OUTPUT_URL+ variable. Possible +OUTPUT_URL+ settings are:
42   -
43   -OUTPUT_URL=file://::
44   -Write the ISO image to disk. The default is in _/tmp_.
45   -
46   -OUTPUT_URL=fish//::
47   -Write the ISO image using +lftp+ and the FISH protocol.
48   -
49   -OUTPUT_URL=ftp://::
50   -Write the ISO image using +lftp+ and the FTP protocol.
51   -
52   -OUTPUT_URL=ftps://::
53   -Write the ISO image using +lftp+ and the FTPS protocol.
54   -
55   -OUTPUT_URL=hftp://::
56   -Write the ISO image using +lftp+ and the HFTP protocol.
57   -
58   -OUTPUT_URL=http://::
59   -Write the ISO image using +lftp+ and the HTTP (PUT) procotol.
60   -
61   -OUTPUT_URL=https://::
62   -Write the ISO image using +lftp+ and the HTTPS (PUT) protocol.
63   -
64   -OUTPUT_URL=sftp://::
65   -Write the ISO image using +lftp+ and the secure FTP (SFTP) protocol.
66   -
67   -OUTPUT_URL=rsync://::
68   -Write the ISO image using +rsync+ and the RSYNC protocol.
69   -
70   -
71   -== Backup/Restore strategy (BACKUP)
72   -The +BACKUP+ setting defines our backup/restore strategy.
73   -Possible +BACKUP+ settings are:
74   -
75   -BACKUP=TSM::
76   -Use IBM Tivoli Storage Manager programs
77   -
78   -BACKUP=DP::
79   -Use HP DataProtector programs
80   -
81   -BACKUP=NBU::
82   -Use Symantec NetBackup programs
83   -
84   -BACKUP=BACULA::
85   -Use Bacula programs
86   -
87   -BACKUP=GALAXY::
88   -Use CommVault Galaxy (5, probably 6)
89   -
90   -BACKUP=GALAXY7::
91   -Use CommVault Galaxy (7 and probably newer)
92   -
93   -BACKUP=NETFS::
94   -Use Rear internal backup with tar or rsync (or similar)
95   -
96   -BACKUP=REQUESTRESTORE::
97   -No backup, just ask user to somehow restore the filesystems
98   -
99   -BACKUP=EXTERNAL::
100   -Use a custom strategy by providing backup and restore commands
101   -
102   -=== Using NETFS as backup strategy
103   -When using +BACKUP=NETFS+ you should provide the backup target location through
104   -the +BACKUP_URL+ variable. Possible +BACKUP_URL+ settings are:
105   -
106   -BACKUP_URL=file://::
107   -To backup to local disk, use +BACKUP_URL=file:///directory/path/+
108   -
109   -BACKUP_URL=nfs://::
110   -To backup to NFS disk, use +BACKUP_URL=nfs://nfs-server-name/share/path+
111   -
112   -BACKUP_URL=tape://::
113   -To backup to tape device, use +BACKUP_URL=tape:///dev/nst0+ or alternatively,
114   -simply define +TAPE_DEVICE=/dev/nst0+
115   -
116   -BACKUP_URL=cifs://::
117   -To backup to a Samba share (CIFS), use
118   -+BACKUP_URL=cifs://cifs-server-name/share/path+. To provide credentials for
119   -CIFS mounting use a _/etc/rear/.cifs_ credentials file and define
120   -+BACKUP_OPTIONS="cred=/etc/rear/.cifs"+ and pass along:
121   -+
122   -----
123   -username=_username_
124   -password=_secret password_
125   -domain=_domain_
126   -----
127   -
128   -BACKUP_URL=usb://::
129   -To backup to USB storage device, use +NETFS=usb:///dev/disk/by-path/REAR-000+
130   -or use a real device node or a specific filesystem label. Alternatively, you
131   -can specify the device using +USB_DEVICE=/dev/disk/by-path/REAR-000+.
132   -+
133   -If you combine this with +OUTPUT=USB+ you will end up with a bootable USB device.
134   -
135   -Optional settings:
136   -
137   -BACKUP_PROG=rsync::
138   -if you want to use rsync instead of tar
139   -
140   -NETFS_KEEP_OLD_BACKUP_COPY=y::
141   -if you want to keep the previous backup archive
142   -
143   -NOTE: With +USB+ we refer to all kinds of external storage devices, like USB
144   -keys, USB disks, eSATA disks, ZIP drives, etc...
145   -
146   -
147   -== Example: Bootable ISO
148   -If you simply want a bootable ISO on a central server, you would do:
149   -
150   -----
151   -OUTPUT=ISO
152   -OUTPUT_URL=http://server/path-to-push/
153   -----
154   -
155   -
156   -== Example: Bootable USB device with backup to USB
157   -If you want a bootable USB device with a (tar) backup to USB as well, you
158   -would use:
159   -
160   -----
161   -BACKUP=NETFS
162   -OUTPUT=USB
163   -USB_DEVICE=/dev/disk/by-label/REAR-000
164   -----
165   -
166   -
167   -== Example: Bootable tape drive (OBDR) with backup to tape
168   -If you want an OBDR image and backup on tape, and use GNU tar for
169   -backup/restore, you would use:
170   -
171   -----
172   -BACKUP=NETFS
173   -OUTPUT=OBDR
174   -TAPE_DEVICE=/dev/nst0
175   -----
176   -
177   -
178   -== Example: Bootable tape drive (OBDR) and Bacula restore
179   -If you want an OBDR image on tape, and the Bacula tools to recover your
180   -backup, use:
181   -
182   -----
183   -BACKUP=BACULA
184   -OUTPUT=OBDR
185   -TAPE_DEVICE=/dev/nst0
186   -----

0 comments on commit 55a9850

Please sign in to comment.
Something went wrong with that request. Please try again.