From 47d491bf5ed13707c2d3b325321458a872b0568d Mon Sep 17 00:00:00 2001 From: flukexp Date: Tue, 24 Dec 2024 22:45:42 +0700 Subject: [PATCH] updated openrouter and alltalk docs fixed spelling on open router setting page --- docs/SUMMARY.md | 1 + docs/guides/using-alltalk.md | 59 ++++++++++++------- docs/guides/using-openrouter.md | 26 ++++++++ .../settings/OpenRouterSettingsPage.tsx | 4 +- 4 files changed, 67 insertions(+), 23 deletions(-) create mode 100644 docs/guides/using-openrouter.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 9dd82ab..b7d51e2 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -26,6 +26,7 @@ * [Using KoboldCpp](./guides/using-koboldcpp.md) * [Using OpenAI](./guides/using-openai.md) * [Using Oobabooga](./guides/using-oobabooga.md) +* [Using OpenRouter](./guides/using-openrouter.md) ## 🔊 Connecting Speech Options (TTS) diff --git a/docs/guides/using-alltalk.md b/docs/guides/using-alltalk.md index 1baca28..d41eca3 100644 --- a/docs/guides/using-alltalk.md +++ b/docs/guides/using-alltalk.md @@ -3,51 +3,68 @@ title: Using AllTalk order: 14 --- -Navigate to [AllTalk](https://github.com/erew123/alltalk_tts) and follow the instructions below to set up AllTalk using Docker or manually. +You can find the full AllTalk documentation [here](https://github.com/erew123/alltalk_tts/wiki). +Navigate to [AllTalk](https://github.com/erew123/alltalk_tts) and follow the instructions below to set up standalone AllTalk version 2. -## Setting Up AllTalk Locally +## Setting Up Standalone AllTalk Version 2 -### Method 1: Manual Setup +### Windows Instructions -For manual setup, follow the official instructions provided [here](https://github.com/erew123/alltalk_tts/blob/main/README.md#-manual-installation---as-a-standalone-application). +For manual setup, follow the official instructions provided [here](https://github.com/erew123/alltalk_tts/wiki/Install-%E2%80%90-Standalone-Installation). -1. Clone the AllTalk repository: +Do not install this inside another existing Python environments folder. + +1. Open Command Prompt and navigate to your preferred directory: ```bash - git clone https://github.com/erew123/alltalk_tts.git - cd alltalk_tts + cd /d C:\path\to\your\preferred\directory ``` -2. Create conda environment and activated it: +2. Clone the AllTalk repository: ```bash - conda create --name alltalkenv python=3.11.5 - conda activate alltalkenv + git clone -b alltalkbeta https://github.com/erew123/alltalk_tts ``` -3. Install the required dependencies: +3. Navigate to the AllTalk directory: ```bash - pip install -r system/requirements/requirements_standalone.txt + cd alltalk_tts ``` -4. Run the AllTalk server: +4. Run the setup script: ```bash - python script.py + atsetup.bat ``` -5. Access the server at `localhost:7851`. +5. Follow the on-screen prompts: +* Select Standalone Installation and then Option 1. +* Follow any additional instructions to install required files. +* Known installation Errors & fixes are in the [Error-Messages-List Wiki](https://github.com/erew123/alltalk_tts/wiki/Error-Messages-List) + +### Linux Instructions + +1. Open a terminal and navigate to your preferred directory: + ```bash + cd /path/to/your/preferred/directory + ``` -### Method 2: Setup via Docker +2. Clone the AllTalk repository:s + ```bash + git clone -b alltalkbeta https://github.com/erew123/alltalk_tts + ``` -1. Pull the AllTalk Docker image: +3. Navigate to the AllTalk directory: ```bash - docker pull flukexp/alltalkenv + cd alltalk_tts ``` -2. Run the AllTalk Docker container: +4. Run the setup script: ```bash - docker run -d -p 7851:7851 --name alltalk-server flukexp/alltalkenv + ./atsetup.bat ``` -3. The server will be available at `localhost:7851`. +5. Follow the on-screen prompts: +* Select Standalone Installation and then Option 1. +* Follow any additional instructions to install required files. +* Known installation Errors & fixes are in the [Error-Messages-List Wiki](https://github.com/erew123/alltalk_tts/wiki/Error-Messages-List) ## Make sure AllTalk is enabled for TTS: diff --git a/docs/guides/using-openrouter.md b/docs/guides/using-openrouter.md new file mode 100644 index 0000000..a854811 --- /dev/null +++ b/docs/guides/using-openrouter.md @@ -0,0 +1,26 @@ +--- +title: Using OpenRouter +order: 13 +--- + +Navigate to [openrouter.ai](https://openrouter.ai/). Hover over the profile icons on the right-hand side, then select the "Keys" tab from the dropdown menu. Click "Create Key," copy the API key, and paste it into the settings. + +### OpenRouter Configuration + +Set the backend to OpenRouter: + +```bash +Settings -> ChatBot -> ChatBot Backend -> OpenRouter +``` + +Set the API key: + +```bash +Settings -> ChatBot -> OpenRouter -> OpenRouter API Key +``` + +Set the OpenRouter model: + +```bash +Settings -> ChatBot -> OpenRouter -> OpenRouter Model +``` diff --git a/src/components/settings/OpenRouterSettingsPage.tsx b/src/components/settings/OpenRouterSettingsPage.tsx index 40bf3bf..a57ed9e 100644 --- a/src/components/settings/OpenRouterSettingsPage.tsx +++ b/src/components/settings/OpenRouterSettingsPage.tsx @@ -47,7 +47,7 @@ export function OpenRouterSettings({
  • - + ) => { @@ -59,7 +59,7 @@ export function OpenRouterSettings({
  • - + ) => {