From 1df4d886ff42293ecedac46a179796e3573e1eb9 Mon Sep 17 00:00:00 2001 From: PSYEONE Date: Fri, 28 Nov 2025 11:59:53 +0000 Subject: [PATCH] Revert "Added updated README for this fork" This reverts commit 2574287fa836aaf8cfed9d1b670fd2b418e7b5d2. --- README.md | 44 +++++++++++++++----------------------------- 1 file changed, 15 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index d1fe16e..dc654df 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,6 @@ Perplexica is a **privacy-focused AI answering engine** that runs entirely on yo Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md). -## About this fork (Perplexica-no-ads) - -- This fork tracks Perplexica with a focus on a clean, ad-free experience. -- Added Settings → Preferences switches to show or hide the home weather and recent news widgets. - ## ✨ Features 🤖 **Support for all major AI providers** - Use local LLMs through Ollama or connect to OpenAI, Anthropic Claude, Google Gemini, Groq, and more. Mix and match models based on your needs. @@ -41,8 +36,6 @@ Want to know more about its architecture and how it works? You can read it [here 🕒 **Search history** - Every search is saved locally so you can revisit your discoveries anytime. Your research is never lost. -🧩 **Home widgets control** - Toggle the weather and recent news cards on/off from Settings → Preferences. - ✨ **More coming soon** - We're actively developing new features based on community feedback. Join our Discord to help shape Perplexica's future! ## Sponsors @@ -83,33 +76,24 @@ We'd also like to thank the following partners for their generous support: There are mainly 2 ways of installing Perplexica - With Docker, Without Docker. Using Docker is highly recommended. -### Docker (build from this fork) +### Getting Started with Docker (Recommended) -Build a local image from this repository and run it: +Perplexica can be easily run using Docker. Simply run the following command: ```bash -docker build -t perplexica-no-ads . -docker run -d -p 3000:3000 \ - -v perplexica-data:/home/perplexica/data \ - -v perplexica-uploads:/home/perplexica/uploads \ - --name perplexica-no-ads \ - perplexica-no-ads +docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data -v perplexica-uploads:/home/perplexica/uploads --name perplexica itzcrazykns1337/perplexica:latest ``` -Then open http://localhost:3000 to finish setup (API keys, models, etc.). +This will pull and start the Perplexica container with the bundled SearxNG search engine. Once running, open your browser and navigate to http://localhost:3000. You can then configure your settings (API keys, models, etc.) directly in the setup screen. + +**Note**: The image includes both Perplexica and SearxNG, so no additional setup is required. The `-v` flags create persistent volumes for your data and uploaded files. #### Using Perplexica with Your Own SearxNG Instance -If you already have SearxNG running, build the slim image and pass your URL: +If you already have SearxNG running, you can use the slim version of Perplexica: ```bash -docker build -f Dockerfile.slim -t perplexica-no-ads:slim . -docker run -d -p 3000:3000 \ - -e SEARXNG_API_URL=http://your-searxng-url:8080 \ - -v perplexica-data:/home/perplexica/data \ - -v perplexica-uploads:/home/perplexica/uploads \ - --name perplexica-no-ads \ - perplexica-no-ads:slim +docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v perplexica-data:/home/perplexica/data -v perplexica-uploads:/home/perplexica/uploads --name perplexica itzcrazykns1337/perplexica:slim-latest ``` **Important**: Make sure your SearxNG instance has: @@ -117,6 +101,8 @@ docker run -d -p 3000:3000 \ - JSON format enabled in the settings - Wolfram Alpha search engine enabled +Replace `http://your-searxng-url:8080` with your actual SearxNG URL. Then configure your AI provider settings in the setup screen at http://localhost:3000. + #### Advanced Setup (Building from Source) If you prefer to build from source or need more control: @@ -125,7 +111,7 @@ If you prefer to build from source or need more control: 2. Clone the Perplexica repository: ```bash - git clone https://github.com/PSYEONE/Perplexica-no-ads.git + git clone https://github.com/ItzCrazyKns/Perplexica.git ``` 3. After cloning, navigate to the directory containing the project files. @@ -133,8 +119,8 @@ If you prefer to build from source or need more control: 4. Build and run using Docker: ```bash - docker build -t perplexica-no-ads . - docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data -v perplexica-uploads:/home/perplexica/uploads --name perplexica-no-ads perplexica-no-ads + docker build -t perplexica . + docker run -d -p 3000:3000 -v perplexica-data:/home/perplexica/data -v perplexica-uploads:/home/perplexica/uploads --name perplexica perplexica ``` 5. Access Perplexica at http://localhost:3000 and configure your settings in the setup screen. @@ -147,8 +133,8 @@ If you prefer to build from source or need more control: 2. Clone the repository: ```bash - git clone https://github.com/PSYEONE/Perplexica-no-ads.git - cd Perplexica-no-ads + git clone https://github.com/ItzCrazyKns/Perplexica.git + cd Perplexica ``` 3. Install dependencies: