Skip to content

Conversation

fuegovic
Copy link
Collaborator

@fuegovic fuegovic commented Dec 2, 2023

🧹 Refactor .env.example and Add dotenv.md for Enhanced Config Clarity 👓

Pull Request Summary

Motivation

  • The .env file has grown to nearly 500 lines, making it difficult to locate specific keys.
  • The mix of instructions with commented out key/value pairs made it confusing .

Changes

  • Documentation: Shifted all comments and instructions to dotenv.md.
    • The new document includes all comments from .env.example.
    • Contains links to related documentation.
    • Organized in the same order as the new .env.example.
  • Organization: Improved variable organization with clear categories/sub-categories.
  • Ordering: Alphabetized lists where applicable (endpoints, plugins, social providers).
  • Default Configuration Changes:
    • MongoDB port to 27017.
    • Disabled the ChatGPT endpoint.
  • Variables: Added missing .env variables.
    • Omitted E2B and codesherpa due to deprecation.
    • I suggests removing them as well as Code Interpreter from the main fork.
      • Side Note: Having proper documentation on how to add them yourself would be more appropriate than including them in the project, since having them included makes it look like we can currently offer support for these plugins

Impact

  • Reduced .env.example from 470 lines to 286 lines.

Tests

  • Validate all hyperlinks from mkdocs
  • Made sure that the .env.example can be used as-is for the docker install

Additional Notes

Screenshots

  • .env.example:
Before After
image image
  • dotenv.md Table of content:

image

@berry-13
Copy link
Collaborator

berry-13 commented Dec 2, 2023

I suggests removing them as well as Code Interpreter from the main fork.
Side Note: Having proper documentation on how to add them yourself would be more appropriate than including them in the project, since having them included makes it look like we can currently offer support for these plugins

I confirm, I also think that we need to remove certain plugins 💯

@danny-avila danny-avila merged commit 9d21d1c into danny-avila:main Dec 3, 2023
@fuegovic fuegovic deleted the env branch December 7, 2023 18:42
shortpoet pushed a commit to shortpoet/LibreChat that referenced this pull request Dec 30, 2023
cnkang pushed a commit to cnkang/LibreChat that referenced this pull request Feb 6, 2024
BertKiv pushed a commit to BertKiv/LibreChat that referenced this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants