mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-24 20:30:13 +01:00
7b2cedf5ff
* refactor: require Auth middleware in route index files * feat: concurrent message limiter * feat: complete concurrent message limiter with caching * refactor: SSE response methods separated from handleText * fix(abortMiddleware): fix req and res order to standard, use endpointOption in req.body * chore: minor name changes * refactor: add isUUID condition to saveMessage * fix(concurrentLimiter): logic correctly handles the max number of concurrent messages and res closing/finalization * chore: bump keyv and remove console.log from Message * fix(concurrentLimiter): ensure messages are only saved in later message children * refactor(concurrentLimiter): use KeyvFile instead, could make other stores configurable in the future * feat: add denyRequest function for error responses * feat(utils): add isStringTruthy function Introduce the isStringTruthy function to the utilities module to check if a string value is a case-insensitive match for 'true' * feat: add optional message rate limiters by IP and userId * feat: add optional message rate limiters by IP and userId to edit route * refactor: rename isStringTruthy to isTrue for brevity * refactor(getError): use map to make code cleaner * refactor: use memory for concurrent rate limiter to prevent clearing on startup/exit, add multiple log files, fix error message for concurrent violation * feat: check if errorMessage is object, stringify if so * chore: send object to denyRequest which will stringify it * feat: log excessive requests * fix(getError): correctly pluralize messages * refactor(limiters): make type consistent between logs and errorMessage * refactor(cache): move files out of lib/db into separate cache dir >> feat: add getLogStores function so Keyv instance is not redundantly created on every violation feat: separate violation logging to own function with logViolation * fix: cache/index.js export, properly record userViolations * refactor(messageLimiters): use new logging method, add logging to registrations * refactor(logViolation): make userLogs an array of logs per user * feat: add logging to login limiter * refactor: pass req as first param to logViolation and record offending IP * refactor: rename isTrue helper fn to isEnabled * feat: add simple non_browser check and log violation * fix: open handles in unit tests, remove KeyvMongo as not used and properly mock global fetch * chore: adjust nodemon ignore paths to properly ignore logs * feat: add math helper function for safe use of eval * refactor(api/convos): use middleware at top of file to avoid redundancy * feat: add delete all static method for Sessions * fix: redirect to login on refresh if user is not found, or the session is not found but hasn't expired (ban case) * refactor(getLogStores): adjust return type * feat: add ban violation and check ban logic refactor(logViolation): pass both req and res objects * feat: add removePorts helper function * refactor: rename getError to getMessageError and add getLoginError for displaying different login errors * fix(AuthContext): fix type issue and remove unused code * refactor(bans): ban by ip and user id, send response based on origin * chore: add frontend ban messages * refactor(routes/oauth): add ban check to handler, also consolidate logic to avoid redundancy * feat: add ban check to AI messaging routes * feat: add ban check to login/registration * fix(ci/api): mock KeyvMongo to avoid tests hanging * docs: update .env.example > refactor(banViolation): calculate interval rate crossover, early return if duration is invalid ci(banViolation): add tests to ensure users are only banned when expected * docs: improve wording for mod system * feat: add configurable env variables for violation scores * chore: add jsdoc for uaParser.js * chore: improve ban text log * chore: update bun test scripts * refactor(math.js): add fallback values * fix(KeyvMongo/banLogs): refactor keyv instances to top of files to avoid memory leaks, refactor ban logic to use getLogStores instead refactor(getLogStores): get a single log store by type * fix(ci): refactor tests due to banLogs changes, also make sure to clear and revoke sessions even if ban duration is 0 * fix(banViolation.js): getLogStores import * feat: handle 500 code error at login * fix(middleware): handle case where user.id is _id and not just id * ci: add ban secrets for backend unit tests * refactor: logout user upon ban * chore: log session delete message only if deletedCount > 0 * refactor: change default ban duration (2h) and make logic more clear in JSDOC * fix: login and registration limiters will now return rate limiting error * fix: userId not parsable as non ObjectId string * feat: add useTimeout hook to properly clear timeouts when invoking functions within them refactor(AuthContext): cleanup code by using new hook and defining types in ~/common * fix: login error message for rate limits * docs: add info for automated mod system and rate limiters, update other docs accordingly * chore: bump data-provider version
135 lines
4.2 KiB
YAML
135 lines
4.2 KiB
YAML
# Project information
|
|
site_name: LibreChat
|
|
|
|
# Repository
|
|
repo_name: danny-avila/LibreChat
|
|
repo_url: https://github.com/danny-avila/LibreChat
|
|
#edit_uri: ''
|
|
edit_uri: blob/main/docs/
|
|
|
|
#set use_directory_urls to false to make the HTML embed use the same relative paths as in GitHub
|
|
use_directory_urls: false
|
|
|
|
theme:
|
|
name: material
|
|
logo: assets/LibreChat.svg
|
|
favicon: assets/favicon_package/favicon-32x32.png
|
|
|
|
palette:
|
|
|
|
# Palette toggle for dark mode
|
|
- scheme: slate
|
|
primary: cyan
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
|
|
# Palette toggle for light mode
|
|
- scheme: default
|
|
primary: cyan
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
edit: material/pencil
|
|
view: material/eye
|
|
|
|
features:
|
|
- header.autohide
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- content.action.edit
|
|
- content.code.copy
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.expand
|
|
# - navigation.sections
|
|
|
|
# For more Styling options (not in use)
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- admonition
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- footnotes
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.mark
|
|
- attr_list
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
|
|
# Page tree
|
|
nav:
|
|
- Home:
|
|
- 'index.md'
|
|
- v0.5.0 Breaking Changes: 'general_info/breaking_changes.md'
|
|
- Project Origin: 'general_info/project_origin.md'
|
|
- Tech Stack: 'general_info/tech_stack.md'
|
|
- Multilingual Information: 'general_info/multilingual_information.md'
|
|
- Installation Guides:
|
|
- Installation:
|
|
- Docker (Compose) Install: 'install/docker_compose_install.md'
|
|
- Container Install: 'install/container_install.md'
|
|
- Linux Install: 'install/linux_install.md'
|
|
- Mac Install: 'install/mac_install.md'
|
|
- Windows Install: 'install/windows_install.md'
|
|
- Configuration:
|
|
- Free AI APIs: 'install/free_ai_apis.md'
|
|
- APIs and Tokens: 'install/apis_and_tokens.md'
|
|
- User Auth System: 'install/user_auth_system.md'
|
|
- Online MongoDB Database: 'install/mongodb.md'
|
|
- Languages: 'install/default_language.md'
|
|
- Features:
|
|
- Plugins:
|
|
- Introduction: 'features/plugins/introduction.md'
|
|
- Google: 'features/plugins/google_search.md'
|
|
- Stable Diffusion: 'features/plugins/stable_diffusion.md'
|
|
- Wolfram: 'features/plugins/wolfram.md'
|
|
- Azure Cognitive Search: 'features/plugins/azure_cognitive_search.md'
|
|
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
|
|
- Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md'
|
|
- Automated Moderation: 'features/mod_system.md'
|
|
- Third-Party Tools: 'features/third_party.md'
|
|
- Proxy: 'features/proxy.md'
|
|
- Bing Jailbreak: 'features/bing_jailbreak.md'
|
|
- Cloud Deployment:
|
|
- DigitalOcean (preferred): 'deployment/digitalocean.md'
|
|
- Cloudflare: 'deployment/cloudflare.md'
|
|
- Hetzner: 'deployment/hetzner_ubuntu.md'
|
|
- Heroku: 'deployment/heroku.md'
|
|
- Linode: 'deployment/linode.md'
|
|
- Ngrok: 'deployment/ngrok.md'
|
|
- Render: 'deployment/render.md'
|
|
- Azure (Terraform): 'deployment/azure-terraform.md'
|
|
- HuggingFace: 'deployment/huggingface.md'
|
|
- Contributions:
|
|
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
|
|
- Contribute a Translation: 'contributions/translation_contribution.md'
|
|
- Code Standards and Conventions: 'contributions/coding_conventions.md'
|
|
- Testing: 'contributions/testing.md'
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/discord
|
|
link: https://discord.gg/CEe6vDg9Ky
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/danny-avila/LibreChat
|
|
- icon: fontawesome/brands/youtube
|
|
link: https://www.youtube.com/@LibreChat
|
|
|
|
copyright:
|
|
© 2023 <a href="https://github.com/danny-avila/LibreChat" target="_blank" rel="noopener">LibreChat</a>
|