bvandeusen
e652dece9b
Updates user-visible branding across frontend (PWA manifest, page title, Settings, push fallback), backend (email templates and subjects, LLM system prompt, CalDAV displayname, SMTP from-name default), README, quickstart compose, and MCP server description. Also updates the CI image path and quickstart image reference to git.fabledsword.com/bvandeusen/fabledscribe in preparation for the Forgejo repo rename. Internal Python package, env vars, and database schema unchanged. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# Fabled Scribe
|
|
|
|
A self-hosted second brain and project management application with integrated LLM capabilities. Write, organise, and act on your notes and tasks with the help of a local AI assistant — all running on your own hardware.
|
|
|
|
## Features
|
|
|
|
Notes and tasks with a Markdown editor, sub-tasks, milestones, and kanban project workspaces. AI chat with streaming responses, RAG over your notes, and tool use (web search, calendar, weather). A daily briefing that digests your tasks, RSS feeds, and weather on a schedule. Knowledge graph, per-user/group sharing, PWA with push notifications, an MCP server for external AI clients, and an Android companion app.
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites:** Docker and Docker Compose. 8 GB+ RAM recommended for LLM inference.
|
|
|
|
Download [`docker-compose.quickstart.yml`](docker-compose.quickstart.yml) from this repo, then:
|
|
|
|
```bash
|
|
# Optional but recommended — set a secret key
|
|
export SECRET_KEY=your-random-secret-here
|
|
|
|
docker compose -f docker-compose.quickstart.yml up -d
|
|
```
|
|
|
|
Open `http://localhost:5000`. The first user to register becomes admin. Go to **Settings → General** to pull an LLM model — `qwen3:8b` or `llama3.1:8b` are good starting points.
|
|
|
|
> **GPU:** Ollama runs CPU-only by default. See the comments in `docker-compose.quickstart.yml` to enable NVIDIA GPU passthrough.
|
|
|
|
> **Development:** To build from source, see [Development](docs/development.md).
|
|
|
|
## Documentation
|
|
|
|
| Doc | Contents |
|
|
|-----|----------|
|
|
| [Architecture](docs/architecture.md) | Stack, design decisions, data models, key services |
|
|
| [Configuration](docs/configuration.md) | Environment variables, Docker Compose, production setup, security |
|
|
| [Features](docs/features.md) | Detailed feature breakdown and keyboard shortcuts |
|
|
| [Development](docs/development.md) | Dev workflow, CI/CD, migrations, release process |
|
|
| [API Keys & MCP](docs/api-keys-and-mcp.md) | API key management and Fable MCP install guide |
|
|
| [SSO / OAuth](docs/sso-oauth.md) | OIDC setup for Authentik, Keycloak, and other providers |
|
|
| [API Reference](docs/api-reference.md) | All REST API endpoints |
|
|
| [Android App](docs/android-app.md) | Flutter companion app architecture and feature status |
|
|
|
|
## License
|
|
|
|
This project is privately maintained.
|