mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-24 05:55:13 +03:00
docs: ✏️ schema (#1537)
added ![image](https://github.com/StanGirard/quivr/assets/19614572/1471ec1f-bc9c-4177-9dae-cfeea6777b36)
This commit is contained in:
parent
e3925bcbc0
commit
7845124fc0
@ -30,3 +30,31 @@ Authorization: Bearer {api_key}
|
||||
Replace `{api_key}` with the generated API key obtained from the frontend
|
||||
|
||||
You can find more information in the [Authentication](/docs/Developers/useQuivr/get_your_api_key) section of the documentation.
|
||||
|
||||
|
||||
## Architectural Schema
|
||||
|
||||
|
||||
<div style={{ textAlign: 'center' }}>
|
||||
<img src="/img/architectural-high-level.png" alt="Quivr architecture" style={{ width: '60%' }} />
|
||||
</div>
|
||||
|
||||
### Load Balancer
|
||||
|
||||
The role of the load balancer is to catch the incoming traffic and redirect to the corresponding server. It is also responsible for the SSL termination.
|
||||
|
||||
### Container Service
|
||||
|
||||
The role of this service is to manage the replicas of all the services. It hold the information about the number of replicas of each service and the corresponding server.
|
||||
|
||||
### Queue
|
||||
|
||||
The role of the queue it to store "tasks" that are long to run and that can be run asynchronously. In our case we use it to embed the files and to index them as it can take a lot of time.
|
||||
|
||||
### Celery Worker
|
||||
|
||||
The role of the celery worker is to run the tasks that are stored in the queue. It is a distributed task queue that can run tasks asynchronously.
|
||||
|
||||
### Supabase
|
||||
|
||||
Supabase is used to do the authentication and to store the users information. It is a great open-source alternative to Firebase. It is currently used as a database, an authentication service, a vector store and a file store.
|
@ -71,11 +71,6 @@ const config = {
|
||||
src: 'img/logo.png',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
href: '/docs/roadmap',
|
||||
label: 'Roadmap',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
href: 'https://quivr.app',
|
||||
position: 'right',
|
||||
|
BIN
docs/static/img/architectural-high-level.png
vendored
Normal file
BIN
docs/static/img/architectural-high-level.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 101 KiB |
Loading…
Reference in New Issue
Block a user