X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=bdaebc4865936ae315d1d659631862c51dbdffdb;hp=f10b0ea7438b4a974becba2a8fb152b1c82a792d;hb=dcda88860b03641b6900d43135ca769f005105e8;hpb=eb8857cfa2ceaa2635f14888b95d6f71b8def045 diff --git a/doc/installation.xml b/doc/installation.xml index f10b0ea..bdaebc4 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,33 +1,48 @@ - Installation - Zebra is written in ANSI C and was implemented with portability in mind. - We primarily use GNU C on UNIX and Microsoft Visual C++ on Windows. + &zebra; is written in &acro.ansi; C and was implemented with portability in mind. + We primarily use GCC on UNIX and + Microsoft Visual C++ on Windows. - The software is regularly tested on Debian GNU/Linux, Redhat Linux, - Gentoo Linux, NetBSD (Cobalt), FreeBSD (i386), SunOS 5.8 (sparc), - Windows 2000 SP3. + The software is regularly tested on + Debian GNU/Linux, + Red Hat Linux, + FreeBSD (i386), + MAC OSX, + Windows 7. - + - Zebra can be configured to use the following utilities (most of + &zebra; can be configured to use the following utilities (most of which are optional): - yaz (required) + &yaz; + (required) - Zebra uses YAZ to support Z39.50/SRW. Also the memory management - utilites from YAZ is used by Zebra. + &zebra; uses &yaz; to support &acro.z3950; / + &acro.sru;. + Zebra also uses a lot of other utilities (not related to networking), + such as memory management and XML support. + + + For the DOM XML + / ALVIS + record filters, &yaz; must be compiled with + Libxml2 + and + Libxslt + support and Libxml2 must be version 2.6.15 or later. - iconv + iconv (optional) @@ -38,93 +53,81 @@ - Expat + Expat (optional) - XML parser. If you're going to index real XML you should + &acro.xml; parser. If you're going to index real &acro.xml; you should install this (filter grs.xml). On most systems you should be able to find binary Expat packages. - - - Perl (optional) - - - Perl is required if you're going to use the Zebra perl - filter facility or the Zebra perl API. Perl is preinstalled - on many Unixes. We've not tried the Perl extension on - Windows ourselves. - - - - + - Tcl (optional) + Tcl (optional) Tcl is required if you need to use the Tcl record filter - for Zebra. You can find binary packages for Tcl for many + for &zebra;. You can find binary packages for Tcl for many Unices and Windows. - + - Autoconf, - Automake + Autoconf, + Automake (optional) GNU Automake and Autoconf are only required if you're - using the CVS version of Zebra. You do not need these - if you have fetched a Zebra tar. + using the CVS version of &zebra;. You do not need these + if you have fetched a &zebra; tar. - + - Docbook + Docbook and friends (optional) These tools are only required if you're writing - Documentation for Zebra. You need the following - Debian packages: jadetex, docbook, docbook-dsssl, - docbook-xml, docbook-utils. + documentation for &zebra;. You need the following + Debian packages: docbook, docbook-xml, docbook-xsl, + docbook-utils, xsltproc. - UNIX +
UNIX - On Unix, gcc works fine, but any native - C compiler should be possible to use as long as it is - ANSI C compliant. + On Unix, GCC works fine, but any native + C compiler should be possible to use as long as it is + &acro.ansi; C compliant. - + Unpack the distribution archive. The configure shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses those values to create a Makefile in each - directory of Zebra. + directory of &zebra;. - + To run the configure script type: - + ./configure - + - + The configure script attempts to use C compiler specified by the CC environment variable. @@ -132,7 +135,7 @@ The CFLAGS environment variable holds options to be passed to the C compiler. If you're using a Bourne-shell compatible shell you may pass something like this: - + CC=/opt/ccs/bin/cc CFLAGS=-O ./configure @@ -144,7 +147,7 @@ ./configure --help - + Once the build environment is configured, build the software by typing: @@ -152,50 +155,325 @@ make - + If the build is successful, two executables are created in the sub-directory index: - + zebrasrv - The Z39.50 server and search engine. + The &acro.z3950; server and search engine. - zebraidx + zebraidx The administrative indexing tool. + + + index/*.so + + + The .so-files are &zebra; record filter modules. + There are modules for reading + &acro.marc; (mod-grs-marc.so), + &acro.xml; (mod-grs-xml.so) , etc. + + + + - + + + + Using configure option --disable-shared builds + &zebra; statically and links "in" &zebra; filter code statically, i.e. + no .so-files are generated + + + - You can now use Zebra. If you wish to install it system-wide, then + You can now use &zebra;. If you wish to install it system-wide, then as root type make install - By default this will install the Zebra executables in + By default this will install the &zebra; executables in /usr/local/bin, - and the standard configuration files in - /usr/local/share/idzebra + and the standard configuration files in + /usr/local/share/idzebra-2.0. If + shared modules are built, these are installed in + /usr/local/lib/idzebra-2.0/modules. You can override this with the --prefix option to configure. - - WIN32 +
+ +
GNU/Debian +
GNU/Debian Linux on + amd64/i386 Platform + + Index Data provides pre-compiled GNU/Debian and Ubuntu packages + at our Debian package archive, both for recent releases. + + + + For Debian, refer to + + for how to configure APT. For Ubuntu, refer to + . + After refreshing the package cache with the command + + apt-get update + + as root, the + &zebra; indexer is + easily installed issuing + + apt-get install idzebra-2.0 idzebra-2.0-doc + + +
+ +
+ GNU/Debian and Ubuntu on other architectures + + These &zebra; + packages are specifically compiled for + GNU/Debian Linux systems and Ubuntu. Installation on other + GNU/Debian systems is possible by + re-compilation the Debian way: you need to add only the + deb-src sources lines to the + /etc/apt/sources.list configuration file, + After refreshing the package cache with the command + + apt-get update + apt-get build-dep idzebra-2.0 + + as root, the + &zebra; indexer is + recompiled and installed issuing + + fakeroot apt-get source --compile idzebra-2.0 + + as normal user. + The compiled GNU/Debian packages can then be + installed as root issuing + + dpkg -i install idzebra-2.0*.deb libidzebra-2.0*.deb + + +
+
+ +
Windows + The easiest way to install &zebra; on Windows is by downloading + an installer from + here. + The installer comes with source too - in case you wish to + compile &zebra; with different Compiler options. + + - [to be written] + &zebra; is shipped with "makefiles" for the NMAKE tool that comes + with Microsoft Visual C++. + Version 2013 has been tested. - + + Start a command prompt and switch the sub directory + WIN where the file makefile + is located. Customize the installation by editing the + makefile file (for example by using notepad). + + The following summarizes the most important settings in that file: + + + DEBUG + + If set to 1, the software is + compiled with debugging libraries (code generation is + multi-threaded debug DLL). + If set to 0, the software is compiled with release libraries + (code generation is multi-threaded DLL). + + + + + YAZDIR + + Directory of &yaz; source. &zebra;'s makefile expects to find + YAZ.lib, YAZ.dll + in yazdir/lib and + yazdir/bin respectively. + + + + + + HAVE_EXPAT, + EXPAT_DIR + + If HAVE_EXPAT is set to 1, &zebra; is compiled + with Expat support. + In this configuration, set + ZEBRA_DIR to the Expat source directory. + Windows version of Expat can be downloaded from + SourceForge. + + + + + BZIP2INCLUDE, + BZIP2LIB, + BZIP2DEF + + + Define these symbols if &zebra; is to be compiled with + BZIP2 record compression support. + + + + + + + + The DEBUG setting in the makefile for &zebra; must + be set to the same value as DEBUG setting in the + makefile for &yaz;. + If not, the &zebra; server/indexer will crash. + + + + When satisfied with the settings in the makefile, type + + nmake + + + + + If the nmake command is not found on your system + you probably haven't defined the environment variables required to + use that tool. To fix that, find and run the batch file + vcvars32.bat. You need to run it from within + the command prompt or set the environment variables "globally"; + otherwise it doesn't work. + + + + If you wish to recompile &zebra; - for example if you modify + settings in the makefile you can delete + object files, etc by running. + + nmake clean + + + + The following files are generated upon successful compilation: + + + bin/zebraidx.exe + + The &zebra; indexer. + + + bin/zebrasrv.exe + + The &zebra; server. + + + + + +
+ + +
+ Upgrading from &zebra; version 1.3.x + + &zebra;'s installation directories have changed a bit. In addition, + the new loadable modules must be defined in the + master zebra.cfg configuration file. The old + version 1.3.x configuration options + + # profilePath - where to look for config files + profilePath: some/local/path:/usr/share/idzebra/tab + + must be changed to + + # profilePath - where to look for config files + profilePath: some/local/path:/usr/share/idzebra-2.0/tab + + # modulePath - where to look for loadable zebra modules + modulePath: /usr/lib/idzebra-2.0/modules + + + + + The internal binary register structures have changed; all &zebra; + databases must be re-indexed after upgrade. + + + + The attribute set definition files may no longer contain + redirection to other fields. + For example the following snippet of + a custom custom/bib1.att + &acro.bib1; attribute set definition file is no + longer supported: + + att 1016 Any 1016,4,1005,62 + + and should be changed to + + att 1016 Any + + + + Similar behaviour can be expressed in the new release by defining + a new index Any:w in all &acro.grs1; + *.abs record indexing configuration files. + The above example configuration needs to make the changes + from version 1.3.x indexing instructions + + xelm /*/alternative Body-of-text:w,Title:s,Title:w + xelm /*/title Body-of-text:w,Title:s,Title:w + + to version 2.0.0 indexing instructions + + xelm /*/alternative Any:w,Body-of-text:w,Title:s,Title:w + xelm /*/title Any:w,Body-of-text:w,Title:s,Title:w + + + + It is also possible to map the numerical attribute value + @attr 1=1016 onto another already existing huge + index, in this example, one could for example use the mapping + + att 1016 Body-of-text + + with equivalent outcome without editing all &acro.grs1; + *.abs record indexing configuration files. + + + + Server installations which use the special + &acro.idxpath; attribute set must add the following + line to the zebra.cfg configuration file: + + attset: idxpath.att + + +
+