Skip to content

Commit 614d9c5

Browse files
authored
📚 documentation update (danny-avila#1307)
* fix .env.example comment out DALLE_API_KEY by default and remove `user_provided` as default value since it is not supported * 📚 docs update
1 parent 6e2221a commit 614d9c5

File tree

5 files changed

+29
-37
lines changed

5 files changed

+29
-37
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
135135

136136
# DALL·E 3
137137
#----------------
138-
DALLE_API_KEY=user_provided
138+
# DALLE_API_KEY=
139139
# DALLE3_SYSTEM_PROMPT="Your System Prompt here"
140140
# DALLE_REVERSE_PROXY=
141141

README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<img
2121
src="https://img.shields.io/badge/DOCS-blue.svg?style=for-the-badge&logo=read-the-docs&logoColor=white&labelColor=000000&logoWidth=20">
2222
</a>
23-
<a aria-label="Sponsors" href="#sponsors">
23+
<a aria-label="Sponsors" href="https://github.com/sponsors/danny-avila">
2424
<img
2525
src="https://img.shields.io/badge/SPONSORS-brightgreen.svg?style=for-the-badge&logo=github-sponsors&logoColor=white&labelColor=000000&logoWidth=20">
2626
</a>
@@ -146,7 +146,6 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
146146
* [Project Roadmap](https://github.com/users/danny-avila/projects/2)
147147
</details>
148148

149-
150149
---
151150

152151
## Star History
@@ -157,18 +156,10 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
157156

158157
---
159158

160-
## Sponsors
161-
162-
Sponsored by <a href="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/mjtechguy"><b>@mjtechguy</b></a>, <a href="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/SphaeroX"><b>@SphaeroX</b></a>, <a href="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/DavidDev1334"><b>@DavidDev1334</b></a>, <a href="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/fuegovic"><b>@fuegovic</b></a>, <a href="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/Pharrcyde"><b>@Pharrcyde</b></a>
163-
164-
---
165-
166159
## Contributors
167160
Contributions and suggestions bug reports and fixes are welcome!
168161
Please read the documentation before you do!
169162

170-
---
171-
172163
For new features, components, or extensions, please open an issue and discuss before sending a PR.
173164

174165
- Join the [Discord community](https://discord.gg/uDyZ5Tzhct)

docs/features/pandoranext.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
If you're looking to use the `ChatGPT` Endpoint in LibreChat, setting up a reverse proxy is a essential. PandoraNext offers a robust solution for this purpose. This guide will walk you through deploying PandoraNext to enable the `CHATGPT_REVERSE_PROXY` for use with LibreChat.
44

5-
> Using this method you will only be able to use `text-davinci-002-render-sha` with PandoraNext in LibreChat. Other models offer with the `plus` subscription do not work.
5+
> Using this method you will only be able to use `text-davinci-002-render-sha` with PandoraNext in LibreChat. Other models offered with the `plus` subscription do not work.
66
77
You can use it locally in docker or deploy it onthe web for remote access.
88

@@ -155,4 +155,5 @@ For local deployment using Docker, the steps are as follows:
155155
## Final Notes
156156

157157
- The `proxy_api_prefix` should be sufficiently random and unique to prevent errors.
158+
- The default `token.json` doesn't need to be modified to use with LibreChat
158159
- Ensure you have obtained a license ID from the [PandoraNext Dashboard](https://dash.pandoranext.com/).

docs/index.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,31 @@
2222
<img
2323
src="https://img.shields.io/badge/GITHUB-blue.svg?style=for-the-badge&logo=github&logoColor=white&labelColor=000000&logoWidth=20">
2424
</a>
25-
<a aria-label="Sponsors" href="#sponsors">
25+
<a aria-label="Sponsors" href="https://github.com/sponsors/danny-avila">
2626
<img
2727
src="https://img.shields.io/badge/SPONSORS-brightgreen.svg?style=for-the-badge&logo=github-sponsors&logoColor=white&labelColor=000000&logoWidth=20">
2828
</a>
2929
</p>
3030

31+
# Features
32+
- 🖥️ UI matching ChatGPT, including Dark mode, Streaming, and 11-2023 updates
33+
- 💬 Multimodal Chat:
34+
- Upload and analyze images with GPT-4-Vision 📸
35+
- More filetypes and Assistants API integration in Active Development 🚧
36+
- 🌎 Multilingual UI:
37+
- English, 中文, Deutsch, Español, Français, Italiano, Polski, Português Brasileiro, Русский
38+
- 日本語, Svenska, 한국어, Tiếng Việt, 繁體中文, العربية, Türkçe, Nederlands
39+
- 🤖 AI model selection: OpenAI API, Azure, BingAI, ChatGPT Browser, PaLM2, Anthropic (Claude), Plugins
40+
- 💾 Create, Save, & Share Custom Presets
41+
- 🔄 Edit, Resubmit, and Continue messages with conversation branching
42+
- 📤 Export conversations as screenshots, markdown, text, json.
43+
- 🔍 Search all messages/conversations
44+
- 🔌 Plugins, including web access, image generation with DALL-E-3 and more
45+
- 👥 Multi-User, Secure Authentication with Moderation and Token spend tools
46+
- ⚙️ Configure Proxy, Reverse Proxy, Docker, many Deployment options, and completely Open-Source
47+
48+
[For a thorough review of our features, see our docs here](https://docs.librechat.ai/features/plugins/introduction.html) 📚
49+
3150
## All-In-One AI Conversations with LibreChat ##
3251
LibreChat brings together the future of assistant AIs with the revolutionary technology of OpenAI's ChatGPT. Celebrating the original styling, LibreChat gives you the ability to integrate multiple AI models. It also integrates and enhances original client features such as conversation and message search, prompt templates and plugins.
3352

@@ -45,43 +64,24 @@ With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use f
4564
</iframe>
4665
</p>
4766

48-
# Features
49-
50-
- Response streaming identical to ChatGPT through server-sent events
51-
- UI from original ChatGPT, including Dark mode
52-
- AI model selection (through 5 endpoints: OpenAI API, BingAI, ChatGPT Browser, PaLM2, Plugins)
53-
- Create, Save, & Share custom presets - [More info on prompt presets here](https://github.com/danny-avila/LibreChat/releases/tag/v0.3.0)
54-
- Edit and Resubmit messages with conversation branching
55-
- Search all messages/conversations - [More info here](https://github.com/danny-avila/LibreChat/releases/tag/v0.1.0)
56-
- Plugins now available (including web access, image generation and more)
57-
58-
---
59-
6067
## ⚠️ [Breaking Changes](general_info/breaking_changes.md) ⚠️
61-
**Applies to [v0.5.4](general_info/breaking_changes.md#v054) & [v0.5.5](general_info/breaking_changes.md#v055)**
6268

6369
**Please read this before updating from a previous version**
6470

6571
---
6672

6773
## Star History
6874

69-
[![Star History Chart](https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date)](https://star-history.com/#danny-avila/LibreChat&Date)
70-
71-
---
72-
73-
## Sponsors
74-
75-
Sponsored by <a href="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/mjtechguy"><b>@mjtechguy</b></a>, <a href="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/SphaeroX"><b>@SphaeroX</b></a>, <a href="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/DavidDev1334"><b>@DavidDev1334</b></a>, <a href="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/fuegovic"><b>@fuegovic</b></a>, <a href="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/Pharrcyde"><b>@Pharrcyde</b></a>
75+
<a href="https://star-history.com/#danny-avila/LibreChat&Date">
76+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date&theme=dark" onerror="this.src='https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date'" />
77+
</a>
7678

7779
---
7880

7981
## Contributors
8082
Contributions and suggestions bug reports and fixes are welcome!
8183
Please read the documentation before you do!
8284

83-
---
84-
8585
For new features, components, or extensions, please open an issue and discuss before sending a PR.
8686

8787
- Join the [Discord community](https://discord.gg/uDyZ5Tzhct)

docs/install/dotenv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,10 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
298298
```
299299

300300
#### DALL-E 3:
301-
- OpenAI API key for DALL-E / DALL-E-3. Set to user_provided to have the user provide their own key when installing the plugin.
301+
- OpenAI API key for DALL-E / DALL-E-3. Leave commented out to have the user provide their own key when installing the plugin. If you want to provide your own key for all users you can uncomment this line and add your OpenAI API key here.
302302

303303
```bash
304-
DALLE_API_KEY=user_provided
304+
# DALLE_API_KEY=
305305
```
306306

307307
- For customization of the DALL-E-3 System prompt, uncomment the following, and provide your own prompt. **(Advanced)**

0 commit comments

Comments
 (0)