From fa08589a9cbb59b968b5dd9ffce4140dad69ad33 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Thu, 20 Feb 2025 11:23:07 +0100 Subject: [PATCH 1/4] feat(genapi): tuto librechat --- .../index.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 tutorials/deploy-librechat-with-generative-apis/index.mdx diff --git a/tutorials/deploy-librechat-with-generative-apis/index.mdx b/tutorials/deploy-librechat-with-generative-apis/index.mdx new file mode 100644 index 0000000000..b563dc7abd --- /dev/null +++ b/tutorials/deploy-librechat-with-generative-apis/index.mdx @@ -0,0 +1,15 @@ +--- +meta: + title: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative. + description: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally or on a Serverless Container. +content: + h1: Fast deployment of documentation on Serverless Containers with mdBook + paragraph: Step-by-step guide to deploy mdBooks on Scaleway Serverless Containers. +tags: docker container deploy serverless mdbook documentation +categories: + - generative-apis +dates: + validation: 2025-02-20 + posted: 2025-02-20 +--- + From 92801fff2fa7c8cdf9b9aa1ccead777447e6f3a0 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Thu, 13 Mar 2025 16:41:10 +0100 Subject: [PATCH 2/4] feat(genapi): add tutorial librechat --- .../index.mdx | 87 +++++++++++++++++-- 1 file changed, 80 insertions(+), 7 deletions(-) diff --git a/tutorials/deploy-librechat-with-generative-apis/index.mdx b/tutorials/deploy-librechat-with-generative-apis/index.mdx index b563dc7abd..bd4e91d083 100644 --- a/tutorials/deploy-librechat-with-generative-apis/index.mdx +++ b/tutorials/deploy-librechat-with-generative-apis/index.mdx @@ -1,15 +1,88 @@ --- meta: - title: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative. - description: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally or on a Serverless Container. + title: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative + description: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally. content: - h1: Fast deployment of documentation on Serverless Containers with mdBook - paragraph: Step-by-step guide to deploy mdBooks on Scaleway Serverless Containers. -tags: docker container deploy serverless mdbook documentation + h1: Deploy LibreChat with Scaleway Generative APIs as a ChatGPT alternative + paragraph: Step-by-step guide to deploy LibreChat with Scaleway Generative APIs locally. +tags: docker ai generative apis categories: - generative-apis dates: - validation: 2025-02-20 - posted: 2025-02-20 + validation: 2025-03-13 + posted: 2025-03-13 --- +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. + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- [Docker](https://docs.docker.com/engine/install/) installed on your local machine +- Generated a Scaleway [API secret key]/iam/how-to/create-api-keys/) + + +1. Clone the LibreChat repository from GitHub: + ``` + git clone https://github.com/danny-avila/LibreChat.git + ``` + +2. Copy the `.env.example` file into a file called `.env`: + ``` + cp .env.example .env + ``` + +3. Add a `docker-compose.override.yml` file at the root of the project: + ``` + touch docker-compose.override.yml + ``` + +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: + ```yaml + services: + api: + volumes: + - type: bind + source: ./librechat.yaml + target: /app/librechat.yaml + ``` + +5. Add a `librechat.yaml` file at the root of the project: + ``` + touch librechat.yaml + ``` + +6. Open the `librechat.yaml` file in a text editor and copy the following configuration into it. Then save and exit the editor: + ```yaml + version: 1.2.1 + cache: true + # Definition of a custom endpoint for Scaleway + endpoints: + custom: + - name: 'Scaleway' + apiKey: '' + baseURL: "https://api.scaleway.ai/v1" + models: + default: + - "llama-3.3-70b-instruct" + fetch: true + titleConvo: true + titleModel: 'Llama-3.3-70b-instruct' + modelDisplayLabel: 'Scaleway' + ``` + + Do not forget to replace `` with your personal secret API key. + + +7. Launch the application with Docker: + ``` + docker compose up -d + ``` + +8. Open a web browser and access LibreChat at `http://localhost:3080/`: + ``` + # Example of opening a browser (may vary by OS) + open http://localhost:3080/ + ``` \ No newline at end of file From 70afc7a6f187f9297319bc99b44a79aa3804b974 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Thu, 13 Mar 2025 17:21:41 +0100 Subject: [PATCH 3/4] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Néda <87707325+nerda-codes@users.noreply.github.com> --- tutorials/deploy-librechat-with-generative-apis/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorials/deploy-librechat-with-generative-apis/index.mdx b/tutorials/deploy-librechat-with-generative-apis/index.mdx index bd4e91d083..68a2f93f88 100644 --- a/tutorials/deploy-librechat-with-generative-apis/index.mdx +++ b/tutorials/deploy-librechat-with-generative-apis/index.mdx @@ -21,7 +21,7 @@ LibreChat is a free, open-source AI chat platform that unifies interactions with - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - [Docker](https://docs.docker.com/engine/install/) installed on your local machine -- Generated a Scaleway [API secret key]/iam/how-to/create-api-keys/) +- Generated a Scaleway [API secret key](/iam/how-to/create-api-keys/) 1. Clone the LibreChat repository from GitHub: @@ -54,7 +54,7 @@ LibreChat is a free, open-source AI chat platform that unifies interactions with touch librechat.yaml ``` -6. Open the `librechat.yaml` file in a text editor and copy the following configuration into it. Then save and exit the editor: +6. Open the `librechat.yaml` file in a text editor and copy the configuration below into it. Then save and exit the editor. ```yaml version: 1.2.1 cache: true @@ -73,7 +73,7 @@ LibreChat is a free, open-source AI chat platform that unifies interactions with modelDisplayLabel: 'Scaleway' ``` - Do not forget to replace `` with your personal secret API key. + Make sure that you replace `` with your own secret API key. 7. Launch the application with Docker: From ef8a76ec7e9948c436c70dd3c4d85773f3c98af7 Mon Sep 17 00:00:00 2001 From: Benedikt Rollik Date: Fri, 14 Mar 2025 11:02:44 +0100 Subject: [PATCH 4/4] Update tutorials/deploy-librechat-with-generative-apis/index.mdx Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --- tutorials/deploy-librechat-with-generative-apis/index.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/tutorials/deploy-librechat-with-generative-apis/index.mdx b/tutorials/deploy-librechat-with-generative-apis/index.mdx index 68a2f93f88..75e27782e9 100644 --- a/tutorials/deploy-librechat-with-generative-apis/index.mdx +++ b/tutorials/deploy-librechat-with-generative-apis/index.mdx @@ -15,7 +15,6 @@ dates: 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. - - A Scaleway account logged into the [console](https://console.scaleway.com)