LibreChat/docs/dev/README.md

# 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.
### 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.
Docs: updates & enhancements for MKDocs (#555) * Update documents for mkdocs compatibility * documents update * documents update * Update README.md * Update README.md add link to "https://docs.librechat.ai" on the logo * document updates * docs - badge updates * docs - badge updates * docs - badge updates * Update docker_install.md * Update .env.example update default MONGO_URI to port 27018 so local install can communicate with the docker db * Update windows_install.md fix typo 2023-07-01 20:11:37 -04:00			`# Dev`
			`This directory contains files used for developer work`
Cleanup root dir, move dev-related files into /documents/ (#347) * chore: cleanup root dir and move extraneous dev related files to documents/dev * chore: cleanup root dir and move extraneous dev related files to documents/dev 2023-05-21 08:56:06 -04:00
Docs: updates & enhancements for MKDocs (#555) * Update documents for mkdocs compatibility * documents update * documents update * Update README.md * Update README.md add link to "https://docs.librechat.ai" on the logo * document updates * docs - badge updates * docs - badge updates * docs - badge updates * Update docker_install.md * Update .env.example update default MONGO_URI to port 27018 so local install can communicate with the docker db * Update windows_install.md fix typo 2023-07-01 20:11:37 -04:00			`### Dockerfile-app:`
			`- used to build the DockerHub image`
			`### eslintrc-stripped.js:`
			`- alternate linting rules, used in development`
			`### meilisearch.yml:`
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 17:11:05 -07:00			`- 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.`
feat: docker-compose deployment file (#706) * feat(deploy-compose.yml): add docker-compose file for development deployment A new docker-compose file has been added for development deployment. This file defines the services required for running the application in a development environment. The services include a client service running nginx, an api service running the LibreChat application, a mongodb service for the database, and a meilisearch service for search functionality. The client service is configured to use the latest version of the nginx image, with port 3080 mapped to port 80. It also mounts the nginx.conf file and the client's node_modules directory. The api service is named LibreChat and is built from the librechat image. It exposes port 9000 and depends on the mongodb service. It also mounts the api directory, the .env files, and the client's node_modules directory. The mongodb service is named chat-mongodb and uses the mongo image. It exposes port 27018 and mounts the data-node directory for data storage * chore(deploy-compose.yml): update env_file path to ../../.env * chore(deploy-compose.yml): update image name to librechat_deploy chore(deploy-compose.yml): update build context to ../../ * chore(deploy-compose.yml): update image and comment out build section The image for the service has been updated to `ghcr.io/danny-avila/librechat:latest`. The build section has been commented out as it is no longer needed. * refactor(nginx.conf): reformat nginx.conf for better readability and maintainability * chore(nginx.conf): add worker_connections configuration to events block chore(nginx.conf): add listen configuration to server block * chore(deploy-compose.yml): update nginx container ports configuration feat(deploy-compose.yml): add support for HTTPS by exposing port 443 * docs(dev/README.md): add instructions for deploying with deploy-compose.yml * docs(dev/README.md): update instructions for deploying with deploy-compose.yml 2023-07-26 12:57:26 -04:00			`- 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.`