Skip to content

Commit 895b6f1

Browse files
committed
[TASK] Add basic documentation
1 parent 808f0aa commit 895b6f1

2 files changed

Lines changed: 48 additions & 1 deletion

File tree

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Neos CMS ElasticSearch indexer based on beanstalkd (job queue)
2+
3+
This package can be used to index a huge amount of nodes in ElasticSearch indexes. This
4+
package use Beanstalkd and the JobQueue package to handle ES indexing asynchronously.
5+
6+
How to build indexing job
7+
-------------------------
8+
9+
flow nodeindexqueue:build --workspace live
10+
11+
How to process indexing job
12+
---------------------------
13+
14+
You can use this CLI command to process indexing job:
15+
16+
flow job:work --queue-name Flowpack.ElasticSearch.ContentRepositoryQueueIndexer
17+
18+
You can use tools like ```supervisord``` to manage long runing process. Bellow you can
19+
found a basic configuration:
20+
21+
[supervisord]
22+
23+
[supervisorctl]
24+
25+
[program:elasticsearch_indexing]
26+
command=php flow job:work --queue-name Flowpack.ElasticSearch.ContentRepositoryQueueIndexer --limit 5000
27+
stdout_logfile=AUTO
28+
stderr_logfile=AUTO
29+
numprocs=12
30+
process_name=elasticsearch_indexing_%(process_num)02d
31+
environment=FLOW_CONTEXT="Production"
32+
autostart=true
33+
autorestart=true
34+
stopsignal=QUIT
35+
36+
Acknowledgments
37+
---------------
38+
39+
Development sponsored by [ttree ltd - neos solution provider](http://ttree.ch).
40+
41+
We try our best to craft this package with a lots of love, we are open to
42+
sponsoring, support request, ... just contact us.
43+
44+
License
45+
-------
46+
47+
Licensed under MIT, see [LICENSE](LICENSE)

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "flowpack/elasticsearch-contentrepositoryqueueindexer",
33
"type": "typo3-flow-package",
4-
"description": "Neos CMS ElasticSearch importer based on Beanstalkd (to handle big indexing tags, +50'000 nodes)",
4+
"description": "Neos CMS ElasticSearch indexer based on beanstalkd (job queue)",
55
"require": {
66
"typo3/flow": "*",
77
"typo3/jobqueue-beanstalkd": "*"

0 commit comments

Comments
 (0)