| @@ -1,13 +1,17 @@ |
| # SearchHub |
| |
| -A local search engine for your browser bookmarks. Import bookmarks from Firefox, Zen, Chrome, or Chromium, search them with full-text queries, and optionally forward searches to crates.io (via its public JSON API). Content is automatically tagged via local ONNX embeddings. |
| +A local search engine for your browser bookmarks. Import bookmarks from Firefox, Zen, Chrome, or Chromium, search them with full-text queries, and optionally forward searches to external engines like crates.io (via its public JSON API) or SearXNG (aggregates results from dozens of backends). Content is automatically tagged via local ONNX embeddings. |
| |
| ## Install |
| |
| +**Binaries** are available at [vit.am/~ololduck/search_hub/latest](https://vit.am/~ololduck/search_hub/latest/) — download the archive or the statically-linked binary for your architecture, extract, and run. |
| + |
| +**Source:** Clone the [repository](https://vit.am/~ololduck/search_hub/repository.git) and build with Rust: |
| + |
| **Prerequisites:** Rust (install via [rustup](https://rustup.rs/)). |
| |
| ```sh |
| -git clone https://github.com/your/repo.git |
| +git clone https://vit.am/~ololduck/search_hub/repository.git |
| cd search_hub |
| cargo install --path . |
| ``` |
| @@ -31,7 +35,7 @@ search_hub serve |
| |
| Open http://127.0.0.1:8080 in your browser. You can now search your bookmarks. |
| |
| -Search queries are also forwarded to [crates.io](https://crates.io) via its public JSON API. Works as a custom search provider in Firefox/Zen via the OpenSearch protocol (your browser should auto-discover it at `/opensearch.xml`). |
| +Search queries are also forwarded to external engines: [crates.io](https://crates.io) via its public JSON API, and optionally [SearXNG](https://searx.space) (which aggregates Google, Bing, DDG, and dozens more) if `[engines.searxng]` is configured. Works as a custom search provider in Firefox/Zen via the OpenSearch protocol (your browser should auto-discover it at `/opensearch.xml`). |
| |
| ## CLI reference |
| |
| @@ -105,3 +109,9 @@ systemctl --user enable --now search-hub-import.timer |
| ``` |
| |
| This imports bookmarks from Zen Browser daily. |
| + |
| +## Resources |
| + |
| +- **Downloads:** [vit.am/~ololduck/search_hub/latest](https://vit.am/~ololduck/search_hub/latest/) |
| +- **Repository browser:** [vit.am/~ololduck/search_hub/repository](https://vit.am/~ololduck/search_hub/repository) |
| +- **Git clone:** `git clone https://vit.am/~ololduck/search_hub/repository.git` |