Skip to content

Commit 12f57be

Browse files
committed
TASK: Update documentation to configure ES 2.0-2.4
1 parent 5359af9 commit 12f57be

6 files changed

Lines changed: 28 additions & 89 deletions

Documentation/ElasticConfiguration-1.2.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

Documentation/ElasticConfiguration-1.3.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

Documentation/ElasticConfiguration-1.4-1.5.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

Documentation/ElasticConfiguration-1.6-1.7.md

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Needed Configuration in configuration.yml for Elasticsearch 2.0.x and 2.4.x
2+
3+
```
4+
# The following settings are absolutely required for the CR adaptor to work
5+
script.engine.groovy.inline.update: true
6+
7+
# the following settings are well-suited for smaller Elasticsearch instances (i.e. as long as you can stay on one host)
8+
index.number_of_shards: 1
9+
index.number_of_replicas: 0
10+
```
11+
12+
# Java Security Manager Policy file `.java.policy`
13+
14+
We need to allow access to some classes in the groovy script, so we need to modify (or create) the `~/.java.policy` for
15+
the user that is running Elasticsearch (`elasticsearch` by default). See [the Elasticsearch Reference](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-scripting-security.html#_customising_the_classloader_whitelist) for more info.
16+
17+
```
18+
grant {
19+
permission org.elasticsearch.script.ClassPermission "java.util.*";
20+
};
21+
```

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22

33
# Neos Elasticsearch Adapter
44

5-
*supporting Elasticsearch versions 1.2.x to 1.7.x*
5+
*supporting Elasticsearch versions 2.0.x to 2.4.x*, to support older version of ElasticSearch check the branch 2.0.
66

77
Created by Sebastian Kurfürst; [contributions by Karsten Dambekalns, Robert Lemke and others](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/graphs/contributors).
88

9-
This project connects the Neos Content Repository (TYPO3CR) to Elasticsearch; enabling two
10-
main functionalities:
9+
This project connects the Neos Content Repository (TYPO3CR) to Elasticsearch; enabling two main functionalities:
1110

1211
* finding Nodes in TypoScript / Eel by arbitrary queries
1312
* Full-Text Indexing of Pages and other Documents (of course including the full content)
1413

15-
1614
## Relevant Packages
1715

1816
* [TYPO3.TYPO3CR.Search](https://www.neos.io/download-and-extend/packages/typo3/typo3-typo3cr-search.html): provides common functionality for searching TYPO3CR nodes,
@@ -27,11 +25,10 @@ main functionalities:
2725
## Installation
2826

2927
```
30-
// for development (Master; Tested on Neos 2.0)
31-
composer require 'typo3/typo3cr-search:@dev'
32-
composer require 'flowpack/elasticsearch-contentrepositoryadaptor:@dev'
28+
composer require 'typo3/typo3cr-search'
29+
composer require 'flowpack/elasticsearch-contentrepositoryadaptor'
3330
34-
composer require 'flowpack/searchplugin:@dev'
31+
composer require 'flowpack/searchplugin'
3532
```
3633

3734
Now, add the routes as described in the [README of Flowpack.SearchPlugin](https://github.com/skurfuerst/Flowpack.SearchPlugin)
@@ -46,10 +43,8 @@ Finally, run `./flow nodeindex:build`, and add the search plugin to your page. I
4643
There is a need, depending on your version of Elasticsearch, to add specific configuration to your
4744
Elasticsearch Configuration File `<your-elasticsearch>/config/elasticsearch.yml`.
4845

49-
- [ElasticSearch 1.6 to 1.7](Documentation/ElasticConfiguration-1.6-1.7.md)
50-
- [ElasticSearch 1.4 to 1.5](Documentation/ElasticConfiguration-1.4-1.5.md)
51-
- [ElasticSearch 1.3](Documentation/ElasticConfiguration-1.3.md)
52-
- [ElasticSearch 1.2](Documentation/ElasticConfiguration-1.2.md)
46+
- [ElasticSearch 2.0 to 2.4](Documentation/ElasticConfiguration-2.0-2.4.md)
47+
- To support older version of ElasticSearch check the branch 2.0
5348

5449
## Building up the Index
5550

0 commit comments

Comments
 (0)