jenbuzz / ElasticsearchExplorerBundle

Elasticsearch status and search functionality as a Symfony 4 bundle

ElasticsearchExplorerBundle

Elasticsearch status and search functionality as a Symfony 4 bundle. This bundle uses the official elasticsearch-php client and the front-end framework Bootstrap.

Installation

Add the following snippet to your local projects composer.json file:

{
  "require": {
    "jenbuzz/elasticsearch-explorer-bundle": "dev-master"
  },
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/jenbuzz/ElasticsearchExplorerBundle.git"
    }
  ]
}

Add the ElasticsearchExplorerBundle to the bundles array in your local config/bundles.php file:

return [
  // ...

  Jenbuzz\ElasticsearchExplorerBundle\JenbuzzElasticsearchExplorerBundle::class => ['all' => true],
];

Add the following snippet to your local config/routes.yaml file:

jenbuzz_elasticsearch_explorer:
    resource: "@JenbuzzElasticsearchExplorerBundle/Resources/config/routing.yml"
    prefix:   /

Link to bundle assets to your Symfony installation by installing the assets using the following command:

php bin/console assets:install

Setup language by adding to following snippet to your local config/packages/framework.yaml file (or change the locale in translation.yaml):

framework:
    # ...
    translator: { fallbacks: [en] }
    # ...

Configuration

In Resources/config/elasticsearch.yml it is possible to configure to hostname of the Elasticsearch instance:

hosts: "localhost:9200"

Testing

Run PHPUnit from the root of your Symfony application using the following command:

phpunit vendor/jenbuzz/elasticsearch-explorer-bundle/Jenbuzz/ElasticsearchExplorerBundle/

License

ElasticsearchExplorerBundle is open-sourced software licensed under the MIT license