NAME

Dezi::Tutorial - getting started with the Dezi search platform

Installation

Install the Dezi server from CPAN:

 % cpan -i Dezi
 

Install the Dezi client from CPAN:

 % cpan -i Dezi::Client

Beginner

Start the Dezi server:

 % dezi &

Add a small test document to the index:

 % echo '<doc><title>bar</title>hello world</doc>' > test.xml
 % dezi-client test.xml

Search the index to confirm your test document worked:

 % dezi-client -q bar
 

Intermediate

Index your document collection with the swish3 command that comes with SWISH::Prog (one of the Dezi dependencies).

 % swish3 -c path/to/swish.conf -F lucy -f path/to/index -i path/to/docs

Start the Dezi server, using a custom config pointing to the index you just created:

 % cat myconfig.pl
 my $conf = {
    engine_config => {
        # name of the index(es)
        index => [qw( path/to/index )],
    }
 };
 
 % dezi --dezi-config myconfig.pl &

Search the index containing text from path/to/docs.

 % dezi-client -q 'some words'
 

Advanced

Write your own client application. See Dezi::Client and the bin/dezi-client script for examples.

See the t/example-config.pl file in the Dezi distribution for a full example configuration file.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-dezi at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find this documentation with the perldoc command.

    perldoc Dezi::Tutorial

You can also look for information at:

• Website

  http://dezi.org/

• IRC

  #dezisearch at freenode

• Mailing list

  https://groups.google.com/forum/#!forum/dezi-search

• RT: CPAN's request tracker

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dezi

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Dezi

• CPAN Ratings

  http://cpanratings.perl.org/d/Dezi

• Search CPAN

  http://search.cpan.org/dist/Dezi/

COPYRIGHT & LICENSE

Copyright 2011 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

SEE ALSO

Search::OpenSearch, SWISH::3, SWISH::Prog::Lucy, Plack, Lucy

cpanm Dezi

perl -MCPAN -e shell
install Dezi