Skip to content

Commit 92801ff

Browse files
committed
feat(genapi): add tutorial librechat
1 parent fa08589 commit 92801ff

File tree

1 file changed

+80
-7
lines changed
  • tutorials/deploy-librechat-with-generative-apis

1 file changed

+80
-7
lines changed
Lines changed: 80 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,88 @@
11
---
22
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 or on a Serverless Container.
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.
55
content:
6-
h1: Fast deployment of documentation on Serverless Containers with mdBook
7-
paragraph: Step-by-step guide to deploy mdBooks on Scaleway Serverless Containers.
8-
tags: docker container deploy serverless mdbook documentation
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
99
categories:
1010
- generative-apis
1111
dates:
12-
validation: 2025-02-20
13-
posted: 2025-02-20
12+
validation: 2025-03-13
13+
posted: 2025-03-13
1414
---
1515

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+
19+
<Macro id="requirements" />
20+
21+
- A Scaleway account logged into the [console](https://console.scaleway.com)
22+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
23+
- [Docker](https://docs.docker.com/engine/install/) installed on your local machine
24+
- Generated a Scaleway [API secret key]/iam/how-to/create-api-keys/)
25+
26+
27+
1. Clone the LibreChat repository from GitHub:
28+
```
29+
git clone https://github.com/danny-avila/LibreChat.git
30+
```
31+
32+
2. Copy the `.env.example` file into a file called `.env`:
33+
```
34+
cp .env.example .env
35+
```
36+
37+
3. Add a `docker-compose.override.yml` file at the root of the project:
38+
```
39+
touch docker-compose.override.yml
40+
```
41+
42+
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:
43+
```yaml
44+
services:
45+
api:
46+
volumes:
47+
- type: bind
48+
source: ./librechat.yaml
49+
target: /app/librechat.yaml
50+
```
51+
52+
5. Add a `librechat.yaml` file at the root of the project:
53+
```
54+
touch librechat.yaml
55+
```
56+
57+
6. Open the `librechat.yaml` file in a text editor and copy the following configuration into it. Then save and exit the editor:
58+
```yaml
59+
version: 1.2.1
60+
cache: true
61+
# Definition of a custom endpoint for Scaleway
62+
endpoints:
63+
custom:
64+
- name: 'Scaleway'
65+
apiKey: '<YOUR_SCW_SECRET_API_KEY>'
66+
baseURL: "https://api.scaleway.ai/v1"
67+
models:
68+
default:
69+
- "llama-3.3-70b-instruct"
70+
fetch: true
71+
titleConvo: true
72+
titleModel: 'Llama-3.3-70b-instruct'
73+
modelDisplayLabel: 'Scaleway'
74+
```
75+
<Message type="important">
76+
Do not forget to replace `<YOUR_SCW_SECRET_API_KEY>` with your personal secret API key.
77+
</Message>
78+
79+
7. Launch the application with Docker:
80+
```
81+
docker compose up -d
82+
```
83+
84+
8. Open a web browser and access LibreChat at `http://localhost:3080/`:
85+
```
86+
# Example of opening a browser (may vary by OS)
87+
open http://localhost:3080/
88+
```

0 commit comments

Comments
 (0)