NAME

Alien::ElasticSearch - Downloads, builds and installs ElasticSearch from github

VERSION

Version 0.10

SYNOPSIS

    # install latest version from Git to $install_dir
    $install_dir = Alien::ElasticSearch->install(
        dir     => '/path/to/elasticsearch',
        version => '0.6.0',           # released version
      | tag     => 'master',          # or a git tag or sha1
        plugins => ['attachments'],
        user    => 'elasticsearch',   # unix/linux only
        group   => 'users',           # unix/linux only
        temp    => 1 | 0              # do installation, but don't store config
    );

    # upgrade existing installation
    $install_dir = Alien::ElasticSearch->upgrade(
        tag     => 'master'           # accepts same args as install()
    );

    # get/set current install dir
    $install_dir = Alien::ElasticSearch->install_dir($install_dir);

    # get/set current version
    $version = Alien::ElasticSearch->version($version);

    # get/set current plugins
    $plugins = Alien::ElasticSearch->plugins(\@plugin_names);

    # get/set current user
    $user = Alien::ElasticSearch->user($user);

    # get/set current group
    $group = Alien::ElasticSearch->group($group);

DESCRIPTION

This module handles downloading ElasticSearch from github, building, and installing it.

It then writes a config file to remember where it was installed.

It also adds a script called install_elasticsearch.pl into your perl bin directory, which can be called as follows:

    install_elasticsearch.pl              # upgrade existing installation
    install_elasticsearch.pl --dir /path  # install to /path

To see all available options, try:

    install_elasticsearch.pl --help

REQUIREMENTS

  • Java version 6 or above

SEE ALSO

ElasticSearch

AUTHOR

Clinton Gormley, <drtech at cpan.org>

BUGS

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

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Alien::ElasticSearch

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2010 Clinton Gormley.

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.