aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorben2023-03-04 22:22:22 +0100
committerben2025-03-04 21:37:38 +0100
commitf3eae794ace20d10edc4e970ce6258a47fb3b4d9 (patch)
treea663334c0e2716bcd4beaceb29891c0c5cb1468e /README.md
parent0f09f3fbb4df6849548007de481528974ba55579 (diff)
downloadai_env-f3eae794ace20d10edc4e970ce6258a47fb3b4d9.tar.gz
ai_env-f3eae794ace20d10edc4e970ce6258a47fb3b4d9.tar.bz2
ai_env-f3eae794ace20d10edc4e970ce6258a47fb3b4d9.tar.xz
Remove STT feature (not fully offline)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7df591c..cc6a3e6 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,6 @@ No cloud. No GAFAM. Just full privacy, control, and the freedom to manipulate co
* [Ollama](https://ollama.com/) run language models on the local machine.
* [openedai-speech](https://github.com/matatonic/openedai-speech) provides text-to-speech capability.
-* [speaches-ai](https://github.com/speaches-ai/speaches) provide transcription, translation, and speech generation.
* [nginx](https://nginx.org/en/) add an authentication to the API.
* [AIChat](https://github.com/sigoden/aichat) is used as LLM CLI tool featuring Shell Assistant, Chat-REPL, RAG, AI Tools & Agents.
@@ -47,6 +46,12 @@ Add an API key to secure server access by adding a `.env` file like this:
LLM_API_KEY=1234567890
```
+Create a user authentication for aichat web UI:
+
+```
+htpasswd -c src/nginx/htpasswd user
+```
+
Next, start the servers and their configuration with Docker Compose:
```bash
@@ -92,13 +97,12 @@ aichat -r short "tcp port of mysql"
Go to the [AIChat](https://github.com/sigoden/aichat) website for other possible use cases.
-### Text To Speech & Speech To Text
+### Text To Speech
-For these two features, use the speech.sh script like this:
+For this features, use the speech.sh script like this:
```
./speech.sh synthesize --play --lang fr --voice pierre "Bonjour, aujourd'hui nous somme le $(date +%A\ %d\ %B\ %Y)."
-./speech.sh transcript --lang fr --filename speech.wav
```
## How to Use Remotely
@@ -109,11 +113,10 @@ By adding a reverse proxy like Caddy in front of it, you can also add TLS encryp
This way, you can securely use this environment remotely.
-To use script tools in a remote context, use the environment variables TTS_API_HOST and STT_API_HOST and modify AIChat config (~/.config/aichat/config.yaml) .
+To use script tools in a remote context, use the environment variables TTS_API_HOST and modify AIChat config (~/.config/aichat/config.yaml) .
Example:
```
export TTS_API_HOST="https://your-remote-domain"
-export STT_API_HOST="https://your-remote-domain"
./tools/speech.sh ...
```