Kenny Van de Maele
1747c13133
* test: align README presentation guards with the #4306 refresh The 'Refresh README presentation' change (#4306) swapped the ASCII banner for a centered wordmark image and moved the native quickstart into docs/setup.md, which left four base tests failing on dev and froze the merge gate: - test_security_regressions::test_readme_native_quickstart_uses_loopback now also accepts the loopback guidance from docs/setup.md, where the quickstart moved (no behaviour change; the guidance is intact there). - test_readme_ascii_fenced guards the new wordmark title instead of the removed ASCII banner, and keeps a defensive check that any reintroduced box-drawing banner stays inside a code fence (the original #1390 mode). - The five unreferenced demo gifs under docs/ (chat, compare, document, notes, research) are removed so test_docs_no_orphan_images passes; they were de-referenced by the refresh. Recoverable from history if a docs page wants to embed them again. * chore: refresh PR checks --------- Co-authored-by: Alexandre Teixeira <alexandremagteixeira@gmail.com>
A self-hosted AI workspace for chat, agents, research, documents, email, notes, calendar, and local model workflows.
Quick Start · Setup Guide · Contributing · Roadmap
Quick Start
devis the default branch and gets the newest changes first. Usemainif you want the more curated branch.
git clone https://github.com/pewdiepie-archdaemon/odysseus.git
cd odysseus
cp .env.example .env
docker compose up -d --build
Open http://localhost:7000 when the containers are healthy. The first admin password is printed in docker compose logs odysseus.
Native installs, GPU notes, Windows/macOS instructions, HTTPS, and configuration live in the setup guide.
Features
- Chat + Agents — local/API models, tools, MCP, files, shell, skills, and memory.
- Cookbook — hardware-aware model recommendations, downloads, and serving.
- Deep Research — multi-step web research with source reading and report generation.
- Compare — blind side-by-side model testing and synthesis.
- Documents — writing-first editor with AI edits, suggestions, Markdown, HTML, CSV, and syntax highlighting.
- Email — IMAP/SMTP inbox with triage, tags, summaries, reminders, and reply drafts.
- Notes, Tasks + Calendar — reminders, todos, scheduled agent tasks, and CalDAV sync.
- Extras — gallery/image editor, themes, uploads, web search, presets, sessions, and 2FA.
Demo
A full hover-to-play tour lives on the landing page: docs/index.html.
Contributing
Help is welcome. The best entry points are fresh-install testing, provider setup bugs, mobile/editor polish, docs, and small focused refactors. See CONTRIBUTING.md and ROADMAP.md.
Security
Odysseus is a self-hosted workspace with powerful local tools. Keep auth enabled, keep private data out of Git, and do not expose raw model/service ports publicly. Deployment details are in the setup guide.
Star History
License
AGPL-3.0-or-later -- see LICENSE and ACKNOWLEDGMENTS.md.