-
Notifications
You must be signed in to change notification settings - Fork 261
feat(genapi): add tutorial librechat #4616
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| 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. | ||
| content: | ||
| 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-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. | ||
|
|
||
| <Macro id="requirements" /> | ||
|
|
||
| - 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 configuration below 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: '<YOUR_SCW_SECRET_API_KEY>' | ||
| 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' | ||
| ``` | ||
| <Message type="important"> | ||
| Make sure that you replace `<YOUR_SCW_SECRET_API_KEY>` with your own secret API key. | ||
| </Message> | ||
|
|
||
| 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/ | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.