From d54f370ed4bfdf2524a24b2931d7189099513676 Mon Sep 17 00:00:00 2001 From: Stan Girard Date: Wed, 24 Apr 2024 03:34:24 -0700 Subject: [PATCH] docs: add new configuration items (#2483) # Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): --- docs/configuring/authentication.mdx | 24 ++++++++++++++++++++ docs/configuring/environment-variables.mdx | 21 ----------------- docs/configuring/increase-user-usage.mdx | 2 +- docs/configuring/new-model.mdx | 2 +- docs/configuring/resend-emails.mdx | 26 ++++++++++++++++++++++ docs/configuring/telemetry.mdx | 21 +++++++++++++++++ docs/mint.json | 2 +- 7 files changed, 74 insertions(+), 24 deletions(-) create mode 100644 docs/configuring/authentication.mdx create mode 100644 docs/configuring/resend-emails.mdx create mode 100644 docs/configuring/telemetry.mdx diff --git a/docs/configuring/authentication.mdx b/docs/configuring/authentication.mdx new file mode 100644 index 000000000..94fe5acfe --- /dev/null +++ b/docs/configuring/authentication.mdx @@ -0,0 +1,24 @@ +--- +title: Authentication Method +description: Learn how to configure authentication in Quivr. +--- + + +# Authentication Methods + +Quivr offers three authentication methods when self-hosting. You can choose which authentication methods you want to offer to your users from these three options: + +1. **Email/Password Authentication** +2. **Google Authentication** +3. **Magic Link Authentication** + +To enable one or more of these methods, you need to configure the following environment variables in your `.env` file: + +```bash +# Authentication Configuration +NEXT_PUBLIC_AUTH_MODES=magic_link,google_sso,password +``` +Since each of these methods uses Supabase, you should configure your Supabase instance to support the chosen methods. + +Please refer to the [Supabase documentation](https://supabase.com/docs/guides/auth) for more information on how to configure each authentication method. + diff --git a/docs/configuring/environment-variables.mdx b/docs/configuring/environment-variables.mdx index fc73d8ff3..cbf8d809c 100644 --- a/docs/configuring/environment-variables.mdx +++ b/docs/configuring/environment-variables.mdx @@ -2,27 +2,6 @@ title: Environment Variables description: Learn how to configure the environment variables for Quivr. --- - -# Authentication Methods - -Quivr offers three authentication methods when self-hosting. You can choose which authentication methods you want to offer to your users from these three options: - -1. **Email/Password Authentication** -2. **Google Authentication** -3. **Magic Link Authentication** - -To enable one or more of these methods, you need to configure the following environment variables in your `.env` file: - -```bash -# Authentication Configuration -NEXT_PUBLIC_AUTH_MODES=magic_link,google_sso,password -``` - -Since each of these methods uses Supabase, you should configure your Supabase instance to support the chosen methods. - -Please refer to the [Supabase documentation](https://supabase.com/docs/guides/auth) for more information on how to configure each authentication method. - - # Environment variables You have two environment files in the root of the project: diff --git a/docs/configuring/increase-user-usage.mdx b/docs/configuring/increase-user-usage.mdx index ae98ec0b2..b7f0101f9 100644 --- a/docs/configuring/increase-user-usage.mdx +++ b/docs/configuring/increase-user-usage.mdx @@ -1,5 +1,5 @@ --- -title: Increase User Usage +title: Increase User description: Learn how to increase user usage in Quivr. --- diff --git a/docs/configuring/new-model.mdx b/docs/configuring/new-model.mdx index 473b84a68..1df26dd45 100644 --- a/docs/configuring/new-model.mdx +++ b/docs/configuring/new-model.mdx @@ -1,5 +1,5 @@ --- -title: Add New Models +title: New Models description: Learn how to add new models to Quivr. --- diff --git a/docs/configuring/resend-emails.mdx b/docs/configuring/resend-emails.mdx new file mode 100644 index 000000000..a02df4d2e --- /dev/null +++ b/docs/configuring/resend-emails.mdx @@ -0,0 +1,26 @@ +--- +title: Emails +description: Allow Quivr to send emails +--- + +# Emails with Resend + +Quivr uses the [Resend](https://resend.com/) service to send emails. Resend is a transactional email service that allows you to send emails from your application. This guide will show you how to set up Resend in Quivr. + +## Setting up Resend + +To set up Resend in Quivr, you need to configure the following environment variables in your `.env` file: + +```bash +# Resend Configuration +RESEND_API_KEY= +RESEND_EMAIL_ADDRESS= +RESEND_CONTACT_SALES_FROM= +RESEND_CONTACT_SALES_TO= +``` + +You can get the `RESEND_API_KEY` from your Resend account. The `RESEND_EMAIL_ADDRESS` is the email address that will be used to send emails from your application. The `RESEND_CONTACT_SALES_FROM` and `RESEND_CONTACT_SALES_TO` are the email addresses that will be used for sales-related inquiries. + +Make sure that these emails and domains have been verified in your Resend account to avoid any issues with sending emails. + + diff --git a/docs/configuring/telemetry.mdx b/docs/configuring/telemetry.mdx new file mode 100644 index 000000000..9753f32a8 --- /dev/null +++ b/docs/configuring/telemetry.mdx @@ -0,0 +1,21 @@ +--- +title: Telemetry +description: Learn how to configure telemetry in Quivr. +icon: chart +--- + +Quivr uses its own telemetry service to track user interactions and usage. This guide will show you to deactivate or configure the telemetry service in Quivr. + +## Telemetry Configuration + +To configure the telemetry service in Quivr, you need to configure the following environment variables in your `.env` file: + +```bash +TELEMETRY_ENABLED=false +``` + +By default, the `TELEMETRY_ENABLED` variable is set to `true`. If you want to deactivate the telemetry service, you can set it to `false`. + +We only collect data that is necessary for improving the user experience and the quality of the service. We do not collect any personal data or sensitive information. + + diff --git a/docs/mint.json b/docs/mint.json index 163388ee1..0b68e7ba9 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -60,7 +60,7 @@ { "group": "Configuring", "icon": "gear", - "pages": ["configuring/environment-variables", "configuring/new-model", "configuring/increase-user-usage"] + "pages": ["configuring/authentication", "configuring/new-model", "configuring/increase-user-usage", "configuring/resend-emails", "configuring/environment-variables", "configuring/telemetry"] }, "tech-design", "contact-us"