/[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!
ViewVC logotype

Diff of /trunk/doc/Search.pod

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 94 by dpavlin, Sun Aug 28 18:29:44 2005 UTC revision 204 by dpavlin, Fri Oct 14 16:46:33 2005 UTC
# Line 16  see state of one or all of your shares i Line 16  see state of one or all of your shares i
16  =item *  =item *
17    
18  archive selected backups (per host, share and increment) to archival  archive selected backups (per host, share and increment) to archival
19  medium (CD, DVD, tape etc.)  medium (CD, DVD, tape etc.) with rich descriptions, archival locations,
20    multiple copies and so on.
21    
22  =back  =back
23    
# Line 25  medium (CD, DVD, tape etc.) Line 26  medium (CD, DVD, tape etc.)
26  This extension is based on PostgreSQL RDBMS and HyperEstraier full-text  This extension is based on PostgreSQL RDBMS and HyperEstraier full-text
27  search engine (and it's perl bindings).  search engine (and it's perl bindings).
28    
29  So, you will need to install additional packages which is described in  If you are using Debian, you are in luck. All required packages are
30  following procedure.  allready part of C<unstable> distribution and can be installed with:
31    
32  =over 4    # apt-get install postgresql
33      # apt-get install hyperestraier libestraier-dev libqdbm-dev
34    
35    Now you can skip to installation of L<HyperEstraier perl bindings> below.
36    
37    If you don't have pre-packaged binaries for your installation, you will
38    need to install additional packages by hand.
39    
40  =item PostgreSQL installation  =head3 PostgreSQL
41    
42  You can use packages provided by your distribution or follow installation  You can use packages provided by your distribution or follow installation
43  instructions on PostgreSQL site.  instructions on PostgreSQL site.
44    
45  =item QDBM installation  =head3 QDBM
46    
47  First, you need qdbm on which HyperEstraier depends. Installation is simple.  First, you need qdbm on which HyperEstraier depends. Installation is simple.
48    
# Line 45  First, you need qdbm on which HyperEstra Line 52  First, you need qdbm on which HyperEstra
52    $ make    $ make
53    $ sudo make install    $ sudo make install
54    
55  =item HyperEstraier installation  =head3 HyperEstraier
56    
57  Also quite simple.  Also quite simple.
58    
# Line 55  Also quite simple. Line 62  Also quite simple.
62    $ make    $ make
63    $ sudo make install    $ sudo make install
64    
65  Then you will have to install perl bindings for HyperEstraier. This might take  Then you will have to install perl bindings for HyperEstraier.
66  a bit more work. You will need to have C<swig> installed beforehand.  
67    =head3 HyperEstraier perl bindings
68    
69    This might take a bit more work. You will need to have C<swig> and C<g++> installed
70    before you can install perl bindings.
71    
72    $ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz    $ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz
73    $ cd swig_hest/perl/    $ cd swig_hest/perl/
# Line 80  Working C<Makefile.PL> for my particular Line 91  Working C<Makefile.PL> for my particular
91   use ExtUtils::MakeMaker;   use ExtUtils::MakeMaker;
92   WriteMakefile(   WriteMakefile(
93          NAME    => 'HyperEstraier',          NAME    => 'HyperEstraier',
94          LIBS    => [sprintf('-lstdc++ %s %s' , `estconfig --libs`)],          INC     => sprintf('%s', `pkg-config --cflags hyperestraier`),
95            LIBS    => [sprintf('-lstdc++ %s %s' , `pkg-config --libs hyperestraier`)],
96          OBJECT  => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'          OBJECT  => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
97   );   );
98    
# Line 89  After succesfull C<perl Makefile.pl>, yo Line 101  After succesfull C<perl Makefile.pl>, yo
101    $ make    $ make
102    $ sudo make install    $ sudo make install
103    
104    =head3 CPAN modules
105    
106    You will also need a few additional cpan modules
107    
108    =over 4
109    
110    =item File::Pid
111    
112    =item Spreadsheet::WriteExcel
113    
114    =item Term::Menus
115    =item XML::Writer
116    
117  =back  =back
118    
119  =head1 Creation of initial data  Last module, C<Spreadsheet::WriteExcel> is needed only if you want to use
120    C<BackupPC_xls_report> to generate Excel reports from your backup data.
121    
122    Easiest way to install them is using C<cpan> shell.
123    
124      $ sudo cpan File::Pid Spreadsheet::WriteExcel
125    
126    =head1 Creation of initial database
127    
128  Once you have all components installed, you should initially create data  Once you have all components installed, you should initially create data
129  about increments in RDBMS and full-text search engine index.  about increments in RDBMS and full-text search engine index.
130    
131    $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb  First, edit C<config.pl> and setup C<SearchDSN> to valid perl DSN (for example,
132    C<dbi:Pg:dbname=backuppc> and C<SearchUser> to database user which has priviledges
133    over that database. You might need to add additional directives in PostgreSQL's
134    C<pg_hba.conf> so that selected user can be connected without password (I know, it's not
135    perfect, but I trust local users on backuppc machine).
136    
137    Then, create new database for backuppc.
138    
139      $ createdb backuppc
140    
141    Then invoke C<BackupPC_updatedb> for the first time with argument to create database
142    schema:
143    
144      $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb -c
145    
146    You can also force full-text reindex by C<-i> flag. This will add all files which are in
147    database but for some reason are missing in full-text index.
148    
149  You can also force full-text reindex by C<-i> flag.  Now, you can setup cron job which will daily check your backups and update database
150    and full-text index. This is as simple as invoking
151    
152  B<Documentation is incomplete>.    /data/backuppc/bin/BackupPC_updatedb
153    
154    As C<backuppc> user and redirecting output to log file.
155    
156    B<Documentation is still incomplete>.
157    
158  Now that you finished installation, you can select new options from  Now that you finished installation, you can select new options from
159  menu on the left and example search and archival.  menu on the left and example search and archival.
160    
161    =head1 Reporting in Excel
162    
163    Often, it is useful to be able to present report about your BackupPC hosts, number
164    of snapshots, total size and other useful info. While all those information can
165    be accessed using web browser, for analysis it's useful to have them in spreadsheet
166    form. With this data, you can monitor changes on your backup cycle, effects of changes
167    on your server or network to your BackupPC installation and so on.
168    
169    You can create Excel spreadsheet (which works perfectly with Gnumeric also) using
170    following command:
171    
172      $ sudo -u backuppc /data/backuppc/bin/BackupPC_xls_report
173    
174    =head1 Additional requirements
175    
176    You will also need several other command-line utilities to make
177    C<BackupPC_burnArchiveCLI> run. Those include:
178    
179    =over 4
180    
181    =item mkisofs
182    
183    =item cdrecord
184    
185    Or equivavalent utility, on Debian you might want to use C<dvdrecord>.
186    
187    =item eject
188    
189    Please make a symlink from C</dev/cdrom> to you CD/DVD burner.
190    
191    =item split
192    
193    =back
194    
195    
196  =head1 Related projects  =head1 Related projects
197    
198  BackupPC allready has archival host which might suit your needs better (and  BackupPC allready has archival host which might suit your needs better (and
Legend:
Removed from v.94  
changed lines
  Added in v.204
  ViewVC Help
Powered by ViewVC 1.1.26