From 37ba1f88cec4f8223f3ffa3b5fe342fa486dfe63 Mon Sep 17 00:00:00 2001 From: Ruben Talstra Date: Mon, 24 Feb 2025 16:52:49 +0100 Subject: [PATCH 1/2] feat: Add Cloudflare Turnstile configuration support and documentation --- .../librechat_yaml/object_structure/_meta.ts | 1 + .../object_structure/turnstile.mdx | 65 +++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx diff --git a/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts b/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts index 1ffc9a6f7..57244f3ce 100644 --- a/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts +++ b/pages/docs/configuration/librechat_yaml/object_structure/_meta.ts @@ -2,6 +2,7 @@ export default { config: 'Root Settings', file_config: 'File Config', interface: 'Interface (UI)', + turnstile: 'Cloudflare Turnstile', model_specs: 'Model Specs', registration: 'Registration', agents: 'Agents', diff --git a/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx b/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx new file mode 100644 index 000000000..19661e808 --- /dev/null +++ b/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx @@ -0,0 +1,65 @@ +## Example + +```yaml filename="turnstile" +turnstile: + siteKey: "your-site-key-here" + options: + language: "auto" # "auto" or an ISO 639-1 language code (e.g., en) + size: "normal" # Options: "normal", "compact", "flexible", or "invisible" +``` + +## turnstile + +**Key:** + + +### Fields + + + +#### siteKey + +- **Type:** `String` +- **Description:** Your unique Cloudflare Turnstile site key. Make sure you have registered your domain with Cloudflare and obtained this key from the [Cloudflare Turnstile Get Started](https://developers.cloudflare.com/turnstile/get-started/) guide. +- **Example:** +```yaml +turnstile: + siteKey: "your-site-key-here" +``` + +#### options + +- **Type:** `Object` +- **Description:** An object to configure additional settings for the Turnstile widget. + +**Subkeys:** + + +```yaml +turnstile: + options: + language: "auto" + size: "normal" +``` + +### Notes + +- **Optional Integration:** The `turnstile` configuration block is optional. If you choose not to use Cloudflare Turnstile, you may omit this block entirely. +- **Dashboard Consistency:** Ensure that the values you configure here match your settings in the Cloudflare dashboard. +- **User Experience:** Customize the `options` subkeys as needed to tailor the widget's behavior and appearance to your application’s requirements. + +--- From 097abe4fd2286f7ac3928dcfac063d96e83af31b Mon Sep 17 00:00:00 2001 From: Ruben Talstra Date: Mon, 24 Feb 2025 16:54:06 +0100 Subject: [PATCH 2/2] feat: Add Cloudflare Turnstile configuration section to documentation --- .../configuration/librechat_yaml/object_structure/turnstile.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx b/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx index 19661e808..dd0c6546f 100644 --- a/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx +++ b/pages/docs/configuration/librechat_yaml/object_structure/turnstile.mdx @@ -1,3 +1,5 @@ +# Cloudflare Turnstile Configuration + ## Example ```yaml filename="turnstile"