docs(config): Add comments that sync mode only works if the queue engine is local. (#692)

Co-authored-by: yukia3e <12268087+yukia3@users.noreply.github.com>
This commit is contained in:
Yuki Abe 2022-10-29 23:34:00 +09:00 committed by GitHub
parent 7f4a6670a9
commit 24d2861f1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

View File

@ -104,7 +104,7 @@ core:
worker_num: 0 # default worker number is runtime.NumCPU()
queue_num: 0 # default queue number is 8192
max_notification: 100
sync: false # set true if you need get error message from fail push notification in API response.
sync: false # set true if you need get error message from fail push notification in API response. It only works when the queue engine is local.
feedback_hook_url: "" # set a hook url if you need get error message asynchronously from fail push notification in API response.
feedback_timeout: 10 # default is 10 second
mode: "release"
@ -983,7 +983,7 @@ core:
+ feedback_hook_url: "https://exemple.com/api/hook"
```
You can also switch to **sync** mode by setting the `sync` value as `true` on yaml config.
You can also switch to **sync** mode by setting the `sync` value as `true` on yaml config. It only works when the queue engine is local.
```diff
core:

View File

@ -19,7 +19,7 @@ core:
worker_num: 0 # default worker number is runtime.NumCPU()
queue_num: 0 # default queue number is 8192
max_notification: 100
sync: false # set true if you need get error message from fail push notification in API response.
sync: false # set true if you need get error message from fail push notification in API response. It only works when the queue engine is local.
feedback_hook_url: "" # set webhook url if you need get error message asynchronously from fail push notification in API response.
feedback_timeout: 10 # default is 10 second
mode: "release"