From e593b2bc2c5adeca4697d6a8df3cf6b5e8433d02 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Sat, 1 Jun 2024 14:50:15 -0400 Subject: [PATCH] chore: Update baseURL in custom_endpoints.mdx to use host.docker.internal --- pages/docs/quick_start/custom_endpoints.mdx | 20 ++++++++++++++++++-- pages/docs/quick_start/local_setup.mdx | 4 +++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/pages/docs/quick_start/custom_endpoints.mdx b/pages/docs/quick_start/custom_endpoints.mdx index b0ef3ae..a7466cc 100644 --- a/pages/docs/quick_start/custom_endpoints.mdx +++ b/pages/docs/quick_start/custom_endpoints.mdx @@ -49,7 +49,7 @@ services: modelDisplayLabel: "OpenRouter" - name: "Ollama" apiKey: "ollama" - baseURL: "http://localhost:11434/v1/" + baseURL: "http://host.docker.internal:11434/v1/" models: default: [ "llama3:latest", @@ -62,7 +62,23 @@ services: titleModel: "current_model" ``` -## Step 3. Run the App +## Step 3. Configure .env File + +- **Edit your existing `.env` file** at the project root + - Copy `.env.example` and rename to `.env` if it doesn't already exist. +- According to the config above, the environment variable `OPENROUTER_KEY` is expected and should be set: + +```bash +OPENROUTER_KEY=your_openrouter_api_key +``` + +**Notes:** +- As way of example, this guide assumes you have setup Ollama independently and is accessible to you at `http://host.docker.internal:11434` + - "host.docker.internal" is a special DNS name that resolves to the internal IP address used by the host. + - You may need to change this to the actual IP address of your Ollama instance. +- In a future guide, we will go into setting up Ollama along with LibreChat. + +## Step 4. Run the App - Now that your files are configured, you can run the app: diff --git a/pages/docs/quick_start/local_setup.mdx b/pages/docs/quick_start/local_setup.mdx index c047c0a..0fddb76 100644 --- a/pages/docs/quick_start/local_setup.mdx +++ b/pages/docs/quick_start/local_setup.mdx @@ -28,7 +28,9 @@ git clone https://github.com/danny-avila/LibreChat.git 2. **Install**: Open the installer and follow the instructions. 3. **Run**: Open Docker Desktop to ensure it is running. -> Note: Docker Desktop is recommended for most users. If you are looking for an advanced docker/container setup, especially for a remote server installation, see our [Ubuntu Docker Deployment Guide](/docs/remote/docker_linux). +**Notes:** +- Docker Desktop is recommended for most users. If you are looking for an advanced docker/container setup, especially for a remote server installation, see our [Ubuntu Docker Deployment Guide](/docs/remote/docker_linux). +- You may need to restart your computer after installation. ## Step 3. Run the App