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

🧹📚 docs: refactor and clean up (#1392)

Browse source 
* 📑 update mkdocs

* rename docker override file and add to gitignore

* update .env.example - GOOGLE_MODELS

* update index.md

* doc refactor: split installation and configuration in two sub-folders

* doc update: installation guides

* doc update: configuration guides

* doc: new docker override guide

* doc: new beginner's guide for contributions - Thanks @Berry-13

* doc: update documentation_guidelines.md

* doc: update testing.md

* doc: update deployment guides

* doc: update /dev readme

* doc: update general_info

* doc: add 0 value to doc weight

* doc: add index.md to every doc folders

* doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md

* doc: update toc so they display properly on the right had side in mkdocs

* doc: update pandoranext.md

* doc: index logging_system.md

* doc: update readme.md

* doc: update litellm.md

* doc: update ./dev/readme.md

* doc:🔖 new presets.md

* doc: minor corrections

* doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs

* doc update: add screenshots to presets.md

* doc update: add screenshots to - OpenID with AWS Cognito

* doc update: BingAI cookie instruction

* doc update: discord auth

* doc update: facebook auth

* doc: corrections to user_auth_system.md

* doc update: github auth

* doc update: google auth

* doc update: auth clean up

* doc organization: installation

* doc organization: configuration

* doc organization: features+plugins & update:plugins screenshots

* doc organization: deploymend + general_info  & update: tech_stack.md

* doc organization: contributions

* doc: minor fixes

* doc: minor fixes
This commit is contained in:
Fuegovic 2023-12-22 08:36:42 -05:00 • committed by GitHub
parent 5c27fa304a
commit 51050cc4d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
66 changed files with 1617 additions and 869 deletions
Download patch file Download diff file Expand all files Collapse all files

67
docker-compose.override.yml.example Normal file
View file

@ -0,0 +1,67 @@
version: '3.4'
# # TO USE THIS FILE, FIRST UNCOMMENT THE FOLLOWING LINE ('services:')
# services:
# # THEN UNCOMMENT ONLY THE SECTION OR SECTIONS CONTAINING THE CHANGES YOU WANT TO APPLY
# # SAVE THIS FILE AS 'docker-compose.override.yaml'
# # AND USE THE 'docker-compose build' & 'docker-compose up -d' COMMANDS AS YOU WOULD NORMALLY DO
# # BUILD FROM LATEST IMAGE
# api:
# image: ghcr.io/danny-avila/librechat-dev:latest
# # BUILD FROM LATEST IMAGE (NUMBERED RELEASE)
# api:
# image: ghcr.io/danny-avila/librechat:latest
# # BUILD FROM LATEST API IMAGE
# api:
# image: ghcr.io/danny-avila/librechat-dev-api:latest
# # BUILD FROM LATEST API IMAGE (NUMBERED RELEASE)
# api:
# image: ghcr.io/danny-avila/librechat-api:latest
# # ADD MONGO-EXPRESS
# mongo-express:
# image: mongo-express
# container_name: mongo-express
# environment:
# ME_CONFIG_MONGODB_SERVER: mongodb
# ME_CONFIG_BASICAUTH_USERNAME: admin
# ME_CONFIG_BASICAUTH_PASSWORD: password
# ports:
# - '8081:8081'
# depends_on:
# - mongodb
# restart: always
# # USE MONGODB V4.4.18 - FOR OLDER CPU WITHOUT AVX SUPPORT
# mongodb:
# image: mongo:4.4.18
# # DISABLE THE MONGODB CONTAINER - YOU NEED TO SET AN ALTERNATIVE MONGODB URI IN THE .ENV FILE
# api:
# environment:
# - MONGO_URI=${MONGO_URI}
# mongodb:
# image: tianon/true
# command: ""
# entrypoint: ""
# # EXPOSE MONGODB PORTS - USE CAREFULLY, THIS MAKES YOUR DATABASE VULNERABLE TO ATTACKS
# mongodb:
# ports:
# - 27018:27017
# # DISABLE MEILISEARCH
# meilisearch:
# profiles:
# - donotstart
# # EXPOSE MEILISEARCH PORTS - DO NOT USE THE DEFAULT VALUE FOR THE MASTER KEY IF YOU DO THIS
# meilisearch:
# ports:
# - 7700:7700