Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
Note this comment from upstream author: ! The documentation fix applies just to the Debian package. ! The virgin BackupPC release does in fact put the per-pc ! config files (assuming FHS) in /etc/BackupPC/pc/HOST.pl. Why was it decided to do this differently for Debian? Backwards compatibility with previous Debian versions maybe? Cheers, FJP signature.asc Description: This is a digitally signed message part.
Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
Le mardi 04 septembre 2007 15:54, Frans Pop a écrit : Why was it decided to do this differently for Debian? Backwards compatibility with previous Debian versions maybe? Yes, 2 reasons: 1- the debian package 1st introduced the config files in /etc (before they were found in /var/lib/backuppc) 2- directories in /etc should have the same name as the package so /etc/backuppc is used and not /etc/BackupPC. Cheers, -- Ludovic Drolez. http://zaurus.palmopensource.com- The Zaurus Open Source Portal http://www.drolez.com - Personal site - Linux and PalmOS stuff
Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
On Tuesday 04 September 2007, you wrote: Le mardi 04 septembre 2007 15:54, Frans Pop a écrit : Why was it decided to do this differently for Debian? Backwards compatibility with previous Debian versions maybe? Yes, 2 reasons: I've reversed your reasons for clarity of my arguments. 2- directories in /etc should have the same name as the package so /etc/backuppc is used and not /etc/BackupPC. I completely agree with this. We could try to convince upstream to change this, but if not it should be relatively trivial to maintain a patch for debian. The only disadvantage is that Debian users who read the upstream documentation may be slightly confused. Note that after my patch there is still some slightly confusing info in the documentation: ! Starting with BackupPC 3.0.0, the configure.pl script by default complies ! with the file system hierarchy conventions. The major difference compared ! to earlier versions is that by default configuration files will be ! stored in /etc/BackupPC rather than below the data directory, ! /var/lib/backuppc/conf, and the log files will be stored in ! /var/log/BackupPC. rather than below the data directory, ! /var/lib/backuppc/log. 1. s:/etc/BackupPC:/etc/backuppc: 2. For Debian the logfiles are still in /var/lib/backuppc/log. However, it could be argued that this para describes the default upstream configuration and not the Debianized configuration (but then it should really be 2 times s:/var/lib/backuppc/:/var/lib/BackupPC/:). Maybe a short para could be added to the beginning of Step 2 that most of the info is irrelevant if you use a package from a distribution? Hmm. That could even be done upstream. Why did you not move the main log files under /var/log/? I can see that it would require some patching to leave the other files in that dir in their current location and also the compression and rotation are not really standard... There is also a problem with this bit: ! Config and Log directories ! In this installation the configuration and log directories are located ! in the following locations: !/etc/backuppc/config.plmain config file !/etc/backuppc/hostshosts file !/etc/backuppc/pc/HOST.pl per-pc config file !/BackupPC log files, pid, status 1. The last line uses __LOGDIR__/BackupPC. Apparently __LOGDIR__ is not set. 2. The pid file is not in the same location as the other files. If you like I can work on patches for this chapter to solve/clarify these issues. 1- the debian package 1st introduced the config files in /etc (before they were found in /var/lib/backuppc) OK. However, now that upstream has made the switch, I wonder if it would not make sense to have the per-host config files in a ./pc/ subdir for Debian as well. The rationale would be: - reduce (unnecessary) differences with upstream - avoid clutter in /etc/backuppc so that the main configuration files remain more visible (especially with large number of hosts!) - theoretically allow for the existence of a host named config without conflicting with the general config.pl file (currently there are other issues in the code that will not allow that, but those could be fixed upstream) IMO it should be relatively easy to either - automatically move existing host config files to the ./pc/ subdir when they are first accessed - use ./pc/$host as default location, but fall back to ./$host if that does not exist and print a log message suggesting that they be moved, leaving it to the admin to do so If you like I can probably come up with a patch for the option you prefer. In both cases the change should of course be documented in README.Debian. Cheers, FJP P.S. I've already submitted a fairly invasive proposal upstream and I like BackupPC enough that I'm willing to spend some time on it. signature.asc Description: This is a digitally signed message part.
Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
Why did you not move the main log files under /var/log/? In fact old backuppc logs are compressed using a non-standard program. So they can be read only from the web interface. All logs under /var/log are usually readable with view, zcat, zless, so if backuppc logs were put there, I think I would have received lots of bug reports saying I cannot read the logs. Cheers, -- Ludovic Drolez. http://zaurus.palmopensource.com- The Zaurus Open Source Portal http://www.drolez.com - Personal site - Linux and PalmOS stuff -- To UNSUBSCRIBE, email to [EMAIL PROTECTED] with a subject of unsubscribe. Trouble? Contact [EMAIL PROTECTED]
Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
tags 436793 + patch
thanks
The attached patch should fix this issue.
Cheers,
FJP
diff --git a/doc/BackupPC.html b/doc/BackupPC.html
index ca0dd67..fd8a0fc 100644
--- a/doc/BackupPC.html
+++ b/doc/BackupPC.html
@@ -785,7 +785,7 @@ located in the following locations:/p
pre
__CONFDIR__/config.plmain config file
__CONFDIR__/hostshosts file
-__CONFDIR__/pc/HOST.pl per-pc config file
+__CONFDIR__/HOST.pl per-pc config file
__LOGDIR__/BackupPC log files, pid, status/pre
/dd
dd
@@ -1007,7 +1007,7 @@ here you must make sure this file is not world (other) readable./p
/li
li
pAs a configuration variable a href=#item__conf_smbsharepasswd_$Conf{SmbSharePasswd}/A in the per-PC
-configuration file (__CONFDIR__/pc/$host.pl or
+configuration file (__CONFDIR__/$host.pl or
__TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC).
You will have to use this option if the smb share password is different
for each host. If you put the password here you must make sure this file
@@ -2239,9 +2239,9 @@ below for more details./p
dtstronga name=item_pcpc/a/strong
dd
-pThe directory __CONFDIR__/pc contains per-client configuration files
+pThe directory __CONFDIR__ contains per-client configuration files
that override settings in the main configuration file. Each file
-is named __CONFDIR__/pc/HOST.pl, where HOST is the host name./p
+is named __CONFDIR__/HOST.pl, where HOST is the host name./p
/dd
dd
pIn pre-FHS versions of BackupPC these files were located in
@@ -2474,7 +2474,7 @@ to the backup or restore number.)/p
pOld location of optional configuration settings specific to this host.
Settings in this file override the main configuration file.
In new versions of BackupPC the per-host configuration files are
-stored in __CONFDIR__/pc/HOST.pl./p
+stored in __CONFDIR__/HOST.pl./p
/dd
/li
dtstronga name=item_backupsbackups/a/strong
@@ -2933,7 +2933,7 @@ discussion of some of various security issues./p
hr /
h1a name=configuration_fileConfiguration File/a/h1
pThe BackupPC configuration file resides in __CONFDIR__/config.pl.
-Optional per-PC configuration files reside in __CONFDIR__/pc/$host.pl
+Optional per-PC configuration files reside in __CONFDIR__/$host.pl
(or __TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC).
This file can be used to override settings just for a particular PC./p
p
@@ -2965,7 +2965,7 @@ wakeup period./p
LOG file, so you can tail it (or view it via the CGI interface) to make
sure your kill -HUP worked. Errors in parsing the configuration file are
also reported in the LOG file./p
-pThe optional per-PC configuration file (__CONFDIR__/pc/$host.pl or
+pThe optional per-PC configuration file (__CONFDIR__/$host.pl or
__TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC)
is read whenever it is needed by BackupPC_dump, BackupPC_link and others./p
p
diff --git a/doc/BackupPC.pod b/doc/BackupPC.pod
index 609ee1e..da9857e 100644
--- a/doc/BackupPC.pod
+++ b/doc/BackupPC.pod
@@ -644,7 +644,7 @@ located in the following locations:
__CONFDIR__/config.plmain config file
__CONFDIR__/hostshosts file
-__CONFDIR__/pc/HOST.pl per-pc config file
+__CONFDIR__/HOST.pl per-pc config file
__LOGDIR__/BackupPC log files, pid, status
The configure.pl script doesn't prompt for these locations but
@@ -859,7 +859,7 @@ here you must make sure this file is not world (other) readable.
=item *
As a configuration variable $Conf{SmbSharePasswd} in the per-PC
-configuration file (__CONFDIR__/pc/$host.pl or
+configuration file (__CONFDIR__/$host.pl or
__TOPDIR__/pc/$host/config.pl in non-FHS versions of BackupPC).
You will have to use this option if the smb share password is different
for each host. If you put the password here you must make sure this file
@@ -2055,9 +2055,9 @@ Hosts file, which lists all the PCs to backup.
=item pc
-The directory __CONFDIR__/pc contains per-client configuration files
+The directory __CONFDIR__ contains per-client configuration files
that override settings in the main configuration file. Each file
-is named __CONFDIR__/pc/HOST.pl, where HOST is the host name.
+is named __CONFDIR__/HOST.pl, where HOST is the host name.
In pre-FHS versions of BackupPC these files were located in
__TOPDIR__/pc/HOST/config.pl.
@@ -2244,7 +2244,7 @@ to the backup or restore number.)
Old location of optional configuration settings specific to this host.
Settings in this file override the main configuration file.
In new versions of BackupPC the per-host configuration files are
-stored in __CONFDIR__/pc/HOST.pl.
+stored in __CONFDIR__/HOST.pl.
=item backups
@@ -2656,7 +2656,7 @@ discussion of some of various security issues.
=head1 Configuration File
The BackupPC configuration file resides in __CONFDIR__/config.pl.
-Optional per-PC configuration files reside in __CONFDIR__/pc/$host.pl
+Optional per-PC configuration files reside in __CONFDIR__/$host.pl
(or
Bug#436793: backuppc: Error in documentation regarding per-pc configuration files
Package: backuppc Version: 3.0.0-3 Severity: minor The documentation mentions several times that the new location of the per-pc configuration file is now: /etc/backuppc/pc/host.pl. This is _not_ correct. It should be: /etc/backuppc/host.pl (i.e. without the pc subdirectory). -- System Information: Debian Release: 4.0 APT prefers stable APT policy: (500, 'stable') Architecture: i386 (i686) Shell: /bin/sh linked to /bin/bash Kernel: Linux 2.6.18-4-686 Locale: LANG=en_US, LC_CTYPE=en_US (charmap=ISO-8859-1) Versions of packages backuppc depends on: ii adduser3.102 Add and remove users and groups ii apache22.2.3-4 Next generation, scalable, extenda ii apache2-mpm-worker [httpd] 2.2.3-4 High speed threaded model for Apac ii bzip2 1.0.3-6 high-quality block-sorting file co ii debconf [debconf-2.0] 1.5.11Debian configuration management sy ii dpkg 1.13.25 package maintenance system for Deb ii exim4 4.63-17 metapackage to ease exim MTA (v4) ii exim4-daemon-light [mail-t 4.63-17 lightweight exim MTA (v4) daemon ii libarchive-zip-perl1.16-1Module for manipulation of ZIP arc ii libcompress-zlib-perl 1.42-2Perl module for creation and manip ii perl [libdigest-md5-perl] 5.8.8-7 Larry Wall's Practical Extraction ii perl-suid 5.8.8-7 Runs setuid Perl scripts ii samba-common 3.0.24-6etch4 Samba common files used by both th ii smbclient 3.0.24-6etch4 a LanManager-like simple client fo ii tar1.16-2GNU tar ii wwwconfig-common 0.0.48Debian web auto configuration backuppc recommends no packages. -- debconf information excluded -- To UNSUBSCRIBE, email to [EMAIL PROTECTED] with a subject of unsubscribe. Trouble? Contact [EMAIL PROTECTED]
