From 5e508944a32c889009a4e67c65f5b6649c9fda64 Mon Sep 17 00:00:00 2001 From: Mikhail Epifanov Date: Tue, 20 Feb 2024 17:48:35 +0100 Subject: [PATCH] move env settings to configuration with backlink from connectors page --- docs/features/connectors.md | 11 +---------- docs/system/configuration.md | 25 +++++++++++++------------ 2 files changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/features/connectors.md b/docs/features/connectors.md index 2687f7af..1f9a1b9c 100644 --- a/docs/features/connectors.md +++ b/docs/features/connectors.md @@ -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 diff --git a/docs/system/configuration.md b/docs/system/configuration.md index 2d7b288c..6d5f1ce6 100644 --- a/docs/system/configuration.md +++ b/docs/system/configuration.md @@ -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