Skip to content

Commit bfaf359

Browse files
bene2k1nerda-codesjcirinosclwy
authored
feat(genapi): add tutorial librechat (#4616)
* feat(genapi): tuto librechat * feat(genapi): add tutorial librechat * Apply suggestions from code review Co-authored-by: Néda <[email protected]> * Update tutorials/deploy-librechat-with-generative-apis/index.mdx Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: Néda <[email protected]> Co-authored-by: Jessica <[email protected]>
1 parent d2495b6 commit bfaf359

File tree

1 file changed

+87
-0
lines changed
  • tutorials/deploy-librechat-with-generative-apis

1 file changed

+87
-0
lines changed
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
meta:
3+
title: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative
4+
description: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally.
5+
content:
6+
h1: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative
7+
paragraph: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally.
8+
tags: docker ai generative apis
9+
categories:
10+
- generative-apis
11+
dates:
12+
validation: 2025-03-13
13+
posted: 2025-03-13
14+
---
15+
16+
LibreChat is a free, open-source AI chat platform that unifies interactions with various AI models through a single, customizable interface. It supports multiple AI providers, including Scaleway's Generative APIs, allowing users to switch seamlessly between different models.
17+
18+
<Macro id="requirements" />
19+
20+
- A Scaleway account logged into the [console](https://console.scaleway.com)
21+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
22+
- [Docker](https://docs.docker.com/engine/install/) installed on your local machine
23+
- Generated a Scaleway [API secret key](/iam/how-to/create-api-keys/)
24+
25+
26+
1. Clone the LibreChat repository from GitHub:
27+
```
28+
git clone https://github.com/danny-avila/LibreChat.git
29+
```
30+
31+
2. Copy the `.env.example` file into a file called `.env`:
32+
```
33+
cp .env.example .env
34+
```
35+
36+
3. Add a `docker-compose.override.yml` file at the root of the project:
37+
```
38+
touch docker-compose.override.yml
39+
```
40+
41+
4. Open the `docker-compose.override.yml` file in a text editor and add the following content. Then save the file and exit the editor:
42+
```yaml
43+
services:
44+
api:
45+
volumes:
46+
- type: bind
47+
source: ./librechat.yaml
48+
target: /app/librechat.yaml
49+
```
50+
51+
5. Add a `librechat.yaml` file at the root of the project:
52+
```
53+
touch librechat.yaml
54+
```
55+
56+
6. Open the `librechat.yaml` file in a text editor and copy the configuration below into it. Then save and exit the editor.
57+
```yaml
58+
version: 1.2.1
59+
cache: true
60+
# Definition of a custom endpoint for Scaleway
61+
endpoints:
62+
custom:
63+
- name: 'Scaleway'
64+
apiKey: '<YOUR_SCW_SECRET_API_KEY>'
65+
baseURL: "https://api.scaleway.ai/v1"
66+
models:
67+
default:
68+
- "llama-3.3-70b-instruct"
69+
fetch: true
70+
titleConvo: true
71+
titleModel: 'Llama-3.3-70b-instruct'
72+
modelDisplayLabel: 'Scaleway'
73+
```
74+
<Message type="important">
75+
Make sure that you replace `<YOUR_SCW_SECRET_API_KEY>` with your own secret API key.
76+
</Message>
77+
78+
7. Launch the application with Docker:
79+
```
80+
docker compose up -d
81+
```
82+
83+
8. Open a web browser and access LibreChat at `http://localhost:3080/`:
84+
```
85+
# Example of opening a browser (may vary by OS)
86+
open http://localhost:3080/
87+
```

0 commit comments

Comments
 (0)