From 36d274ca9fd5f282d19daab1effe50afd0d75b44 Mon Sep 17 00:00:00 2001 From: Carl Sutton Date: Tue, 9 Apr 2024 10:13:35 +0200 Subject: [PATCH] chore: remove trailing whitespace --- docs/config-local-ollama.md | 6 +++--- docs/config-local-oobabooga.md | 8 ++++---- docs/customizations.md | 8 ++++---- docs/deploy-analytics.md | 2 +- docs/deploy-docker.md | 2 +- docs/environment-variables.md | 4 ++-- docs/installation.md | 4 ++-- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/config-local-ollama.md b/docs/config-local-ollama.md index 0d526308c..240081942 100644 --- a/docs/config-local-ollama.md +++ b/docs/config-local-ollama.md @@ -13,7 +13,7 @@ _Last updated Dec 16, 2023_ 1. **Ensure Ollama API Server is Running**: Follow the official instructions to get Ollama up and running on your machine - For detailed instructions on setting up the Ollama API server, please refer to the - [Ollama download page](https://ollama.ai/download) and [instructions for linux](https://github.com/jmorganca/ollama/blob/main/docs/linux.md). + [Ollama download page](https://ollama.ai/download) and [instructions for linux](https://github.com/jmorganca/ollama/blob/main/docs/linux.md). 2. **Add Ollama as a Model Source**: In `big-AGI`, navigate to the **Models** section, select **Add a model source**, and choose **Ollama** 3. **Enter Ollama Host URL**: Provide the Ollama Host URL where the API server is accessible (e.g., `http://localhost:11434`) 4. **Refresh Model List**: Once connected, refresh the list of available models to include the Ollama models @@ -37,7 +37,7 @@ _Last updated Dec 16, 2023_ ### โš ๏ธ Network Troubleshooting -If you get errors about the server having trouble connecting with Ollama, please see +If you get errors about the server having trouble connecting with Ollama, please see [this message](https://github.com/enricoros/big-AGI/issues/276#issuecomment-1858591483) on Issue #276. And in brief, make sure the Ollama endpoint is accessible from the servers where you run big-AGI (which could @@ -75,7 +75,7 @@ Then, edit the nginx configuration file `/etc/nginx/sites-enabled/default` and a proxy_set_header Connection 'upgrade'; proxy_set_header Host $host; proxy_cache_bypass $http_upgrade; - + # Disable buffering for the streaming responses proxy_buffering off; } diff --git a/docs/config-local-oobabooga.md b/docs/config-local-oobabooga.md index cb3b0d31b..6c873de52 100644 --- a/docs/config-local-oobabooga.md +++ b/docs/config-local-oobabooga.md @@ -25,15 +25,15 @@ This guide assumes that **big-AGI** is already installed on your system. Note th - Stop the Web UI as we need to modify the startup flags to enable the OpenAI API 2. Enable the **openai extension** - Edit `CMD_FLAGS.txt` - - Make sure that `--listen --api` is present and uncommented + - Make sure that `--listen --api` is present and uncommented 3. Restart text-generation-webui - Double-click on "start" - - You should see something like: + - You should see something like: ``` 2023-12-07 21:51:21 INFO:Loading the extension "openai"... 2023-12-07 21:51:21 INFO:OpenAI-compatible API URL: - - http://0.0.0.0:5000 + + http://0.0.0.0:5000 ... INFO: Uvicorn running on http://0.0.0.0:5000 (Press CTRL+C to quit) Running on local URL: http://0.0.0.0:7860 diff --git a/docs/customizations.md b/docs/customizations.md index 18c7df152..2bce5edf4 100644 --- a/docs/customizations.md +++ b/docs/customizations.md @@ -66,7 +66,7 @@ Test your application thoroughly using local development (refer to README.md for We introduced the `/info/debug` page that provides a detailed overview of the application's environment, including the API keys, environment variables, and other configuration settings. -
+
## Community Projects - Share Your Project @@ -74,12 +74,12 @@ After deployment, share your project with the community. We will link to your pr | Project | Features | GitHub | |----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| -| ๐Ÿš€ CoolAGI: Where AI meets Imagination
![CoolAGI Logo](https://github.com/nextgen-user/freegpt4plus/assets/150797204/9b0e1232-4791-4d61-b949-16f9eb284c22) | Code Interpreter, Vision, Mind maps, Web Searches, Advanced Data Analytics, Large Data Handling and more! | [nextgen-user/CoolAGI](https://github.com/nextgen-user/CoolAGI) | -| HL-GPT | Fully remodeled UI | [harlanlewis/nextjs-chatgpt-app](https://github.com/harlanlewis/nextjs-chatgpt-app) | +| ๐Ÿš€ CoolAGI: Where AI meets Imagination
![CoolAGI Logo](https://github.com/nextgen-user/freegpt4plus/assets/150797204/9b0e1232-4791-4d61-b949-16f9eb284c22) | Code Interpreter, Vision, Mind maps, Web Searches, Advanced Data Analytics, Large Data Handling and more! | [nextgen-user/CoolAGI](https://github.com/nextgen-user/CoolAGI) | +| HL-GPT | Fully remodeled UI | [harlanlewis/nextjs-chatgpt-app](https://github.com/harlanlewis/nextjs-chatgpt-app) | For public projects, update your README.md with your modifications and submit a pull request to add your project to our list, aiding in its discovery. -
+
## Best Practices diff --git a/docs/deploy-analytics.md b/docs/deploy-analytics.md index 87c4852d9..6388bb935 100644 --- a/docs/deploy-analytics.md +++ b/docs/deploy-analytics.md @@ -53,7 +53,7 @@ As of Feb 27, 2024, this feature is in development. ## Configurations -| Scope | Default | Description / Instructions | +| Scope | Default | Description / Instructions | |-----------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------| | Your source builds of big-AGI | None | **Vercel**: enable Vercel Analytics from the dashboard. ยท **Google Analytics**: set environment variable at build time. | | Your docker builds of big-AGI | None | **Vercel**: n/a. ยท **Google Analytics**: set environment variable at `docker build` time. | diff --git a/docs/deploy-docker.md b/docs/deploy-docker.md index 2ca0d862f..ae502a0fc 100644 --- a/docs/deploy-docker.md +++ b/docs/deploy-docker.md @@ -9,7 +9,7 @@ Docker ensures faster development cycles, easier collaboration, and seamless env ```bash git clone https://github.com/enricoros/big-agi.git cd big-agi - ``` + ``` 2. **Build the Docker Image**: Build a local docker image from the provided Dockerfile: ```bash docker build -t big-agi . diff --git a/docs/environment-variables.md b/docs/environment-variables.md index 117ec4c06..7e8130dcf 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -91,7 +91,7 @@ requiring the user to enter an API key | `ANTHROPIC_API_HOST` | Changes the backend host for the Anthropic vendor, to enable platforms such as [config-aws-bedrock.md](config-aws-bedrock.md) | Optional | | `GEMINI_API_KEY` | The API key for Google AI's Gemini | Optional | | `GROQ_API_KEY` | The API key for Groq Cloud | Optional | -| `LOCALAI_API_HOST` | Sets the URL of the LocalAI server, or defaults to http://127.0.0.1:8080 | Optional | +| `LOCALAI_API_HOST` | Sets the URL of the LocalAI server, or defaults to http://127.0.0.1:8080 | Optional | | `LOCALAI_API_KEY` | The (Optional) API key for LocalAI | Optional | | `MISTRAL_API_KEY` | The API key for Mistral | Optional | | `OLLAMA_API_HOST` | Changes the backend host for the Ollama vendor. See [config-local-ollama.md](config-local-ollama) | | @@ -128,7 +128,7 @@ Enable the app to Talk, Draw, and Google things up. | `GOOGLE_CSE_ID` | Google Custom/Programmable Search Engine ID - [Link to PSE](https://programmablesearchengine.google.com/) | | **Browse** | | | `PUPPETEER_WSS_ENDPOINT` | Puppeteer WebSocket endpoint - used for browsing (pade downloadeing), etc. | -| **Backend** | | +| **Backend** | | | `BACKEND_ANALYTICS` | Semicolon-separated list of analytics flags (see backend.analytics.ts). Flags: `domain` logs the responding domain. | | `HTTP_BASIC_AUTH_USERNAME` | See the [Authentication](deploy-authentication.md) guide. Username for HTTP Basic Authentication. | | `HTTP_BASIC_AUTH_PASSWORD` | Password for HTTP Basic Authentication. | diff --git a/docs/installation.md b/docs/installation.md index e4225fb8d..c7afcbe25 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -90,10 +90,10 @@ or follow the steps below for a quick start. ```bash # 2A. if you built the image yourself: docker run -d -p 3000:3000 big-agi - + # 2B. or use the pre-built image: docker run -d -p 3000:3000 ghcr.io/enricoros/big-agi - + # 2C. or use docker-compose: docker-compose up ```