Compare commits
1
Commits
master
...
readme/saas
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2b77703551 |
@@ -8,7 +8,7 @@
|
||||

|
||||

|
||||
|
||||
[Quick start](#quick-start) · [Docs](docs/) · [Issues](https://git.evandro.dev.br/evandro/OllaHub/issues)
|
||||
**[Get started →](#quick-start)** · [Docs](docs/) · [Issues](https://git.evandro.dev.br/evandro/OllaHub/issues)
|
||||
|
||||
</div>
|
||||
|
||||
@@ -26,6 +26,23 @@ OllaHub is a client, not a model runtime. It talks to the Ollama API (default `h
|
||||
|
||||
**When not to use it:** if you want a finished, tested product (version `0.1.0`, no test suite), a model runtime of its own, or a server you can run without a desktop.
|
||||
|
||||
## Features
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="50%"><b>Hardware-aware setup</b><br>Scans your hardware, recommends a model and downloads it on first run.</td>
|
||||
<td width="50%"><b>Streaming chat</b><br>History in a local SQLite database with FTS5 full-text search.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%"><b>Web search</b><br>Headless Chrome scrapes Google, Bing, Yahoo, DuckDuckGo and Startpage; local embeddings rank the pages.</td>
|
||||
<td width="50%"><b>Deep research</b><br>A mode that runs planning, searching, aggregating, validating and formulating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%"><b>MCP tools</b><br>MCP servers run as child processes configured in <code>mcp_config.json</code>; the chat can call their tools.</td>
|
||||
<td width="50%"><b>Scheduled tasks</b><br>Cron tasks (search and summarize, notification, custom prompt) keep running in the background.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## How it works
|
||||
|
||||
- **Frontend** (`app/`, `components/`, `hooks/`, `lib/`, `store/`): Next.js 16 with `output: 'export'`, React 19, Tailwind 4, Radix UI and Zustand. It calls the backend through Tauri `invoke` and events.
|
||||
@@ -68,6 +85,36 @@ Early: version `0.1.0`, 47 commits between 2025-10-27 and 2025-11-27, no automat
|
||||
- **Embeddings outside Windows:** the ONNX Runtime library is downloaded automatically only on Windows. On macOS and Linux, provide it in the app data folder or on the system path, otherwise ranking falls back to BM25-like scoring.
|
||||
- **Unused leftovers:** `src-tauri/scripts/scraper.py` is not called by the Rust backend, and the 188 model files in `data/models/` are not referenced by the app code.
|
||||
|
||||
## FAQ
|
||||
|
||||
<details>
|
||||
<summary>Do I need Ollama installed?</summary>
|
||||
|
||||
It is needed at runtime. OllaHub tries to start Ollama when it is installed but stopped, and can download the Ollama installer when it is missing.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Where do my chats live?</summary>
|
||||
|
||||
In `ollahub.db` in the app data directory, a local SQLite database with FTS5 full-text search. Besides downloads (models, the embedding model, updates), web search is what reaches the internet.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Which systems can I build for?</summary>
|
||||
|
||||
The release workflow builds `msi` (Windows), `dmg` (macOS, Apple Silicon and Intel) and `AppImage` (Linux). No release is published in this repository yet, so build it locally.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>What is the license?</summary>
|
||||
|
||||
No published license: all rights reserved.
|
||||
|
||||
</details>
|
||||
|
||||
## License
|
||||
|
||||
No published license: all rights reserved.
|
||||
@@ -76,6 +123,8 @@ Built with [Tauri](https://tauri.app), [Next.js](https://nextjs.org), [Radix UI]
|
||||
|
||||
<div align="center">
|
||||
|
||||
<sub>Run your models on your desktop. Browse the <a href="https://git.evandro.dev.br/evandro/OllaHub">repository on Gitea</a> or open an <a href="https://git.evandro.dev.br/evandro/OllaHub/issues">issue</a>.</sub>
|
||||
|
||||
<sub>Made by <a href="https://evandro.dev.br">Evandro Fonseca Junior</a> · <a href="https://git.evandro.dev.br/evandro">git.evandro.dev.br</a></sub>
|
||||
|
||||
</div>
|
||||
Reference in new issue
Block a user