WORK IN PROGRESS

This package is still under development. This page will get more content as the package evolves.

Installation

Clone

cd ~/ark-core/plugins
git clone https://github.com/arkx-ecosystem/core-elasticsearch
lerna bootstrap

Registration

Open ~/.ark/config/plugins.js and append the following to the bottom of the object.

{
    '@arkx/core-elasticsearch': {}
}

Configuration

Arguments

  • client.host - The host under which the Elasticsearch instance is available
  • client.log - The log level used by the Elasticsearch instance
  • chunkSize - The number of records to process in bulk
  • server.host - The host under which the REST API will be available
  • server.port - The port under which the REST API will be available
  • server.whitelist - A list of IP addresses that can connect to the REST API

Defaults

module.exports = {
    server: {
        host: '0.0.0.0',
        port: 5001,
        whitelist: ['*']
    },
    client: {
        host: 'localhost:9200',
        log: 'info'
    },
    chunkSize: 5000
}