Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cogentapps committed Apr 15, 2023
1 parent fbbb73a commit ee7ee89
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Chat with GPT is an open-source, unofficial ChatGPT app with extra features and more ways to customize your experience. It connects ChatGPT with ElevenLabs to give ChatGPT a realistic human voice.

Try out the hosted version at: https://chatwithgpt.netlify.app
Try out the hosted version at: https://www.chatwithgpt.ai

Or [self-host with Docker](#running-on-your-own-computer).

Expand All @@ -16,8 +16,8 @@ https://user-images.githubusercontent.com/127109874/223613258-0c4fef2e-1d05-43a1
- πŸ”Ž **Search** through your past chat conversations.
- πŸ“„ View and customize the System Prompt - the **secret prompt** the system shows the AI before your messages.
- 🌑 Adjust the **creativity and randomness** of responses by setting the Temperature setting. Higher temperature means more creativity.
- πŸ’¬ Give ChatGPT AI a **realistic human voice** by connecting your ElevenLabs text-to-speech account.
- 🎀 **Speech recognition** powered by OpenAI Whisper
- πŸ’¬ Give ChatGPT AI a **realistic human voice** by connecting your ElevenLabs text-to-speech account, or using your browser's built-in text-to-speech.
- 🎀 **Speech recognition** powered by OpenAI Whisper.
- βœ‰ **Share** your favorite chat sessions online using public share URLs.
- πŸ“‹ Easily **copy-and-paste** ChatGPT messages.
- ✏️ Edit your messages
Expand Down Expand Up @@ -49,6 +49,24 @@ docker run -v $(pwd)/data:/app/data -p 3000:3000 ghcr.io/cogentapps/chat-with-gp

Then navigate to http://localhost:3000 to view the app.

### Store your API keys on the server

For convenience, you can store your API keys on your computer instead of entering them in the browser.

*Warning:* Be very careful doing this if anyone else has access to your self-hosted version of the app. They will be able to use the app through your API key as well.

Create a file called `config.yaml` in your `data` folder with the following contents:

```
services:
openai:
apiKey: (your api key)
elevenlabs:
apiKey: (your api key)
```

and restart the server. Login is required.

## Updating

```
Expand Down

0 comments on commit ee7ee89

Please sign in to comment.