search

danny-avila / LibreChat

Enhanced ChatGPT Clone: Features Anthropic, AWS, OpenAI, Assistants API, Azure, Groq, o1, GPT-4o, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, langchain, DALL-E-3, ChatGPT Plugins, OpenAI Functions, Secure Multi-User System, Presets, completely open-source for self-hosting. Actively in public development.
https://librechat.ai/
MIT License
18.95k stars 3.15k forks source link

Enhancement: Mention necessities when installing own plugins in docs #2182

Closed fkohrt closed 2 weeks ago

fkohrt commented 7 months ago

What features would you like to see added?

I found the LibreChat documentation to be very comprehensive and helpful! One thing I noticed concerns the installation of own plugins: As far as I understand it, when one adds a manifest file to api/app/clients/tools/.well-known (as described by the page “Using official ChatGPT Plugins / OpenAPI specs”), changes need to be made to docker-compose.override.yml.

More details

If I just restart the Docker service, the new file doesn't show up within the restarted Docker container (and consequently, the plugin doesn't show up in the plugin store in the UI), given that I started with the pre-provided docker-compose.override.yml. I needed to also copy the file to the Docker image, which I did by configuring the following:

services:

# USE LIBRECHAT CONFIG FILE
  api:
    volumes:
      - ./librechat.yaml:/app/librechat.yaml
      - ./api/app/clients/tools/.well-known:/app/api/app/clients/tools/.well-known # <----- this line needed to be added

But I reckon one could also uncomment the following lines:

# # LOCAL BUILD
#   api:
#     image: librechat
#     build:
#       context: .
#       target: node

In any way, I suggest the documentation to be a little more specific about this necessity, as it is very comprehensive in other regards and newbies might stumble upon this.

Thanks for developing and maintaining such a nice piece of software!

Which components are impacted by your request?

Documentation

Pictures

No response

Code of Conduct

fuegovic commented 7 months ago

You are absolutely right! We recently switched the default from "build" to the "pre-built" librechat-dev image, and this has not been updated to reflect the changes