Cannot get Open AI TTS working with librechat.yaml etc

[jhmonroe]

What happened?

Love this project! Thank you so much for creating so we can explore models in one window.

Am trying to add the OpenAI TTS voices as outlined here: https://www.librechat.ai/docs/configuration/stt_tts

I followed and double-checked the steps outlined below but the settings never show up and I get a Docker error pasted below in the output area.

I also searched this repo and saw other issues where you suggested path changes and tried to just change the path to see if anything changed. Same error.

Am I missing something?

Mac here running Docker 4.35.1 and updated to 4.36 to rule that out. :-)

Steps to Reproduce

• copy/rename librechat.yaml in the root as per instructions
• uncommented this:

speech:
  tts:
    openai:
      apiKey: 'API KEY HERE'
      model: 'tts-1'
      voices: ['alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer']

• followed the docker setup instructions to create docker-compose.override.yml with the following uncommented:

version: '3.4'
 
services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

• stopped and restarted the container several times
• still get that warning and still not setting the openAI TTS
• stop containers, remove those 2 files, restart. no errors

What browsers are you seeing the problem on?

No response

Relevant log output

In Docker: "error: Config file YAML format is invalid: ENOENT: no such file or directory, open '/app/librechat.yaml'"

Screenshots

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[danny-avila]

Thanks for the detailed report! This seems to be an issue with Docker not properly mounting your configuration file. Let's try a few things to troubleshoot:

1. First, let's verify your file structure. Make sure your librechat.yaml is in the same directory as your docker-compose.yml file. You can check this with:

ls -la | grep yaml

2. Try using an absolute path in your docker-compose.override.yml:

version: '3.4'
 
services:
  api:
    volumes:
      - type: bind
        source: ${PWD}/librechat.yaml
        target: /app/librechat.yaml

3. You can also try these troubleshooting steps:

   • Check file permissions: chmod 644 librechat.yaml
   • Verify the file contents: cat librechat.yaml
   • Try rebuilding the container:

     docker-compose down
     docker-compose build --no-cache
     docker-compose up

4. To debug the mounting, you can:

   • Check if the file is actually in the container:

     docker-compose exec api ls -la /app/librechat.yaml

   • Look at the container logs:

     docker-compose logs api

Could you try these steps and let me know what you find? Also, could you share:

• The output of pwd in your project directory
• The result of ls -la librechat.yaml

One more important thing to clarify - which compose file are you using as your base? LibreChat has two options:

• docker-compose.yml
• deploy-compose.yml

Could you also share:

1. Which base compose file you're using?
2. The exact commands you're using to start the application?

[jhmonroe]

Answer to your last question:
I was stopping and starting using the STOP/PLAY buttons in Docker Desktop on Mac to avoid doing so much in Terminal 😄

Here is a helpful reminder to include in the documentation before various commands:
Always first navigate to
cd LibreChat
(this was important for me since I run Penpot in Docker also and using the commands you mention above in the Docker Terminal as-is kept stopping and starting all containers, not LibreChat)

Here are some results of this test based on your numbered list above:

1. -rw-r--r--@ 1 myusername staff 9567 Dec 13 18:11 librechat.example.yaml
-rw-r--r--@ 1 myusername staff 9752 Dec 13 19:32 librechat.yaml

2. Done!

---

3. Permissions seem correct. Read-write, read only read only (viewing info on librechat.yaml on Mac get info)
The Terminal command inside cd LibreChat didn't result in any info being printed.
cat librechat.yaml correctly printed the contents.
Rebuilding the container using your Terminal commands inside cd LibreChat seems to have rebooted the system correctly. The cache clearing must have been the trick! Definitely add this to the documentation — great tip! (I don't see it when I search for cache in the Docs)

The "External" sources now show up in Settings and I'm able to select the OpenAI voices and they play correctly (albeit slowly since the chat output has to be sent back to them today. Using TTS on a chat I created just now via gpt4o plays audio much quicker since it must be in gpt's short term cache of the convo)

---

4. DEBUG Results:
WARN[0000] The "UID" variable is not set. Defaulting to a blank string.
WARN[0000] The "GID" variable is not set. Defaulting to a blank string.
WARN[0000] The "UID" variable is not set. Defaulting to a blank string.
WARN[0000] The "GID" variable is not set. Defaulting to a blank string.
WARN[0000] The "UID" variable is not set. Defaulting to a blank string.
WARN[0000] The "GID" variable is not set. Defaulting to a blank string.
WARN[0000] /Users/myusername/LibreChat/docker-compose.override.yml: the attribute version is obsolete, it will be ignored, please remove it to avoid potential confusion
-rw-r--r-- 1 root root 9752 Dec 14 00:32 /app/librechat.yaml

I'm now using Docker 4.36. What should the version be changed to in your override file? Perhaps the documentation is from a version or two ago? Probably not a breaking change tho!

LOGS only warnings:
LibreChat | 2024-12-14 16:49:33 warn: Default value for CREDS_KEY is being used.
LibreChat | 2024-12-14 16:49:33 warn: Default value for CREDS_IV is being used.
LibreChat | 2024-12-14 16:49:33 warn: Default value for JWT_SECRET is being used.
LibreChat | 2024-12-14 16:49:33 warn: Default value for JWT_REFRESH_SECRET is being used.

I went ahead and changed the secret keys inside ENV file. Warning goes away.

---

Documentation Tip: Perhaps in the Setup intro it should list out bullets of any REQUIRED steps for setup if this step is required. It was overlooked by me in the initial setup. https://www.librechat.ai/docs/configuration/authentication#jwt-secret-and-refresh-secret

---

Only Brown Warnings Outputted now (In Docker Desktop), but maybe they're nothing:
2024-12-14 12:15:33 rag_api | USER_AGENT environment variable not set, consider setting it to identify your requests.
2024-12-14 12:15:35 LibreChat | 2024-12-14 17:15:35 info: [Optional] Redis not initialized. Note: Redis support is experimental.
2024-12-14 12:15:35 rag_api | 2024-12-14 17:15:35,699 - root - INFO - Initialized embeddings of type: <class 'langchain_openai.embeddings.base.OpenAIEmbeddings'>
2024-12-14 12:15:35 rag_api | /app/store_factory.py:22: LangChainPendingDeprecationWarning: Please use JSONB instead of JSON for metadata. This change will allow for more efficient querying that involves filtering based on metadata. Please note that filtering operators have been changed when using JSONB metadata to be prefixed with a $ sign to avoid name collisions with columns. If you're using an existing database, you will need to create a db migration for your metadata column to be JSONB and update your queries to use the new operators.
2024-12-14 12:15:35 rag_api | return AsyncPgVector(
2024-12-14 12:15:35 vectordb | 2024-12-14 17:15:35.909 UTC [32] WARNING: there is already a transaction in progress
2024-12-14 12:15:35 vectordb | 2024-12-14 17:15:35.911 UTC [32] WARNING: there is no transaction in progress
2024-12-14 12:15:36 rag_api | 2024-12-14 17:15:36,052 - uvicorn.error - INFO - Started server process [1]
2024-12-14 12:15:36 rag_api | 2024-12-14 17:15:36,053 - uvicorn.error - INFO - Waiting for application startup.
2024-12-14 12:15:36 rag_api | 2024-12-14 17:15:36,054 - uvicorn.error - INFO - Application startup complete.
2024-12-14 12:15:36 rag_api | 2024-12-14 17:15:36,054 - uvicorn.error - INFO - Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)

---

pwd: /Users/myusername/LibreChat
-rw-r--r--@ 1 myusername staff 9752 Dec 13 19:32 librechat.yaml
docker-compose and deploy-compose are both in the project directory. they were downloaded when I ran the initial setup that pulled from github. Not sure which one I'm using since I left all your defaults as-is other than creating the librechat.yaml copy and the override. How do I check that?

Your last two questions I think are covered above?

Thank you! Hope this also helps you as a case study of a user who uses all your defaults, is changing very little, and which things in the Docs are the essentials for non- power users. I'm a front-end/graphic designer, so people like me spend less time in Terminal and more time in GUIs and kind of working in a hybrid way of avoiding Terminal as much as possible! So the REQUIRED steps in setup become very important ... less so than the deeper advanced power user optional configurations deeper in the Docs 😄