mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-25 19:07:43 +03:00
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):
This commit is contained in:
parent
b33e00672a
commit
d54f370ed4
24
docs/configuring/authentication.mdx
Normal file
24
docs/configuring/authentication.mdx
Normal file
@ -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.
|
||||
|
@ -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:
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Increase User Usage
|
||||
title: Increase User
|
||||
description: Learn how to increase user usage in Quivr.
|
||||
---
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Add New Models
|
||||
title: New Models
|
||||
description: Learn how to add new models to Quivr.
|
||||
---
|
||||
|
||||
|
26
docs/configuring/resend-emails.mdx
Normal file
26
docs/configuring/resend-emails.mdx
Normal file
@ -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=<change-me>
|
||||
RESEND_EMAIL_ADDRESS=<change-me>
|
||||
RESEND_CONTACT_SALES_FROM=<change-me>
|
||||
RESEND_CONTACT_SALES_TO=<change-me>
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
|
21
docs/configuring/telemetry.mdx
Normal file
21
docs/configuring/telemetry.mdx
Normal file
@ -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.
|
||||
|
||||
|
@ -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"
|
||||
|
Loading…
Reference in New Issue
Block a user