Search/README.md

# This projet is WIP

## Completed Tasks

- [X] Text results
- [X] Image results
- [X] Video results
- [X] Map results
- [X] Forums results
- [X] HTML+CSS site (no JS version)
- [X] Results cache
- [X] Torrent results
- [X] Better name

## Pending Tasks

- [ ] Website with JS version
- [ ] JS applets for results (such as calculator)
- [ ] Dynamic results loading as user scrolls
- [ ] Replace fonts, replace icons font for SVG or remove unnecessary icons for faster loading
- [ ] LXC container
- [ ] Docker container
- [ ] Automatic updates
- [ ] Scalable crawlers and webservers + load balacing
- [ ] LibreY-like API
- [ ] Music results

# Warp (Ocásek) Search Engine

A self-hosted private and anonymous [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine), that aims to be more resource effichent and scalable than its competetion. Its scalable becouse switching instances when one just decides to not work/is under too much load is just inconvenient. So you can comfortably use [officiall instance](https://search.spitfirebrowser.com/), or self-host your own instance.

## Comparison to other search engines


| Feature                            | Whoogle [1]         | Araa-Search             | LibreY                 | 4get                   | *Warp*                                             |
| :----------------------------------- | ------------------ | ------------------------- | ------------------------ | ------------------------ | ---------------------------------------------------- |
| Works without JavaScript           | ✅               | ✅                      | ✅                     | ✅                     | ✅                                                 |
| Music search                       | ❓               | ❌                      | ❌                     | ✅                     | ✅                                                 |
| Torrent search                     | ❌               | ✅                      | ✅                     | ❌                     | ✅                                                 |
| API                                | ❌               | ✅                      | ❓ [2]                    | ✅                     | ✅                                                 |
| Scalable                           | ❌               | ❌                      | ❌                     | ❌                     | ✅                                                 |
| Not Resource Hungry                | ❓ Moderate      | ❌ Very resource hungry | ❌ Moderate 200-400mb~ | ❌ Moderate 200-400mb~ | ✅ about 15-20MiB at idle, 17-22MiB when searching |
| Dynamic Page Loading               | ❓ Not specified | ❌                      | ❌                     | ❌                     | ✅                                                 |
| User themable                      | ❌               | ✅                      | ❌                     | ❌                     | ✅                                                 |
| It has dildo as logo, unironically | ❌               | ❌                      | ❌                     | ✅                     | ❌                                                 |

[1]: I was not able to check this since their site does not work, same for the community instances.

[2]: In the project repo they specify that it has API, but It looks like they are no loger supporting it. Or just removed "API" button and documentation, since I was not able to find it anymore.

## Features

- Text search using Google, Brave, DuckDuckGo and LibreX/Y.
- Image search using the Qwant, Bing and Imgur.
- Video search using Piped API.
- Image viewing using proxy and direct links to image source pages for image searches.
- Maps using OpenStreetMap
- Files download using torrent sites.

## Getting Started

### Prerequisites

- Go (version 1.18 or higher recommended)
- Git (unexpected)
- Access to the internet for fetching results (even more unexpected)

### Running the Application

```bash
git clone https://weforgecode.xyz/Spitfire/Search.git
cd Search
chmod +x ./run.sh
./run.sh
```

*Its that easy!*

## License

[![](https://www.gnu.org/graphics/agplv3-with-text-162x68.png)](https://www.gnu.org/licenses/agpl-3.0.html)