junvandCopilot
d73e70a781
- Add LICENSE (GNU Affero General Public License v3.0) - Add NOTICE file with SearXNG attribution for borrowed scraping patterns in google.py (arc_id, GSA user-agent, HTML selectors) and bing.py (PERE pagination, base64 redirect decoding, CAPTCHA detection) - Add CONTRIBUTING.md with contribution guidelines and license info - Add SPDX-License-Identifier headers to all Python source files - Add AGPL-3.0 license badge and License section to README.md SearXNG is licensed under AGPL-3.0-or-later; this project follows suit as it incorporates techniques derived from SearXNG's search engines. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Hey Search
A privacy-respecting metasearch engine that aggregates results from multiple search engines.
Inspired by SearXNG.
Architecture
- Backend: Python / FastAPI — async metasearch orchestrator with retry logic
- Frontend: React + Vite + TypeScript + Tailwind CSS (shadcn theming) — mobile-first UI
- Docker: Multi-stage build (Node frontend build → Python runtime)
Prerequisites
- uv (Python package manager)
- Node.js >= 18
- Python >= 3.12
- Redis (optional — enables search result caching)
Running Locally
1. Backend
cd backend
uv sync # install dependencies
uv run uvicorn app.main:app --reload --port 8000
To enable Redis caching:
REDIS_URL=redis://192.168.1.2:6399 uv run uvicorn app.main:app --reload --port 8000
The API will be available at http://localhost:8000. Interactive docs:
- Swagger UI: http://localhost:8000/docs
- Redoc: http://localhost:8000/redoc
2. Frontend
cd frontend
npm install # install dependencies
npm run dev # start dev server with hot reload
The frontend dev server runs at http://localhost:5173 and proxies /api requests to the backend.
3. Quick start (both)
# Without Redis (caching disabled)
just dev
# With Redis
REDIS_URL=redis://192.168.1.2:6399 just dev
4. Docker (production)
docker build -t hey-search .
# Basic — data stored in anonymous volume
docker run -p 8000:8000 hey-search
# Recommended — mount data directory for persistence
docker run -p 8000:8000 -v ./hey-search-data:/app/data hey-search
# With Redis
docker run -p 8000:8000 -v ./hey-search-data:/app/data \
-e REDIS_URL=redis://your-redis:6379 hey-search
The /app/data volume stores the SQLite database (engine settings, excluded domains, cache config). Mount it to preserve your settings across container restarts.
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET, POST | /api/search |
Search web or images |
| GET | /api/autocomplete?q= |
Autocomplete suggestions |
| GET | /api/engines |
List all search engines |
| PUT | /api/engines/{name} |
Enable/disable an engine |
| GET | /api/settings |
Get app settings (cache TTL) |
| PUT | /api/settings |
Update settings |
| DELETE | /api/cache |
Flush search cache |
Search endpoint parameters
| Parameter | Default | Description |
|---|---|---|
q |
required | Search query string |
category |
web |
web or images |
page |
1 |
Page number (1–50) |
pageNumber |
— | Alias for page (takes precedence when provided) |
numResults |
— | Requested result count hint (informational) |
format |
— | Response format hint (e.g. json) |
imageProxy |
— | Client image-proxy preference flag (informational) |
safesearch |
— | Safe search level: 0 off, 1 moderate, 2 strict |
engines |
— | Comma-separated engine names to restrict (e.g. google,bing) |
image_size |
— | large, medium, or small (images only) |
sort |
default |
default, date_asc, or date_desc |
Features
See FEATURES.md for the full feature list.
License
Hey Search is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-or-later).
This project was inspired by and incorporates techniques from SearXNG (AGPL-3.0). See NOTICE for details on third-party attributions.
AGPL-3.0 in plain English: You can use, modify, and deploy this software freely. If you run a modified version as a public network service, you must make your modified source code available to your users.