LibreChat/docs/dev
Danny Avila 2a2e6d9991
docs(dev): update README.md with instructions for using single-compose.yml (#676)
feat(single-compose.yml): add single-compose.yml for building leaner app container without meilisearch and mongodb services
- This is useful for deploying on Google, Azure, etc., as a single, leaner container.
- Instructions for running the container are added to the README.md file.
- The container requires a MongoDB Atlas connection string for the `MONGO_URI` environment variable.
- Remote Meilisearch may also be possible, but is not tested.
2023-07-21 20:11:05 -04:00
..
Dockerfile-app update: "documents" folder to "docs" (#391) 2023-05-27 07:03:28 -04:00
eslintrc-stripped.js ci(backend-review.yml): add linter step to the backend review workflow (#625) 2023-07-14 09:36:49 -04:00
meilisearch.yml update: "documents" folder to "docs" (#391) 2023-05-27 07:03:28 -04:00
README.md docs(dev): update README.md with instructions for using single-compose.yml (#676) 2023-07-21 20:11:05 -04:00
single-compose.yml docs(dev): update README.md with instructions for using single-compose.yml (#676) 2023-07-21 20:11:05 -04:00

Dev

This directory contains files used for developer work

Dockerfile-app:

  • used to build the DockerHub image

eslintrc-stripped.js:

  • alternate linting rules, used in development

meilisearch.yml:

  • Dockerfile for building meilisearch image independently from project

single-compose.yml:

  • Dockerfile for building app image without meilisearch and mongodb services
    • This is useful for deploying on Google, Azure, etc., as a single, leaner container.
  • From root dir of the project, run docker-compose -f ./docs/dev/single-compose.yml up --build
    • When you don't need to build, run docker-compose -f ./docs/dev/single-compose.yml up
  • This requires you use a MongoDB Atlas connection string for the MONGO_URI env var
    • A URI string to a mongodb service accessible to your container is also possible.
    • Remote Meilisearch may also be possible in the same manner, but is not tested.