1 =head1 BackupPC search and archival extension
3 BackupPC search and archival extension is used to:
9 find files in C<pool> by substring of filename
13 see state of one or all of your shares in some particular point in time
14 (file creation date on clients or backup date is supported as filter)
18 archive selected backups (per host, share and increment) to archival
19 medium (CD, DVD, tape etc.) with rich descriptions, archival locations,
20 multiple copies and so on.
26 This extension is based on PostgreSQL RDBMS and Hyper Estraier full-text
27 search engine (and it's perl bindings).
29 If you are using Debian, you are in luck. All required packages are
30 allready part of C<unstable> distribution and can be installed with:
32 # apt-get install postgresql
33 # apt-get install hyperestraier libestraier-dev libqdbm-dev
35 Now you can skip to installation of L<Hyper Estraier perl bindings> below.
37 If you don't have pre-packaged binaries for your installation, you will
38 need to install additional packages by hand.
42 You can use packages provided by your distribution or follow installation
43 instructions on PostgreSQL site.
47 First, you need qdbm on which Hyper Estraier depends. Installation is simple.
49 $ tar xvfz qdbm-1.8.31.tar.gz
51 $ ./configure --enable-zlib
59 $ tar xvfz hyperestraier-0.5.4.tar.gz
60 $ cd hyperestraier-0.5.4
65 Then you will have to install perl bindings for Hyper Estraier.
67 =head3 Hyper Estraier perl bindings
69 Just use C<cpan> shell to install C<Search::Estraier> module
71 $ sudo cpan Search::Estraier
73 There was awaful long procedure about installing perl C bindings, but it's all gone now.
77 You will also need a few additional cpan modules
85 =item Search::Estraier
87 =item Spreadsheet::WriteExcel
92 =item Archive::Tar::Stream
96 Last module, C<Spreadsheet::WriteExcel> is needed only if you want to use
97 C<BackupPC_xls_report> to generate Excel reports from your backup data.
99 Easiest way to install them is using C<cpan> shell.
101 $ sudo cpan File::Pid Spreadsheet::WriteExcel ...
103 =head1 Creation of initial database
105 Once you have all components installed, you should initially create data
106 about increments in RDBMS and full-text search engine index.
108 First, edit C<config.pl> and setup C<SearchDSN> to valid perl DSN (for example,
109 C<dbi:Pg:dbname=backuppc> and C<SearchUser> to database user which has priviledges
110 over that database. You might need to add additional directives in PostgreSQL's
111 C<pg_hba.conf> so that selected user can be connected without password (I know, it's not
112 perfect, but I trust local users on backuppc machine).
114 Then, create new database for backuppc.
118 Then invoke C<BackupPC_updatedb> for the first time with argument to create database
121 $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb -c
123 You can also force full-text reindex by C<-i> flag. This will add all files which are in
124 database but for some reason are missing in full-text index.
126 Now, you can setup cron job which will daily check your backups and update database
127 and full-text index. This is as simple as invoking
129 /data/backuppc/bin/BackupPC_updatedb
131 As C<backuppc> user and redirecting output to log file.
133 B<Documentation is still incomplete>.
135 Now that you finished installation, you can select new options from
136 menu on the left and example search and archival.
138 =head1 Reporting in Excel
140 Often, it is useful to be able to present report about your BackupPC hosts, number
141 of snapshots, total size and other useful info. While all those information can
142 be accessed using web browser, for analysis it's useful to have them in spreadsheet
143 form. With this data, you can monitor changes on your backup cycle, effects of changes
144 on your server or network to your BackupPC installation and so on.
146 You can create Excel spreadsheet (which works perfectly with Gnumeric also) using
149 $ sudo -u backuppc /data/backuppc/bin/BackupPC_xls_report
151 =head1 Additional requirements
153 You will also need several other command-line utilities to make
154 C<BackupPC_burnArchiveCLI> run. Those include:
162 Or equivavalent utility, on Debian you might want to use C<dvdrecord>.
166 Please make a symlink from C</dev/cdrom> to you CD/DVD burner.
172 =head1 Troubleshoting
174 =head2 md5sum problems on Debian
176 If you are running Debian stable and expiriencing error message like
178 -: No such file or directory
180 your C<md5sum> comes from C<coreutils> (which doesn't know how to handle C<->
181 as input) as opposed to C<md5sum> which comes with C<textutils> (which does).
183 Fix is simple, correct md5sum is allready installed, you just have to do:
185 sudo cp /usr/bin/md5sum.textutils /usr/bin/md5sum
187 =head1 Related projects
189 BackupPC allready has archival host which might suit your needs better (and
190 it's quite easier to install).
196 L<http://www.postgresql.org/>
200 L<http://hyperestraier.sourceforge.net/>
206 Ivan Klaric C<< <iklaric@gmail.com> >>
208 Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
212 This extension is released under GPL licence, same as BackupPC.