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.8K ·GitHub
Что это такое?Odysseus — это рабочее пространство на базе ИИ, которое вы разворачиваете на своём сервере. Оно объединяет чат, агентов, глубокие исследования, редактор документов, почту, заметки, задачи и календарь и работает на локальных или API-моделях.
Это облачный SaaS-сервис или то, что я запускаю сам?Вы запускаете его сами: это приложение в Docker-контейнерах, а не облачный сервис. Вы размещаете его на своей машине или сервере.
Как его запустить?Запустите его командой docker compose. Когда контейнеры будут в рабочем состоянии, откройте приложение в браузере. Первый пароль администратора выводится в логах docker compose для сервиса odysseus.
Нужен ли Docker или можно установить без него?Docker — основной способ, но нативная установка, настройка GPU и детали HTTPS и конфигурации для тех, кто обходится без контейнеров, описаны в отдельном руководстве по установке.
На что главное обратить внимание при развертывании?За безопасность отвечаете вы. Для любого развертывания, доступного из сети, оставляйте AUTHENABLED=true. Вне локальной разработки оставляйте LOCALHOSTBYPASS=false. Никогда не открывайте напрямую порты моделей и сервисов в публичный интернет.
Работает ли оно только на Linux или также на Windows и macOS?Помимо стандартной настройки на Linux с Docker, в руководстве есть отдельные инструкции по установке на Windows и macOS, а также заметки по GPU.
Раз оно читает мою почту и заметки, куда попадают эти данные?Всё остаётся на вашем собственном сервере. В README прямо предупреждается, что приватные данные нельзя хранить в Git, а порты моделей и сервисов нельзя открывать в публичный интернет.
Что на самом деле умеет функция Email?Она подключается к вашему почтовому ящику по IMAP/SMTP и занимается разбором входящих, тегами, краткими содержаниями, напоминаниями и составлением черновиков ответов.
Что такое режим Deep Research?Это многошаговый агент, который самостоятельно ищет информацию в сети, читает источники и пишет обобщённый отчёт.
Для чего нужна функция Cookbook?Она подбирает локальные модели с учётом характеристик вашего железа, а также позволяет загружать их и запускать прямо из приложения.
Поддерживает ли оно MCP и внешние инструменты?Да. Модуль чата и агентов может использовать локальные или API-модели вместе с инструментами, MCP, доступом к файлам и shell, навыками и памятью.
Size
36.7 MB
Stars
93.8K
Updated
CommitOct 16
Age
4mo
Commits · 90 Days