AvantElasticsearch

Provides support for Elasticsearch hosted on Amazon AWS.


Configuration options

AvantElasticsearch has these configuration options:

Contributor Id
Identification for this organization (3 to 6 lower case letters a-z)
Contributor
Organization name as it should be shown for the contributor of its data
Host
Example: search-something-xxxxxxxxxxxx.us-east-2.es.amazonaws.com
Region
AWS server region
Key
AWS Access Key Id
Secret
AWS Secret Access Key
Local Index
Enable local index
Shared Index
Enable shared index

See also the documentation for installing AvantElasticsearch.


Dependencies

The AvantElasticsearch plugin requires that the AvantCommon plugin be installed and activated.

This plugin was developed specifically for Digital Archive installations. It has special knowledge of the following Omeka elements and how they are used in these installations.

  • Type
  • Subject
  • Place
  • Address
  • Date

This AvantElaticsearch plugin works only with Elasticsearch on Amazon Web Services (AWS).

The host Linux OS must have pdftotext installed.

The Omeka files folder must contain a directory named elasticsearch.

Installation

To install the AvantElasticsearch plugin, follow these steps:

  1. First install and activate the AvantCommon plugin
  2. Download the latest release from https://github.com/gsoules/AvantElasticsearch
  3. Unzip AvantElasticsearch-master.zip into your Omeka plugins folder
  4. Rename the folder to AvantElasticsearch
  5. Activate the plugin from the Omeka Plugins page

Warning

Use this software at your own risk.

License

This plugin is published under [GNU/GPL].

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

  • Created by gsoules
  • Copyright George Soules, 2019-2020
  • See LICENSE for more information.

Credits

The author wishes to thank the Harvard Academic Technology Group at Harvard University, developers of the Elasticsearch v1.1.1 plugin for Omeka Classic. It provided helpful insight in how to integrate Elasticsearch with Omeka.