docs: add docs/index.md and docs/screenshots for cloud launch
This commit is contained in:
parent
42ae3bc39b
commit
88e18d9dac
3 changed files with 44 additions and 0 deletions
44
docs/index.md
Normal file
44
docs/index.md
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
# Pagepiper
|
||||||
|
|
||||||
|
Self-hosted document search with BM25 full-text indexing and (with local Ollama) hybrid vector search and LLM-powered chat.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
Try it: [pagepiper.circuitforge.tech](https://pagepiper.circuitforge.tech)
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
### Library
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Scan your PDF directory to index documents. Each document shows page count and ingest status.
|
||||||
|
|
||||||
|
### Chat
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Ask questions across your indexed documents. Results cite the source document and page number.
|
||||||
|
|
||||||
|
## Quick Start (Docker)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.opensourcesolarpunk.com/Circuit-Forge/pagepiper
|
||||||
|
cd pagepiper
|
||||||
|
cp .env.example .env # set PAGEPIPER_DATA_DIR and PAGEPIPER_BOOKS_DIR
|
||||||
|
docker compose up -d --build
|
||||||
|
# open http://localhost:8521
|
||||||
|
```
|
||||||
|
|
||||||
|
Place PDFs in your `PAGEPIPER_BOOKS_DIR` directory, then click "Scan for PDFs" in the Library view.
|
||||||
|
|
||||||
|
## Tiers
|
||||||
|
|
||||||
|
| Feature | Free | Paid (BYOK) |
|
||||||
|
|---------|------|-------------|
|
||||||
|
| BM25 full-text search | Yes | Yes |
|
||||||
|
| Unlimited local ingestion | Yes | Yes |
|
||||||
|
| Hybrid vector search | No | Yes (local Ollama) |
|
||||||
|
| LLM chat over documents | No | Yes (local Ollama) |
|
||||||
|
|
||||||
|
Set `PAGEPIPER_OLLAMA_URL` in your `.env` to unlock the Paid tier with your own Ollama instance.
|
||||||
BIN
docs/screenshots/01-library.png
Normal file
BIN
docs/screenshots/01-library.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/screenshots/02-chat.png
Normal file
BIN
docs/screenshots/02-chat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Loading…
Reference in a new issue