Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
fkohrt opened this issue Mar 23, 2024 · 1 comment
Open
1 task done

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

fkohrt opened this issue Mar 23, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@fkohrt
Copy link
Contributor

fkohrt commented Mar 23, 2024

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

  • I agree to follow this project's Code of Conduct
@fkohrt fkohrt added the enhancement New feature or request label Mar 23, 2024
@fuegovic
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants