Skip to content

Commit

Permalink
docs: add auth modes config (#1595)
Browse files Browse the repository at this point in the history
  • Loading branch information
coolCatalyst committed Nov 6, 2023
1 parent 9c23c1a commit 02a2884
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/docs/Developers/contribution/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Explanation",
"label": "Contributor Onboarding",
"position": 1,
"link": {
"type": "generated-index",
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/Developers/contribution/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ sidebar_position: 2
title: Install Quivr
---

Sure, here's an improved version of your markdown document:

# Prerequisites 📋

Before you begin, make sure you have the following tools and accounts installed and set up:
Expand Down
23 changes: 23 additions & 0 deletions docs/docs/Developers/selfHosted/Authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 3
title: Authentication
---

# 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.
8 changes: 8 additions & 0 deletions docs/docs/Developers/selfHosted/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Self host Quivr",
"position": 3,
"link": {
"type": "generated-index",
"description": "How to use Quivr as a Dev ?"
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 2
title: Run Quivr fully locally
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
sidebar_position: 1
title: Install on your Server
---

Expand All @@ -7,6 +8,7 @@ title: Install on your Server
Welcome to the installation guide for Quivr, your go-to open-source project . This tutorial will walk you through the process of setting up Quivr on an Ubuntu 22.04 server with Docker and Traefik, ensuring a secure HTTPS connection for your domains.

## Table of Contents

- [Quivr Installation Guide on Ubuntu 22 Server](#quivr-installation-guide-on-ubuntu-22-server)
- [Table of Contents](#table-of-contents)
- [Prerequisites](#prerequisites)
Expand All @@ -19,6 +21,7 @@ Welcome to the installation guide for Quivr, your go-to open-source project . Th
- [Additional Information](#additional-information)

## Prerequisites

Before diving into the installation process, please ensure you have the following ready:

- An **Ubuntu 22.04 server** with at least **20 GB of free disk space**.
Expand All @@ -33,6 +36,7 @@ Before diving into the installation process, please ensure you have the followin
## Step-by-Step Installation

### Step 1: Clone Quivr Repository

Let's get started by cloning the Quivr repository onto your server. Open your terminal and run:

```bash
Expand All @@ -41,6 +45,7 @@ cd quivr
```

### Step 2: Create `.env` File

Now, let's set up your environment variables. In the root directory of the Quivr project, create a `.env` file:

```bash
Expand All @@ -54,14 +59,17 @@ EMAIL=your-email@example.com
DOMAIN_NAME=yourdomain.com
API_DOMAIN_NAME=api.yourdomain.com
```

note: in this file if you used a subdomain, DOMAIN_NAME would be `bot.<yourdomain.com>` and API_DOMAIN_NAME would be `api.<yourdomain.com>`

Don't forget to save your changes (`Ctrl+X`, then `Y`, and `Enter`).

### Step 3: Configure `.env` Files for Backend and Frontend

Next, configure the `backend/.env` and `frontend/.env` files as per the Quivr documentation. You'll fill in various settings specific to your setup.

### Step 4: Launch Quivr with Docker Compose

With your `.env` files ready, it's time to start up Quivr using Docker Compose. This step is exciting because it's when things come to life!

```bash
Expand All @@ -71,9 +79,10 @@ docker-compose -f docker-compose.local.yml up
The `docker-compose.local.yml` file includes **Traefik**, which automagically handles HTTPS certificates for you.

### Step 5: Verify Installation

Once everything is up and running, give yourself a pat on the back and verify that the services are accessible:

- Visit `https://yourdomain.com` or `https://bot.yourdomain.com`
- Visit `https://yourdomain.com` or `https://bot.yourdomain.com`
- And `https://api.yourdomain.com`

You should be greeted by your new Quivr setup, all shiny and secure!
Expand Down

0 comments on commit 02a2884

Please sign in to comment.