From db3cea446e323c053ca2ffb8bb92fadd63b857db Mon Sep 17 00:00:00 2001 From: ItzCrazyKns <95534749+ItzCrazyKns@users.noreply.github.com> Date: Sat, 15 Feb 2025 12:33:43 +0530 Subject: [PATCH] Update UPDATING.md --- docs/installation/UPDATING.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/installation/UPDATING.md b/docs/installation/UPDATING.md index b41b05a..a4651df 100644 --- a/docs/installation/UPDATING.md +++ b/docs/installation/UPDATING.md @@ -7,34 +7,43 @@ To update Perplexica to the latest version, follow these steps: 1. Clone the latest version of Perplexica from GitHub: ```bash - git clone https://github.com/ItzCrazyKns/Perplexica.git + git clone https://github.com/ItzCrazyKns/Perplexica.git ``` -2. Navigate to the Project Directory. +2. Navigate to the project directory. -3. Pull latest images from registry. +3. Check for changes in the configuration files. If the `sample.config.toml` file contains new fields, delete your existing `config.toml` file, rename `sample.config.toml` to `config.toml`, and update the configuration accordingly. + +4. Pull the latest images from the registry. ```bash docker compose pull ``` -4. Update and Recreate containers. +5. Update and recreate the containers. ```bash docker compose up -d ``` -5. Once the command completes running go to http://localhost:3000 and verify the latest changes. +6. Once the command completes, go to http://localhost:3000 and verify the latest changes. -## For non Docker users +## For non-Docker users 1. Clone the latest version of Perplexica from GitHub: ```bash - git clone https://github.com/ItzCrazyKns/Perplexica.git + git clone https://github.com/ItzCrazyKns/Perplexica.git ``` -2. Navigate to the Project Directory -3. Execute `npm i` in both the `ui` folder and the root directory. -4. Once packages are updated, execute `npm run build` in both the `ui` folder and the root directory. -5. Finally, start both the frontend and the backend by running `npm run start` in both the `ui` folder and the root directory. +2. Navigate to the project directory. + +3. Check for changes in the configuration files. If the `sample.config.toml` file contains new fields, delete your existing `config.toml` file, rename `sample.config.toml` to `config.toml`, and update the configuration accordingly. + +4. Execute `npm i` in both the `ui` folder and the root directory. + +5. Once the packages are updated, execute `npm run build` in both the `ui` folder and the root directory. + +6. Finally, start both the frontend and the backend by running `npm run start` in both the `ui` folder and the root directory. + +---