Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-09-22 06:00:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
LibreChat/docs/dev/README.md
Fuegovic bce4f41fae
🪪mkdocs: social cards (#1428) 
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder

* docs: fix hyperlinks

* mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides

* mkdocs: social cards (descriptions) for all 'index.md'

* mkdocs: social cards (descriptions) for 'features' and 'plugins'

* mkdocs: social cards (descriptions) for 'general_info'

* mkdocs: social cards (descriptions) for 'configuration'

* mkdocs: social cards (descriptions) for 'installation'

* mkdocs: minor fixes

* update librechat.svg

* update how_to_contribute.md

add reference to the official GitHub documentation
2023-12-28 17:10:06 -05:00

1.9 KiB
Raw Blame History

title weight
Dev Resources 6

Dev Resources

Please consult: Contributing to LibreChat for more information on the subject.

This directory: ./docs/dev, 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.

deploy-compose.yml

  • Similar to above, but with basic configuration for deployment to a cloud provider where multi-container compose works
    • Tested and working on a $6 droplet on DigitalOcean, just by visiting the http://server-ip/9000.
    • Not a scalable solution, but ideal for quickly hosting on a remote linux server.
    • You should adjust server_name localhost; to match your domain name, replacing localhost, as needed.
  • From root dir of the project, run docker-compose -f ./docs/dev/deploy-compose.yml up --build
    • When you don't need to build, run docker-compose -f ./docs/dev/deploy-compose.yml up
  • Unlike the single-compose file, this containerizes both MongoDB and Meilisearch, as they are already setup for you.