Skip to content

Commit 7b50e61

Browse files
authored
docs: general update (danny-avila#781)
* Update windows_install.md * Update linux_install.md * Update mac_install.md * Update docker_install.md * Update linux_install.md * Update windows_install.md * Update README.md * Update breaking_changes.md * Update breaking_changes.md
1 parent 82bbc11 commit 7b50e61

File tree

6 files changed

+31
-21
lines changed

6 files changed

+31
-21
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ Click on the thumbnail to open the video☝️
4848
---
4949

5050
## ⚠️ [Breaking Changes](docs/general_info/breaking_changes.md) ⚠️
51-
**Applies to [v0.5.4](docs/general_info/breaking_changes.md#v054) & [v0.5.5](docs/general_info/breaking_changes.md#v055)**
5251

5352
**Please read this before updating from a previous version**
5453

docs/general_info/breaking_changes.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# ⚠️ **Breaking Changes** ⚠️
22

3+
## v0.5.8
4+
**If you have issues after updating, please try to clear your browser cache and cookies!**
5+
6+
Some of the latest changes affect the cookies and can cause weird behaviors if not properly cleared.
7+
8+
## v0.5.7
9+
10+
Now, we have an easier and safer way to update LibreChat. You can simply run `npm run update` from the project directory for a clean update.
11+
If you want to skip the prompt you can use
12+
13+
for a docker install:
14+
- `npm run update:docker`
15+
16+
for a local install:
17+
- `npm run update:local`
18+
19+
320
## v0.5.5
421
Some users have reported an error after updating their docker containers.
522

docs/install/docker_install.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,7 @@ Once you have completed all the setup, you can start the LibreChat application b
3737
That's it! If you need more detailed information on configuring your compose file, see my notes below.
3838

3939
## Updating LibreChat
40-
To update LibreChat. enter these commands one after the other from the root dir:
41-
- git pull
42-
- docker-compose build
43-
- docker-compose up
40+
- Run `npm run update` from the project directory for a clean installation.
4441

4542
## Advanced Settings
4643

docs/install/linux_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreCha
128128

129129
## Update the app version
130130

131-
If you update the LibreChat project files, manually redo the npm ci and npm run frontend steps.
131+
- Run `npm run update` from the project directory for a clean installation.
132132

133133
---
134134

docs/install/mac_install.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,8 @@ npm run backend
8787

8888

8989
## **Update**
90-
- run `git pull` from the root dir
91-
- Run npm ci from root directory `npm ci`
92-
- Build the client by running `npm run frontend`
90+
91+
- Run `npm run update` from the project directory for a clean installation.
9392

9493
---
9594

docs/install/windows_install.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ Click on the thumbnail to open the video☝️
99
In this video we're going to install LibreChat on Windows 11 using Docker and Git.
1010

1111
#### Timestamps
12-
0:00 - Intro
13-
0:10 - Requirements
14-
0:31 - Docker Installation
15-
1:50 - Git Installation
16-
2:27 - LibreChat Installation
17-
3:07 - Start LibreChat
18-
3:59 - Access to LibreChat
19-
4:23 - Outro
12+
13+
- 0:00 - Intro
14+
- 0:10 - Requirements
15+
- 0:31 - Docker Installation
16+
- 1:50 - Git Installation
17+
- 2:27 - LibreChat Installation
18+
- 3:07 - Start LibreChat
19+
- 3:59 - Access to LibreChat
20+
- 4:23 - Outro
2021

2122
#### Instructions
2223
- To install LibreChat, you need Docker desktop and Git. Download them from these links:
@@ -103,11 +104,8 @@ Have fun!
103104
---
104105

105106
## **Update**
106-
To update LibreChat:
107-
- run `git pull` from the root dir
108-
- Run npm ci from root directory `npm ci`
109-
- Build the client by running `npm run frontend`
110107

108+
- Run `npm run update` from the project directory for a clean installation.
111109

112110
---
113111

0 commit comments

Comments
 (0)