1 |
=head1 BackupPC Introduction |
=head1 BackupPC Introduction |
2 |
|
|
3 |
This documentation describes BackupPC version 2.1.0, |
This documentation describes BackupPC version 2.1.2, |
4 |
released on 20 Jun 2004. |
released on 5 Sep 2005. |
5 |
|
|
6 |
=head2 Overview |
=head2 Overview |
7 |
|
|
269 |
|
|
270 |
Various programs and scripts use rsync to provide hardlinked backups. |
Various programs and scripts use rsync to provide hardlinked backups. |
271 |
See, for example, Mike Rubel's site (L<http://www.mikerubel.org/computers/rsync_snapshots>), |
See, for example, Mike Rubel's site (L<http://www.mikerubel.org/computers/rsync_snapshots>), |
272 |
JW Schultz's dirvish (L<http://www.pegasys.ws/dirvish> (although as of |
JW Schultz's dirvish (L<http://www.dirvish.org>), |
|
June 2004 this link doesn't work)), |
|
273 |
Ben Escoto's rdiff-backup (L<http://rdiff-backup.stanford.edu>), |
Ben Escoto's rdiff-backup (L<http://rdiff-backup.stanford.edu>), |
274 |
and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>). |
and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>). |
275 |
|
|
299 |
|
|
300 |
Beyond being a satisfied user and telling other people about it, everyone |
Beyond being a satisfied user and telling other people about it, everyone |
301 |
is encouraged to add links to L<http://backuppc.sourceforge.net> |
is encouraged to add links to L<http://backuppc.sourceforge.net> |
302 |
(I'll see then via Google) or otherwise publicize BackupPC. Unlike |
(I'll see them via Google) or otherwise publicize BackupPC. Unlike |
303 |
the commercial products in this space, I have a zero budget (in both |
the commercial products in this space, I have a zero budget (in both |
304 |
time and money) for marketing, PR and advertising, so it's up to |
time and money) for marketing, PR and advertising, so it's up to |
305 |
all of you! Feel free to vote for BackupPC at |
all of you! Feel free to vote for BackupPC at |
515 |
The same sequence of commands can be used for each module. |
The same sequence of commands can be used for each module. |
516 |
|
|
517 |
Now let's move onto BackupPC itself. After fetching |
Now let's move onto BackupPC itself. After fetching |
518 |
BackupPC-2.1.0.tar.gz, run these commands as root: |
BackupPC-2.1.2.tar.gz, run these commands as root: |
519 |
|
|
520 |
tar zxf BackupPC-2.1.0.tar.gz |
tar zxf BackupPC-2.1.2.tar.gz |
521 |
cd BackupPC-2.1.0 |
cd BackupPC-2.1.2 |
522 |
perl configure.pl |
perl configure.pl |
523 |
|
|
524 |
In the future this release might also have patches available on the |
In the future this release might also have patches available on the |
525 |
SourceForge site. These patch files are text files, with a name of |
SourceForge site. These patch files are text files, with a name of |
526 |
the form |
the form |
527 |
|
|
528 |
BackupPC-2.1.0plN.diff |
BackupPC-2.1.2plN.diff |
529 |
|
|
530 |
where N is the patch level, eg: pl5 is patch-level 5. These |
where N is the patch level, eg: pl5 is patch-level 5. These |
531 |
patch files are cumulative: you only need apply the last patch |
patch files are cumulative: you only need apply the last patch |
532 |
file, not all the earlier patch files. If a patch file is |
file, not all the earlier patch files. If a patch file is |
533 |
available, eg: BackupPC-2.1.0pl5.diff, you should apply |
available, eg: BackupPC-2.1.2pl5.diff, you should apply |
534 |
the patch after extracting the tar file: |
the patch after extracting the tar file: |
535 |
|
|
536 |
# fetch BackupPC-2.1.0.tar.gz |
# fetch BackupPC-2.1.2.tar.gz |
537 |
# fetch BackupPC-2.1.0pl5.diff |
# fetch BackupPC-2.1.2pl5.diff |
538 |
tar zxf BackupPC-2.1.0.tar.gz |
tar zxf BackupPC-2.1.2.tar.gz |
539 |
cd BackupPC-2.1.0 |
cd BackupPC-2.1.2 |
540 |
patch -p0 < ../BackupPC-2.1.0pl5.diff |
patch -p0 < ../BackupPC-2.1.2pl5.diff |
541 |
perl configure.pl |
perl configure.pl |
542 |
|
|
543 |
A patch file includes comments that describe that bug fixes |
A patch file includes comments that describe that bug fixes |
599 |
=head2 Step 3: Setting up config.pl |
=head2 Step 3: Setting up config.pl |
600 |
|
|
601 |
After running configure.pl, browse through the config file, |
After running configure.pl, browse through the config file, |
602 |
__INSTALLDIR__/conf/config.pl, and make sure all the default settings |
__TOPDIR__/conf/config.pl, and make sure all the default settings |
603 |
are correct. In particular, you will need to decide whether to use |
are correct. In particular, you will need to decide whether to use |
604 |
smb, tar or rsync transport (or whether to set it on a per-PC basis) |
smb, tar or rsync transport (or whether to set it on a per-PC basis) |
605 |
and set the relevant parameters for that transport method. |
and set the relevant parameters for that transport method. |
925 |
=item Mac OS X |
=item Mac OS X |
926 |
|
|
927 |
In general this should be similar to Linux/Unix machines. |
In general this should be similar to Linux/Unix machines. |
928 |
Mark Stosberg reports that you can also use hfstar. |
Many users have reported success using xtar, which also |
929 |
|
backs up the Mac OS X resource forks. |
930 |
|
|
931 |
|
Other choices include rsync and Mark Stosberg reports that you |
932 |
|
can also use hfstar. |
933 |
See L<http://fink.sourceforge.net/pdb/package.php/hfstar>. |
See L<http://fink.sourceforge.net/pdb/package.php/hfstar>. |
934 |
|
|
935 |
=item SSH Setup |
=item SSH Setup |
1546 |
Note that for direct restore to work, the $Conf{XferMethod} must |
Note that for direct restore to work, the $Conf{XferMethod} must |
1547 |
be able to write to the client. For example, that means an SMB |
be able to write to the client. For example, that means an SMB |
1548 |
share for smbclient needs to be writable, and the rsyncd module |
share for smbclient needs to be writable, and the rsyncd module |
1549 |
needs "read only" set to "yes". This creates additional security |
needs "read only" set to "false". This creates additional security |
1550 |
risks. If you only create read-only SMB shares (which is a good |
risks. If you only create read-only SMB shares (which is a good |
1551 |
idea), then the direct restore will fail. You can disable the |
idea), then the direct restore will fail. You can disable the |
1552 |
direct restore option by setting $Conf{SmbClientRestoreCmd}, |
direct restore option by setting $Conf{SmbClientRestoreCmd}, |
1987 |
running. Therefore, when it is time to run BackupPC_nightly, no new |
running. Therefore, when it is time to run BackupPC_nightly, no new |
1988 |
backups are started and BackupPC waits until all backups have finished. |
backups are started and BackupPC waits until all backups have finished. |
1989 |
Then BackupPC_nightly is run, and until it finishes no new backups are |
Then BackupPC_nightly is run, and until it finishes no new backups are |
1990 |
started. If BackupPC_nightly is slow, the settings |
started. If BackupPC_nightly takes too long to run, the settings |
1991 |
|
$Conf{MaxBackupPCNightlyJobs} and $Conf{BackupPCNightlyPeriod} can |
1992 |
|
be used to run several BackupPC_nightly processes in parallel, and |
1993 |
|
to split its job over several nights. |
1994 |
|
|
1995 |
=back |
=back |
1996 |
|
|
3383 |
- 'rsync': backup and restore via rsync (via rsh or ssh). |
- 'rsync': backup and restore via rsync (via rsh or ssh). |
3384 |
Best choice for linux/unix. Good choice also for WinXX. |
Best choice for linux/unix. Good choice also for WinXX. |
3385 |
|
|
3386 |
- 'rsyncd': backup and restre via rsync daemon on the client. |
- 'rsyncd': backup and restore via rsync daemon on the client. |
3387 |
Best choice for linux/unix if you have rsyncd running on |
Best choice for linux/unix if you have rsyncd running on |
3388 |
the client. Good choice also for WinXX. |
the client. Good choice also for WinXX. |
3389 |
|
|
3867 |
WAN or dialup connections the round-trip time will be typically more |
WAN or dialup connections the round-trip time will be typically more |
3868 |
than 20msec. Tune if necessary. |
than 20msec. Tune if necessary. |
3869 |
|
|
3870 |
=item $Conf{ClientTimeout} = 7200; |
=item $Conf{ClientTimeout} = 72000; |
3871 |
|
|
3872 |
Timeout in seconds when listening for the transport program's |
Timeout in seconds when listening for the transport program's |
3873 |
(smbclient, tar etc) stdout. If no output is received during this |
(smbclient, tar etc) stdout. If no output is received during this |
4055 |
To: $user$domain |
To: $user$domain |
4056 |
cc: |
cc: |
4057 |
Subject: $subj |
Subject: $subj |
4058 |
|
$headers |
4059 |
Dear $userName, |
Dear $userName, |
4060 |
|
|
4061 |
This is a site-specific email message. |
This is a site-specific email message. |
4082 |
To: $user$domain |
To: $user$domain |
4083 |
cc: |
cc: |
4084 |
Subject: $subj |
Subject: $subj |
4085 |
|
$headers |
4086 |
Dear $userName, |
Dear $userName, |
4087 |
|
|
4088 |
This is a site-specific email message. |
This is a site-specific email message. |
4109 |
To: $user$domain |
To: $user$domain |
4110 |
cc: |
cc: |
4111 |
Subject: $subj |
Subject: $subj |
4112 |
|
$headers |
4113 |
Dear $userName, |
Dear $userName, |
4114 |
|
|
4115 |
This is a site-specific email message. |
This is a site-specific email message. |
4282 |
|
|
4283 |
=head1 Copyright |
=head1 Copyright |
4284 |
|
|
4285 |
Copyright (C) 2001-2004 Craig Barratt |
Copyright (C) 2001-2005 Craig Barratt |
4286 |
|
|
4287 |
=head1 Credits |
=head1 Credits |
4288 |
|
|