Skip to content

Commit

Permalink
Added docs for OpenRouter, and Alltalk V2
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
slowsynapse authored Dec 31, 2024
2 parents d17d38a + 47d491b commit 15ceccf
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 23 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
59 changes: 38 additions & 21 deletions docs/guides/using-alltalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
26 changes: 26 additions & 0 deletions docs/guides/using-openrouter.md
Original file line number Diff line number Diff line change
@@ -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
```
4 changes: 2 additions & 2 deletions src/components/settings/OpenRouterSettingsPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export function OpenRouterSettings({
</FormRow>
</li>
<li className="py-4">
<FormRow label="OpenAI URL">
<FormRow label="OpenRouter URL">
<TextInput
value={openRouterUrl}
onChange={(event: React.ChangeEvent<any>) => {
Expand All @@ -59,7 +59,7 @@ export function OpenRouterSettings({
</FormRow>
</li>
<li className="py-4">
<FormRow label="OpenAI Model">
<FormRow label="OpenRouter Model">
<TextInput
value={openRouterModel}
onChange={(event: React.ChangeEvent<any>) => {
Expand Down

0 comments on commit 15ceccf

Please sign in to comment.