cgiacofei/TandoorRecipes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move env settings to configuration with backlink from connectors page

Browse Source
This commit is contained in:
Mikhail Epifanov 2024-02-20 17:48:35 +01:00
parent 6ce95fb393
commit 5e508944a3
No known key found for this signature in database
2 changed files with 14 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/features/connectors.md
View File

@ -6,20 +6,11 @@
Connectors are a powerful add-on component to TandoorRecipes.
They allow for certain actions to be translated to api calls to external services.
### General Config
!!! danger
In order for this application to push data to external providers it needs to store authentication information.
Please use read only/separate accounts or app passwords wherever possible.
- `DISABLE_EXTERNAL_CONNECTORS` is a global switch to disable External Connectors entirely.
- `EXTERNAL_CONNECTORS_QUEUE_SIZE` is the amount of changes that are kept in memory if the worker cannot keep up.
Example Config
```env
DISABLE_EXTERNAL_CONNECTORS=0 // 0 = connectors enabled, 1 = connectors enabled
EXTERNAL_CONNECTORS_QUEUE_SIZE=100
```
for the configuration please see [Configuration](https://docs.tandoor.dev/system/configuration/#connectors)
## Current Connectors

25
docs/system/configuration.md
View File

@ -218,18 +218,7 @@ SESSION_COOKIE_NAME=sessionid # use this only to not interfere with non unified
### Features
Some features can be enabled/disabled on a server level because they might change the user experience significantly,
they might be unstable/beta, or they have performance/security implications.
For more see configurations:
- [Authentication](https://docs.tandoor.dev/features/authentication/)
- [Automation](https://docs.tandoor.dev/features/automation/)
- [Connectors](https://docs.tandoor.dev/features/connectors/)
- [External Recipes](https://docs.tandoor.dev/features/external_recipes/)
- [Import/Export](https://docs.tandoor.dev/features/import_export/)
- [Shopping](https://docs.tandoor.dev/features/shopping/)
- [Telegram Bot](https://docs.tandoor.dev/features/telegram_bot/)
- [Templating](https://docs.tandoor.dev/features/templating/)
they might be unstable/beta or they have performance/security implications.
#### Captcha
@ -448,6 +437,18 @@ key [here](https://fdc.nal.usda.gov/api-key-signup.html).
FDC_API_KEY=DEMO_KEY
```
#### Connectors
- `DISABLE_EXTERNAL_CONNECTORS` is a global switch to disable External Connectors entirely.
- `EXTERNAL_CONNECTORS_QUEUE_SIZE` is the amount of changes that are kept in memory if the worker cannot keep up.
(External) Connectors are used to sync the status from Tandoor to other services. More info can be found [here](https://docs.tandoor.dev/features/connectors/).
```env
DISABLE_EXTERNAL_CONNECTORS=0 # Default 0 (false), set to 1 (true) to disable connectors
EXTERNAL_CONNECTORS_QUEUE_SIZE=100 # Defaults to 100, set to any number >1
```
### Debugging/Development settings
!!! warning