/[BackupPC]/trunk/doc/Search.pod

This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!

Diff of /trunk/doc/Search.pod

Parent Directory | Revision Log | View Patch Patch

-trunk/doc/Search.pm
revision 96 by dpavlin,
Tue Aug 30 09:55:43 2005 UTC
+trunk/doc/Search.pod
revision 303 by dpavlin,
Sat Jan 28 16:45:46 2006 UTC
 Line 16 
 see state of one or all of your shares i
  =item *
  archive selected backups (per host, share and increment) to archival
- medium (CD, DVD, tape etc.)
+ medium (CD, DVD, tape etc.) with rich descriptions, archival locations,
+ multiple copies and so on.
  =back
  =head2 Requirements
- This extension is based on PostgreSQL RDBMS and HyperEstraier full-text
+ This extension is based on PostgreSQL RDBMS and Hyper Estraier full-text
  search engine (and it's perl bindings).
  If you are using Debian, you are in luck. All required packages are
-Line 31 
 allready part of C<unstable> distributio
+Line 32 
 allready part of C<unstable> distributio
    # apt-get install postgresql
    # apt-get install hyperestraier libestraier-dev libqdbm-dev
- Now you can skip to installation of HyperEstraier perl bindings below.
+ Now you can skip to installation of L<Hyper Estraier perl bindings> below.
  If you don't have pre-packaged binaries for your installation, you will
  need to install additional packages by hand.
- =over 4
+ =head3 PostgreSQL
- =item PostgreSQL installation
  You can use packages provided by your distribution or follow installation
  instructions on PostgreSQL site.
- =item QDBM installation
+ =head3 QDBM
- First, you need qdbm on which HyperEstraier depends. Installation is simple.
+ First, you need qdbm on which Hyper Estraier depends. Installation is simple.
    $ tar xvfz qdbm-1.8.31.tar.gz
    $ cd qdbm-1.8.31
-Line 53 
 First, you need qdbm on which HyperEstra
+Line 52 
 First, you need qdbm on which HyperEstra
    $ make
    $ sudo make install
- =item HyperEstraier installation
+ =head3 Hyper Estraier
  Also quite simple.
-Line 63 
 Also quite simple.
+Line 62 
 Also quite simple.
    $ make
    $ sudo make install
- Then you will have to install perl bindings for HyperEstraier. This might take
+ Then you will have to install perl bindings for Hyper Estraier.
- a bit more work. You will need to have C<swig> installed beforehand.
-   $ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz
+ =head3 Hyper Estraier perl bindings
-   $ cd swig_hest/perl/
-   $ swig -c++ -perl5 -o HyperEstraier_wrap.cpp  ../HyperEstraier.i
-   $ cp ../HyperEstraierWrapper.cpp ./
-   $ perl Makefile.PL
- You might need to remove C<estconfig --mtlibs> from C<Makefile.PL> if it
- fails to run with following message:
-  Unrecognized argument in LIBS ignored: 'configuration'
-  Unrecognized argument in LIBS ignored: 'helper'
-  Unrecognized argument in LIBS ignored: 'for'
-  Unrecognized argument in LIBS ignored: 'Hyper'
-  Unrecognized argument in LIBS ignored: 'Estraier'
-  Writing Makefile for HyperEstraier
- Working C<Makefile.PL> for my particular installation is:
-  # File : Makefile.PL
-  use ExtUtils::MakeMaker;
-  WriteMakefile(
-         NAME    => 'HyperEstraier',
-         INC     => sprintf('%s', `pkg-config --cflags hyperestraier`),
-         LIBS    => [sprintf('-lstdc++ %s %s' , `pkg-config --libs hyperestraier`)],
-         OBJECT  => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
-  );
- After succesfull C<perl Makefile.pl>, you can compile and install it.
+ Just use C<cpan> shell to install C<Search::Estraier> module
-   $ make
+   $ sudo cpan Search::Estraier
-   $ sudo make install
+ There was awaful long procedure about installing perl C bindings, but it's all gone now.
+ =head3 CPAN modules
+ You will also need a few additional cpan modules
+ =over 4
+ =item File::Pid
+ =item File::Which
+ =item File::Path
+ =item File::Slurp
+ =item Search::Estraier
+ =item Spreadsheet::WriteExcel
+ =item Term::Menus
+ =item XML::Writer
+ =item Algorithm::Diff
+ =item Archive::Tar::Stream
  =back
- =head1 Creation of initial data
+ Last module, C<Spreadsheet::WriteExcel> is needed only if you want to use
+ C<BackupPC_xls_report> to generate Excel reports from your backup data.
+ Easiest way to install them is using C<cpan> shell.
+   $ sudo cpan File::Pid Spreadsheet::WriteExcel ...
+ =head1 Creation of initial database
  Once you have all components installed, you should initially create data
  about increments in RDBMS and full-text search engine index.
-   $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb
+ First, edit C<config.pl> and setup C<SearchDSN> to valid perl DSN (for example,
+ C<dbi:Pg:dbname=backuppc> and C<SearchUser> to database user which has priviledges
+ over that database. You might need to add additional directives in PostgreSQL's
+ C<pg_hba.conf> so that selected user can be connected without password (I know, it's not
+ perfect, but I trust local users on backuppc machine).
+ Then, create new database for backuppc.
+   $ createdb backuppc
+ Then invoke C<BackupPC_updatedb> for the first time with argument to create database
+ schema:
+   $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb -c
- You can also force full-text reindex by C<-i> flag.
+ You can also force full-text reindex by C<-i> flag. This will add all files which are in
+ database but for some reason are missing in full-text index.
- B<Documentation is incomplete>.
+ Now, you can setup cron job which will daily check your backups and update database
+ and full-text index. This is as simple as invoking
+   /data/backuppc/bin/BackupPC_updatedb
+ As C<backuppc> user and redirecting output to log file.
+ B<Documentation is still incomplete>.
  Now that you finished installation, you can select new options from
  menu on the left and example search and archival.
+ =head1 Reporting in Excel
+ Often, it is useful to be able to present report about your BackupPC hosts, number
+ of snapshots, total size and other useful info. While all those information can
+ be accessed using web browser, for analysis it's useful to have them in spreadsheet
+ form. With this data, you can monitor changes on your backup cycle, effects of changes
+ on your server or network to your BackupPC installation and so on.
+ You can create Excel spreadsheet (which works perfectly with Gnumeric also) using
+ following command:
+   $ sudo -u backuppc /data/backuppc/bin/BackupPC_xls_report
+ =head1 Additional requirements
+ You will also need several other command-line utilities to make
+ C<BackupPC_burnArchiveCLI> run. Those include:
+ =over 4
+ =item mkisofs
+ =item cdrecord
+ Or equivavalent utility, on Debian you might want to use C<dvdrecord>.
+ =item eject
+ Please make a symlink from C</dev/cdrom> to you CD/DVD burner.
+ =item split
+ =back
+ =head1 Troubleshoting
+ =head2 md5sum problems on Debian
+ If you are running Debian stable and expiriencing error message like
+  -: No such file or directory
+ your C<md5sum> comes from C<coreutils> (which doesn't know how to handle C<->
+ as input) as opposed to C<md5sum> which comes with C<textutils> (which does).
+ Fix is simple, correct md5sum is allready installed, you just have to do:
+  sudo cp /usr/bin/md5sum.textutils /usr/bin/md5sum
  =head1 Related projects
  BackupPC allready has archival host which might suit your needs better (and

 Legend:



Removed from v.96
 


changed lines


 
Added in v.303
 Legend:



Removed from v.96
 


changed lines


 
Added in v.303
-Removed from v.96
+Added in v.303

	ViewVC Help
Powered by ViewVC 1.1.26