From 8b552010f9eabdd2f4ca326f094a7d77c92e8a40 Mon Sep 17 00:00:00 2001 From: ItzCrazyKns <95534749+ItzCrazyKns@users.noreply.github.com> Date: Thu, 20 Mar 2025 12:33:15 +0530 Subject: [PATCH] feat(docs): update docs --- README.md | 9 ++- docs/installation/NETWORKING.md | 109 -------------------------------- docs/installation/UPDATING.md | 9 +-- 3 files changed, 7 insertions(+), 120 deletions(-) delete mode 100644 docs/installation/NETWORKING.md diff --git a/README.md b/README.md index fecb3e8..6540c73 100644 --- a/README.md +++ b/README.md @@ -109,14 +109,13 @@ There are mainly 2 ways of installing Perplexica - With Docker, Without Docker. 1. Install SearXNG and allow `JSON` format in the SearXNG settings. 2. Clone the repository and rename the `sample.config.toml` file to `config.toml` in the root directory. Ensure you complete all required fields in this file. -3. Rename the `sample.config.toml` file to `config.toml`. -4. After populating the configuration run `npm i`. -5. Install the dependencies and then execute `npm run build`. -6. Finally, start the app by running `npm rum start` +3. After populating the configuration run `npm i`. +4. Install the dependencies and then execute `npm run build`. +5. Finally, start the app by running `npm rum start` **Note**: Using Docker is recommended as it simplifies the setup process, especially for managing environment variables and dependencies. -See the [installation documentation](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/installation) for more information like exposing it your network, etc. +See the [installation documentation](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/installation) for more information like updating, etc. ### Ollama Connection Errors diff --git a/docs/installation/NETWORKING.md b/docs/installation/NETWORKING.md deleted file mode 100644 index ae39e3f..0000000 --- a/docs/installation/NETWORKING.md +++ /dev/null @@ -1,109 +0,0 @@ -# Expose Perplexica to a network - -This guide will show you how to make Perplexica available over a network. Follow these steps to allow computers on the same network to interact with Perplexica. Choose the instructions that match the operating system you are using. - -## Windows - -1. Open PowerShell as Administrator - -2. Navigate to the directory containing the `docker-compose.yaml` file - -3. Stop and remove the existing Perplexica containers and images: - - ```bash - docker compose down --rmi all - ``` - -4. Open the `docker-compose.yaml` file in a text editor like Notepad++ - -5. Replace `127.0.0.1` with the IP address of the server Perplexica is running on in these two lines: - - ```bash - args: - - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api - - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001 - ``` - -6. Save and close the `docker-compose.yaml` file - -7. Rebuild and restart the Perplexica container: - - ```bash - docker compose up -d --build - ``` - -## macOS - -1. Open the Terminal application - -2. Navigate to the directory with the `docker-compose.yaml` file: - - ```bash - cd /path/to/docker-compose.yaml - ``` - -3. Stop and remove existing containers and images: - - ```bash - docker compose down --rmi all - ``` - -4. Open `docker-compose.yaml` in a text editor like Sublime Text: - - ```bash - nano docker-compose.yaml - ``` - -5. Replace `127.0.0.1` with the server IP in these lines: - - ```bash - args: - - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api - - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001 - ``` - -6. Save and exit the editor - -7. Rebuild and restart Perplexica: - - ```bash - docker compose up -d --build - ``` - -## Linux - -1. Open the terminal - -2. Navigate to the `docker-compose.yaml` directory: - - ```bash - cd /path/to/docker-compose.yaml - ``` - -3. Stop and remove containers and images: - - ```bash - docker compose down --rmi all - ``` - -4. Edit `docker-compose.yaml`: - - ```bash - nano docker-compose.yaml - ``` - -5. Replace `127.0.0.1` with the server IP: - - ```bash - args: - - NEXT_PUBLIC_API_URL=http://127.0.0.1:3001/api - - NEXT_PUBLIC_WS_URL=ws://127.0.0.1:3001 - ``` - -6. Save and exit the editor - -7. Rebuild and restart Perplexica: - - ```bash - docker compose up -d --build - ``` diff --git a/docs/installation/UPDATING.md b/docs/installation/UPDATING.md index a4651df..972142f 100644 --- a/docs/installation/UPDATING.md +++ b/docs/installation/UPDATING.md @@ -39,11 +39,8 @@ To update Perplexica to the latest version, follow these steps: 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. +4. After populating the configuration run `npm i`. +5. Install the dependencies and then execute `npm run build`. +6. Finally, start the app by running `npm rum start` ---