synaplan README

README проекта с github.com/metadist/synaplan. Одним файлом markdown: README.md.

Synaplan. Own the flow. Your knowledge, your models, your channels.

Build AI assistants on your own documents and put them wherever work happens: web, WhatsApp, email, Outlook, Nextcloud and ownCloud. Mix local models with the best cloud AI, see what every answer costs, and decide what the AI is allowed to do – open source, on your server or ours.

Run it in up to five minutes  ·  Try it hosted  ·  Docs  ·  Discord

Latest release GitHub stars Discord

Self-hosting is free. The hosted version opens with a paid plan or an invitation code – ask us at [email protected].

A thirty-second tour of Synaplan: a chat answer and its cost, default models with cost badges, the file library, generated images and audio, and connected apps

Chat, the cost of every answer, your files, generated media and connected apps – in about 30 seconds.


Why Synaplan

Running in production at Megaherz Yoga · SANI Pflegedienst · National Secure Cloud · PlateArt


Quickstart

You need: Docker with Compose v2 and 8 GB of RAM.

git clone https://github.com/metadist/synaplan.git
cd synaplan
make up

Open http://localhost:5173, log in as [email protected] / admin123 and say hello. Your first message starts the Synaplan Demo – no API key needed (40 messages a day for 14 days, how it works). When you're ready, add your own key (free: Groq) or run local models with Ollama.

The first start downloads everything and takes 5–15 minutes. After that, Synaplan starts in seconds.

[!IMPORTANT] These logins are for trying Synaplan on your own machine. On a server, use the installer – it creates its own admin password.


Install it your way

Where How Guide
Your machine make up – the quickstart above Quickstart
Published image, no git One compose.yaml, then docker compose up -d Published image
Docker GUI Portainer, Dockge, Synology: paste the compose file as a stack Docker GUI
Closed network No route to the internet, HTTPS on your LAN address Closed network
Linux server The installer pins a release, generates secrets and runs a smoke test On a server
Kubernetes Helm charts for clusters synaplan-charts
One click RepoCloud · Elestio –

A Linux server in one line:

curl -fsSL https://raw.githubusercontent.com/metadist/synaplan/main/install.sh | \
  bash -s -- --mode server --domain https://ai.example.com

Public sector & sovereign cloud (EU/CH): synaplan.eu covers openDesk, Nextcloud and OpenCloud deployments, on-premises or in an EU cloud.


How it compares

People usually arrive comparing Synaplan with a chat window or an app builder. This is what each project is for. It is not a scoreboard.

Synaplan Open WebUI LibreChat Dify
What it is A team platform: chat, your files as knowledge, a site widget, and the same assistant on WhatsApp and email A chat interface for local and cloud models A chat app for many providers A builder for AI apps and workflows
First run Several containers, about 4 GB One container A Compose stack A Compose stack, and a hosted cloud
Cost of an answer Shown on the answer Not on the answer Not on the answer In the builder's usage logs, not on the chat answer
Same assistant on your site, WhatsApp and email Yes No No Site widget yes. WhatsApp and email are not built in

If you only want a chat window, Open WebUI or LibreChat gets you there faster.


Take the tour

A tour through Synaplan: chat with live cost tracking, one-key provider setup, per-task model choice, document search, media generation, the embeddable chat widget and white-label branding

▶ Watch the full demo on YouTube  ·  Click any screenshot to see it full size.

Chat with per-model cost tracking
Chat
Every answer shows what it cost
AI provider setup with live key validation
Provider setup
One key, tested and encrypted
Per-task model selection with cost badges
Model choice
A different model per task
Semantic search across uploaded documents
Document search
Answers from your own files
Gallery of AI-generated images and video
Media generation
Images, video and audio in chat
Embed code for the chat widget
Chat widget
One snippet, any website
System prompt editor
AI instructions
Your own system prompts
File manager with folders and storage quota
Files
Uploads become knowledge
Plugin view showing Synaform collections
Plugins
Extend without forking
Admin panel with system info and user counts
Admin
Users, usage and health
White-label branding settings
Branding
White-label the whole app

One AI, everywhere you work

The same assistant, the same knowledge, the same model policy – on every channel your team and your customers already use.

Surface What it does Get it
Web app Full chat and admin UI, light and dark, five languages This repo
Mobile apps Chat, documents and voice on iPhone and Android – on web.synaplan.com or your own server App Store · Google Play
Outlook add-in Find and process mail inside Outlook (Web, new & classic, Mac) without sending it anywhere Synamail
Chat widget Your assistant on any website with one snippet, human takeover included Widget guide
WhatsApp & email The AI answers on the channel the question came in on WhatsApp · Email
Nextcloud, ownCloud & OpenCloud Use your assistants inside your file cloud, with its files as knowledge – your file store stays in charge Nextcloud · ownCloud · OpenCloud
Synaplan Desktop Pair a computer and run skills on it (no installer yet – build from source) synaplan-desktop
MCP & Claude Code Your knowledge and memories as MCP tools, plus an Anthropic-compatible endpoint MCP guide

Connects to Microsoft 365 · Dropbox · Nextcloud / ownCloud / WebDAV · CalDAV · IMAP · Jira & Confluence · your own MCP servers – how to connect


Under the hood

Full feature list, every AI provider, all building blocks and developer commands: Platform reference.


Troubleshooting

Problem What to do
"Port already in use" on start A port Synaplan needs is taken – see Port conflicts
Containers stop right after start Give Docker at least 8 GB of RAM, then check docker compose logs -f backend
Chat gives no answers Use the Synaplan Demo, paste one provider key, or add the local-ai profile – see the quickstart
First start seems stuck The first start downloads all images and takes 5–15 minutes. docker compose logs -f startup-notes shows where it is
Anything else Ask in Discord or open a GitHub issue

Learn more


Help shape what's next

We build Synaplan in the open. Tell us what you'd use it for, vote on ideas or show what you built in Discussions – we read everything.


License

Apache-2.0 · Built in Düsseldorf by metadist · Member of the Open Source Business Alliance

OSBA member

If Synaplan helps you own your flow, a ⭐ helps the next team find it.

Star history of metadist/synaplan

synaplan (metadist/synaplan)

Ищем в базе…

Что это такое?Synaplan — это платформа с открытым исходным кодом, которую можно развернуть на своём сервере. Она позволяет общаться с любой моделью ИИ, искать по своим документам с помощью RAG, встраивать чат-виджет на свой сайт и открывать вашу базу знаний как инструменты MCP, при этом показывая стоимость каждого ответа.
Это одно приложение или целая экосистема приложений?Этот репозиторий содержит основной бэкенд на PHP/Symfony, фронтенд и виджет, которые вы разворачиваете у себя с помощью Docker. Отдельные репозитории (Helm-чарты, мобильные приложения, десктопный агент сопряжения, надстройка для Outlook, коннекторы для Nextcloud/OpenCloud) работают с той же платформой.
Как всё запустить?Склонируйте репозиторий и выполните make up, чтобы собрать и запустить стек Docker Compose, или используйте установку одной командой через curl. Для продакшена предусмотрены более лёгкий файл Compose с готовыми образами и скрипт install.sh --mode server для Linux.
Что нужно установить перед запуском?Docker и Docker Compose v2, Git, минимум 8 ГБ оперативной памяти (рекомендуется 16 ГБ при использовании локального ИИ) и около 4 ГБ свободного места на диске. Ключи API провайдеров или локальную модель через Ollama можно добавить после запуска стека.
Есть ли подводные камни при установке по умолчанию?По умолчанию приложение доступно только с локальной машины. Чтобы открыть его для сети, нужно правильно задать SYNAPLANHTTPBIND и SYNAPLANURL, иначе живой чат не подключится. Кроме того, при работе по обычному HTTP на сетевом адресе браузеры блокируют микрофон и буфер обмена.
Это бесплатно и что разрешает лицензия?Программа для самостоятельного развёртывания распространяется под лицензией Apache-2.0 и может бесплатно использоваться у вас навсегда. Также есть платная облачная версия на web.synaplan.com, для которой нужен платный тариф или инвайт-код.
Из чего состоит экосистема Synaplan?Помимо основного репозитория, отдельные проекты добавляют Helm-чарты для Kubernetes (synaplan-charts), нативные приложения для iOS и Android, десктопный агент сопряжения (synaplan-desktop), надстройку для Outlook (Synamail) и коннекторы для Nextcloud/OpenCloud. Все они работают с одним и тем же бэкендом.
Можно ли запускать модели ИИ локально, а не отправлять данные облачному провайдеру?Да. Если включить профиль local-ai (COMPOSE_PROFILES=local-ai), загрузятся Ollama и модель для эмбеддингов bge-m3, и RAG с чатом смогут работать полностью на вашем собственном оборудовании, без облачного ключа.
К каким системам можно подключить Synaplan?Через раздел Manage → Connections можно подключить Microsoft 365, Dropbox, Nextcloud/ownCloud/WebDAV, календарь CalDAV, почтовые ящики IMAP, Jira и Confluence, а также WhatsApp и электронную почту как каналы чата.
Как работает учёт стоимости?Каждый ответ в чате в интерфейсе показывает, сколько он стоил. Изменения в каталоге моделей (новые модели, обновления цен, отключение моделей) поставляются в виде сидеров, поэтому существующая установка автоматически переключается на поддерживаемую модель с корректной ценой.
Какие есть похожие проекты?ruflo, WeKnora, SurfSense, LangBot, sim, LongMemory, m_flow, DeskcommCRM
Автор
metadist
Размер
180.8 MB
Звёзды
1K
Возраст
1 г
Коммиты · 90 дней