odysseus README

The project's README from github.com/odysseus-dev/odysseus. As one markdown file: README.md.

Odysseus

A self-hosted AI workspace for chat, agents, research, documents, email, notes, calendar, and local model workflows.

Quick Start · Setup Guide · Contributing · Roadmap

Packaging status

Odysseus interface


Quick Start

dev is the default branch and gets the newest changes first. Use main if you want the more curated branch.

git clone https://github.com/odysseus-dev/odysseus.git
cd odysseus
cp .env.example .env
docker compose up -d --build

Open http://localhost:7011 when the containers are healthy. The first admin password is printed in docker compose logs odysseus.

The compose files pull the official multi-arch image ghcr.io/odysseus-dev/odysseus (published by CI on every push to main and dev) and only build locally if the pull fails — so this also works on hosts without a build toolchain, e.g. as a Portainer stack.

Production deployments: pin the immutable tag instead of :latest. :latest and bare :X.Y.Z tags move on every push to main, but :X.Y.Z-<sha> (e.g. 1.0.2-7c8070f) always refers to one specific build:

ODYSSEUS_IMAGE=ghcr.io/odysseus-dev/odysseus:1.0.2-7c8070f docker compose up -d

Native installs, GPU notes, Windows/macOS instructions, HTTPS, and configuration live in the setup guide.

Features

Demo

A full hover-to-play tour lives on the Odysseus landing page. Its source lives under website/.

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

Star History Chart

License

AGPL-3.0-or-later -- see LICENSE and ACKNOWLEDGMENTS.md.

odysseus (odysseus-dev/odysseus)

Searching Database…

93.7K ·GitHub
What is this?Odysseus is a self-hosted AI workspace that bundles chat, agents, deep research, a document editor, email, notes, tasks, and calendar around local or API models.
Is this a hosted SaaS or something I run myself?You run it yourself: it's a Dockerized app with its own containers, not a cloud service — you self-host it on your own machine or server.
How do I get it running?Start it with docker compose; once the containers are healthy, open the app in your browser. The first admin password is printed in the docker compose logs for the odysseus service.
Do I need Docker, or can I install it natively?Docker is the default path, but native installs, GPU setup, and HTTPS/config details for people who skip containers are covered in the separate setup guide.
What's the main thing to watch out for when deploying it?Security is on you: keep AUTHENABLED=true for any network-accessible deployment, keep LOCALHOSTBYPASS=false outside local development, and never expose raw model/service ports publicly.
Does it only run on Linux, or also Windows and macOS?Besides the default Linux/Docker setup, the guide has dedicated Windows and macOS install instructions plus GPU notes.
Since it reads my email and notes, where does that data go?Everything stays on your own self-hosted server; the README explicitly warns to keep private data out of Git and never expose raw model/service ports to the public internet.
What can the Email feature actually do?It connects to your inbox over IMAP/SMTP and handles triage, tagging, summaries, reminders, and drafting replies.
What is the Deep Research mode?A multi-step agent that does web research, reads sources, and writes a synthesized report on its own.
What's the Cookbook feature for?It gives hardware-aware local model recommendations along with downloading and serving them directly from the app.
Does it support MCP and external tools?Yes — the chat/agents module can use local or API models together with tools, MCP, file and shell access, skills, and memory.
Size
36.7 MB
Stars
93.7K
Updated
CommitOct 16
Age
4mo
Commits · 90 Days