Skip to content

Commit 1b79d2b

Browse files
committed
TASK: Update documentation for 2.x configuration
1 parent 764451d commit 1b79d2b

5 files changed

Lines changed: 25 additions & 7 deletions

File tree

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/Version1/IndexerDriver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public function document($indexName, NodeInterface $node, ElasticSearchDocument
4242
'_id' => $document->getId()
4343
]
4444
],
45-
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html
45+
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.7/docs-update.html
4646
[
4747
'script' => '
4848
fulltext = (ctx._source.containsKey("__fulltext") ? ctx._source.__fulltext : new LinkedHashMap());

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Driver/Version2/IndexerDriver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public function document($indexName, NodeInterface $node, ElasticSearchDocument
4242
'_retry_on_conflict' => 3
4343
]
4444
],
45-
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html
45+
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/docs-update.html
4646
[
4747
'script' => [
4848
'inline' => '

Documentation/ElasticConfiguration-1.6-1.7.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Needed Configuration in configuration.yml for Elasticsearch 1.6.x and 1.7.x
22

3-
In verson 1.6 the `script.disable_dynamic` settings and the Groovy sandbox as such [have been deprecated]
3+
In version 1.6 the `script.disable_dynamic` settings and the Groovy sandbox as such [have been deprecated]
44
(https://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html#enable-dynamic-scripting).
55
You may continue to use the settings for version 1.5.x, but this is what would be the correct configuration for 1.6.x and 1.7.x.
66

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Needed Configuration in configuration.yml for Elasticsearch 2.x
2+
3+
Since version 2.0 the fine-grained script settings are in place as described in the scripting docs
4+
(https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html#enable-dynamic-scripting).
5+
6+
```
7+
# The following settings are absolutely required for the CR adaptor to work
8+
script.inline: true
9+
10+
# the following settings secure your cluster
11+
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
12+
network.host: 127.0.0.1
13+
14+
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
15+
index.number_of_shards: 1
16+
index.number_of_replicas: 0
17+
```

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ main functionalities:
88
* finding Nodes in TypoScript / Eel by arbitrary queries
99
* Full-Text Indexing of Pages and other Documents (of course including the full content)
1010

11-
## Elastic version support
11+
## Elastic version support
1212

13-
You can switch the Elastic driver by editing ```Settings.yaml```
13+
You can switch the Elastic driver by editing ```Settings.yaml```
1414
(```Flowpack.ElasticSearchContentRepositoryAdaptor.driver.version```) with the following value:
1515

1616
* ```1.x``` to support Elastic 1.2 to 1.7
17-
* ```2.x``` to support Elastic 2.x to 1.4
17+
* ```2.x``` to support Elastic 2.x
1818

1919
_Currently the Driver interfaces as not marked as API, and can be changed to adapt to future needs (especially the support of Elastic v5)._
2020

@@ -48,6 +48,7 @@ Finally, run `./flow nodeindex:build`, and add the search plugin to your page. I
4848
There is a need, depending on your version of Elasticsearch, to add specific configuration to your
4949
Elasticsearch Configuration File `<your-elasticsearch>/config/elasticsearch.yml`.
5050

51+
- [ElasticSearch 2.x](Documentation/ElasticConfiguration-2.x.md)
5152
- [ElasticSearch 1.6 to 1.7](Documentation/ElasticConfiguration-1.6-1.7.md)
5253
- [ElasticSearch 1.4 to 1.5](Documentation/ElasticConfiguration-1.4-1.5.md)
5354
- [ElasticSearch 1.3](Documentation/ElasticConfiguration-1.3.md)
@@ -680,7 +681,7 @@ in the NodeTypes.yaml. Generally this works by defining the global mapping at `[
680681

681682
## Change the default Elastic index name
682683

683-
If you need to run serveral (different) neos instances on the same elasticsearch server you will need to change the Configuration/Settings.yaml indexName for each of your project.
684+
If you need to run serveral (different) neos instances on the same elasticsearch server you will need to change the Configuration/Settings.yaml indexName for each of your project.
684685

685686
So `./flow nodeindex:build` or `./flow nodeindex:cleanup` won't overwrite your other sites index.
686687

0 commit comments

Comments
 (0)