Skip to content

Commit 40c0ba5

Browse files
committed
TASK: Update documentation
1 parent b611489 commit 40c0ba5

File tree

1 file changed

+40
-7
lines changed

1 file changed

+40
-7
lines changed

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,65 @@
33
This package can be used to index a huge amount of nodes in ElasticSearch indexes. This
44
package use Beanstalkd and the JobQueue package to handle ES indexing asynchronously.
55

6-
## Batch Indexing
6+
# Breaking change after an upgrade to 3.0
77

8-
### How to build indexing job
8+
## Install and configure your Queue package
9+
10+
You need to install the correct Queue package based on your needs.
11+
12+
Available packages:
13+
14+
- [sqlite](https://packagist.org/packages/flownative/jobqueue-sqlite)
15+
- [beanstalkd](https://packagist.org/packages/flownative/jobqueue-beanstalkd)
16+
- [doctrine](https://packagist.org/packages/flownative/jobqueue-doctrine)
17+
- [redis](https://packagist.org/packages/flownative/jobqueue-redis)
18+
19+
Please check the package documentation for specific configurations.
20+
21+
The default configuration use Beanstalkd, but you need to install it manually:
22+
23+
composer require flowpack/jobqueue-beanstalkd
24+
25+
Check the ```Settings.yaml``` to adapt based on the Queue package, you need to adapt the ```className```:
26+
27+
Flowpack:
28+
JobQueue:
29+
Common:
30+
queues:
31+
'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer':
32+
className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
33+
34+
'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer.Live':
35+
className: 'Flowpack\JobQueue\Beanstalkd\Queue\BeanstalkdQueue'
36+
37+
38+
39+
# Batch Indexing
40+
41+
## How to build indexing job
942

1043
flow nodeindexqueue:build --workspace live
1144

12-
### How to process indexing job
45+
## How to process indexing job
1346

1447
You can use this CLI command to process indexing job:
1548

1649
flow nodeindexqueue:work --queue batch
1750

18-
## Live Indexing
51+
# Live Indexing
1952

20-
You can enable async live indexing by editing ```Settings.yaml```:
53+
You can disable async live indexing by editing ```Settings.yaml```:
2154

2255
Flowpack:
2356
ElasticSearch:
2457
ContentRepositoryQueueIndexer:
25-
enableLiveAsyncIndexing: true
58+
enableLiveAsyncIndexing: false
2659
2760
You can use this CLI command to process indexing job:
2861

2962
flow nodeindexqueue:work --queue live
3063

31-
## Supervisord configuration
64+
# Supervisord configuration
3265

3366
You can use tools like ```supervisord``` to manage long runing process. Bellow you can
3467
found a basic configuration:

0 commit comments

Comments
 (0)