Skip to content

Commit aea39eb

Browse files
dfeyerdfeyer
authored
Merge pull request #143 from dfeyer/task-splitstree
TASK: Split documentation in multiple files and add links to related packages
2 parents 032616e + fff2176 commit aea39eb

File tree

5 files changed

+88
-100
lines changed

5 files changed

+88
-100
lines changed

‎Documentation/ElasticConfiguration-1.2.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Needed Configuration for Elasticsearch 1.2.x
2+
3+
4+
If you are using Elasticsearch version 1.2 you have also to install groovy as a plugin. To install the plugin just run
5+
the following command in the root folder of your elastic:
6+
7+
```
8+
bin/plugin -install elasticsearch/elasticsearch-lang-groovy/2.2.0.
9+
```
10+
11+
```
12+
script.disable_dynamic: false
13+
script.default_lang: groovy
14+
15+
```

‎Documentation/ElasticConfiguration-1.3.md‎

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 1.3.x
2+
3+
```
4+
# The following settings are absolutely required for the CR adaptor to work
5+
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
6+
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
7+
8+
# the following settings secure your cluster
9+
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
10+
network.host: 127.0.0.1
11+
12+
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
13+
index.number_of_shards: 1
14+
index.number_of_replicas: 0
15+
```
16+
17+
You can get further information about this topic here:
18+
19+
http://www.elasticsearch.org/blog/elasticsearch-1-3-0-released/
20+
http://www.elasticsearch.org/blog/scripting-security/
21+
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html

‎Documentation/ElasticConfiguration-1.4-1.5.md‎

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 1.4.x and 1.5.x
2+
3+
```
4+
# The following settings are absolutely required for the CR adaptor to work
5+
script.disable_dynamic: sandbox
6+
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
7+
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
8+
script.groovy.sandbox.enabled: 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+
```

‎Documentation/ElasticConfiguration-1.6-1.7.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Needed Configuration in configuration.yml for Elasticsearch 1.6.x and 1.7.x
2+
3+
In verson 1.6 the `script.disable_dynamic` settings and the Groovy sandbox as such [have been deprecated]
4+
(https://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html#enable-dynamic-scripting).
5+
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.
6+
7+
```
8+
# The following settings are absolutely required for the CR adaptor to work
9+
script.file: on
10+
script.engine.groovy.inline: sandbox
11+
script.engine.groovy.indexed: sandbox
12+
13+
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
14+
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
15+
script.groovy.sandbox.enabled: true
16+
17+
# the following settings secure your cluster
18+
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
19+
network.host: 127.0.0.1
20+
21+
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
22+
index.number_of_shards: 1
23+
index.number_of_replicas: 0
24+
```

‎README.md‎

Lines changed: 11 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,15 @@ main functionalities:
1313
* Full-Text Indexing of Pages and other Documents (of course including the full content)
1414

1515

16-
Relevant Packages:
16+
## Relevant Packages
1717

18-
* `TYPO3.TYPO3CR.Search`: provides common functionality for searching TYPO3CR nodes,
18+
* [TYPO3.TYPO3CR.Search](https://www.neos.io/download-and-extend/packages/typo3/typo3-typo3cr-search.html): provides common functionality for searching TYPO3CR nodes,
1919
does not contain a search backend
20-
21-
* `Flowpack.ElasticSearch`: provides common code for working with Elasticsearch
22-
23-
* `Flowpack.ElasticSearch.ContentRepositoryAdaptor`: this package
24-
25-
* `Flowpack.SimpleSearch.ContentRepositoryAdaptor`: an alternative search backend (to be used
20+
* [Flowpack.ElasticSearch](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-elasticsearch-contentrepositoryadaptor.html): provides common code for working with Elasticsearch
21+
* [Flowpack.ElasticSearch.ContentRepositoryAdaptor](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-elasticsearch-contentrepositoryadaptor.html): this package
22+
* [Flowpack.SimpleSearch.ContentRepositoryAdaptor](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-simplesearch-contentrepositoryadaptor.html): an alternative search backend (to be used
2623
instead of this package); storing the search index in SQLite
27-
28-
* `Flowpack.SearchPlugin`: search plugin for Neos
24+
* [Flowpack.SearchPlugin](https://www.neos.io/download-and-extend/packages/flowpack/flowpack-searchplugin.html): search plugin for Neos
2925

3026

3127
## Installation
@@ -47,89 +43,13 @@ Finally, run `./flow nodeindex:build`, and add the search plugin to your page. I
4743

4844
## Elasticsearch Configuration file elasticsearch.yml
4945

50-
There is a need, depending on your version of Elasticsearch, to add the following lines of configuration to your
46+
There is a need, depending on your version of Elasticsearch, to add specific configuration to your
5147
Elasticsearch Configuration File `<your-elasticsearch>/config/elasticsearch.yml`.
5248

53-
### Needed Configuration in configuration.yml for Elasticsearch 1.6.x and 1.7.x
54-
55-
In verson 1.6 the `script.disable_dynamic` settings and the Groovy sandbox as such [have been deprecated]
56-
(https://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html#enable-dynamic-scripting).
57-
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.
58-
59-
```
60-
# The following settings are absolutely required for the CR adaptor to work
61-
script.file: on
62-
script.engine.groovy.inline: sandbox
63-
script.engine.groovy.indexed: sandbox
64-
65-
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
66-
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
67-
script.groovy.sandbox.enabled: true
68-
69-
# the following settings secure your cluster
70-
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
71-
network.host: 127.0.0.1
72-
73-
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
74-
index.number_of_shards: 1
75-
index.number_of_replicas: 0
76-
```
77-
78-
### Needed Configuration in configuration.yml for Elasticsearch 1.4.x and 1.5.x
79-
80-
```
81-
# The following settings are absolutely required for the CR adaptor to work
82-
script.disable_dynamic: sandbox
83-
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
84-
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
85-
script.groovy.sandbox.enabled: true
86-
87-
# the following settings secure your cluster
88-
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
89-
network.host: 127.0.0.1
90-
91-
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
92-
index.number_of_shards: 1
93-
index.number_of_replicas: 0
94-
```
95-
96-
### Needed Configuration in configuration.yml for Elasticsearch 1.3.x
97-
98-
```
99-
# The following settings are absolutely required for the CR adaptor to work
100-
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
101-
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
102-
103-
# the following settings secure your cluster
104-
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
105-
network.host: 127.0.0.1
106-
107-
# the following settings are well-suited for smaller Elasticsearch instances (e.g. as long as you can stay on one host)
108-
index.number_of_shards: 1
109-
index.number_of_replicas: 0
110-
```
111-
112-
You can get further information about this topic here:
113-
114-
http://www.elasticsearch.org/blog/elasticsearch-1-3-0-released/
115-
http://www.elasticsearch.org/blog/scripting-security/
116-
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html
117-
118-
## Needed Configuration for Elasticsearch 1.2.x
119-
120-
121-
If you are using Elasticsearch version 1.2 you have also to install groovy as a plugin. To install the plugin just run
122-
the following command in the root folder of your elastic:
123-
124-
```
125-
bin/plugin -install elasticsearch/elasticsearch-lang-groovy/2.2.0.
126-
```
127-
128-
```
129-
script.disable_dynamic: false
130-
script.default_lang: groovy
131-
132-
```
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)
13353

13454
## Building up the Index
13555

@@ -139,7 +59,6 @@ In case of a mapping update, you need to reindex all nodes. Don't worry to do th
13959
the system transparently creates a new index, fills it completely, and when everything worked,
14060
changes the index alias.
14161

142-
14362
```
14463
./flow nodeindex:build
14564
@@ -150,7 +69,6 @@ changes the index alias.
15069
./flow nodeindex:cleanup
15170
```
15271

153-
15472
### Advanced Index Settings
15573
If you need advanced settings you can define them in your *Settings.yaml*:
15674

@@ -781,26 +699,19 @@ The configuration from Version 1 to Version 2 has changed; here's what to change
781699

782700
1. Change the base namespace for configuration from `Flowpack.ElasticSearch.ContentRepositoryAdaptor`
783701
to `TYPO3.TYPO3CR.Search`. All further adjustments are made underneath this namespace:
784-
785702
2. (If it exists in your configuration:) Move `indexName` to `elasticSearch.indexName`
786-
787703
3. (If it exists in your configuration:) Move `log` to `elasticSearch.log`
788-
789704
4. search for `mapping` (inside `defaultConfigurationPerType.<typeName>`) and replace it by
790705
`elasticSearchMapping`.
791-
792706
5. Inside the `indexing` expressions (at `defaultConfigurationPerType.<typeName>`), replace
793707
`ElasticSearch.` by `Indexing.`.
794708

795709
**NodeTypes.yaml**
796710

797711
1. Replace `elasticSearch` by `search`. This replaces both `<YourNodeType>.elasticSearch`
798712
and `<YourNodeType>.properties.<propertyName>.elasticSearch`.
799-
800713
2. search for `mapping` (inside `<YourNodeType>.properties.<propertyName>.search`) and replace it by
801714
`elasticSearchMapping`.
802-
803715
3. Replace `ElasticSeach.fulltext` by `Indexing`
804-
805716
4. Search for `ElasticSearch.` (inside the `indexing` expressions) and replace them by `Indexing.`
806717

0 commit comments

Comments
 (0)