synaplan
Open-source, self-hosted AI platform (PHP/Symfony): chat with any model, RAG over your docs, embeddable widget, MCP — see the cost of every answer. Apache-2.0.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/metadist/synaplan with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/metadist/synaplan'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/metadist--synaplan)HTML
<a href="/listings/metadist--synaplan"><img src="/api/listings/metadist--synaplan/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
git clone https://github.com/metadist/synaplan.git cd synaplan make up
Open **<http://localhost:5173>**. Log in as `admin@synaplan.com` / `admin123` and type your first message: it starts the Synaplan Demo (40 messages/day for 14 days, no API key needed — [how it works](https://docs.synaplan.com/demo)). Or connect [your own AI key](https://docs.synaplan.com/own-ai-keys) (free: [Groq](https://console.groq.com)) or [local Ollama](https://docs.synaplan.com/modules/local-ai).
A published image, a Docker GUI, a closed network, or a Linux server: [More ways to install](#more-ways-to-install).
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 237 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <div align="center">
- <a href="https://www.synaplan.com"><img src="docs/images/hero.svg" alt="Synaplan. Own the flow. Your knowledge, your models, your channels." width="100%"></a>
- 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**](#quickstart) · [**Try it hosted**](https://web.synaplan.com/) · [**Docs**](https://docs.synaplan.com/) · [**Discord**](https://discord.com/invite/kQB3eDjWfF)
- [](https://github.com/metadist/synaplan/releases)
- [](https://github.com/metadist/synaplan/stargazers)
- [](https://discord.com/invite/kQB3eDjWfF)
- <sub>Self-hosting is free. The hosted version opens with a paid plan or an invitation code – ask us at <a href="mailto:team@synaplan.com">team@synaplan.com</a>.</sub>
- </div>
- <p align="center">
- <img src="docs/images/synaplan-admin-tour.gif" alt="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" width="100%">
- </p>
- <p align="center"><sub>Chat, the cost of every answer, your files, generated media and connected apps – in about 30 seconds.</sub></p>
- ---
- ## Why Synaplan
- - **Own your channels.** One assistant answers on your website, in WhatsApp, by email, in Outlook and inside Nextcloud and ownCloud – with the same knowledge and the same rules everywhere.
- - **Own your models.** Hundreds of models from OpenAI, Anthropic, Google, Mistral, sovereign EU providers or locally via Ollama. Mix them per task: sensitive work stays local, everything else gets the best model for the job.
- - **Own your costs.** Every answer shows its model and price. A planner splits bigger requests into steps and spends the expensive model only where it matters.
- - **Own the decisions.** Actions like sending mail or creating tickets wait for your approval, and every step is logged.
- - **Own the stack.** On-prem, EU cloud or fully air-gapped. No training on your data, no forced telemetry, no feature paywall: self-hosted Synaplan is the same software as our cloud, under Apache-2.0.
- **Running in production at** Megaherz Yoga · SANI Pflegedienst · National Secure Cloud · PlateArt
- ---
- ## Quickstart
- **You need:** Docker with Compose v2 and 8 GB of RAM.
- ```bash
- git clone https://github.com/metadist/synaplan.git
- cd synaplan
- make up
- ```
- Open **<http://localhost:5173>**, log in as `admin@synaplan.com` / `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](https://docs.synaplan.com/demo)). When you're ready, add [your own key](https://docs.synaplan.com/own-ai-keys) (free: [Groq](https://console.groq.com)) or run [local models with Ollama](https://docs.synaplan.com/modules/local-ai).
- 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](#install-it-your-way) – it creates its own admin password.
- ---
- ## Install it your way
- | Where | How | Guide |
- | --- | --- | --- |
- | **Your machine** | `make up` – the quickstart above | [Quickstart](#quickstart) |
- | **Published image, no git** | One `compose.yaml`, then `docker compose up -d` | [Published image](docs/PLATFORM_REFERENCE.md#published-image-no-git-checkout) |
- | **Docker GUI** | Portainer, Dockge, Synology: paste the compose file as a stack | [Docker GUI](docs/PLATFORM_REFERENCE.md#published-image-no-git-checkout) |
- | **Closed network** | No route to the internet, HTTPS on your LAN address | [Closed network](docs/PLATFORM_REFERENCE.md#closed-network) |
- | **Linux server** | The installer pins a release, generates secrets and runs a smoke test | [On a server](docs/PLATFORM_REFERENCE.md#on-a-server) |
- | **Kubernetes** | Helm charts for clusters | [synaplan-charts](https://github.com/metadist/synaplan-charts) |
- | **One click** | [RepoCloud](https://repocloud.io/details/Synaplan/) · [Elestio](https://elest.io/open-source/synaplan) | – |
- A Linux server in one line:
- ```bash
- 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](https://www.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
- 
- <p align="center"><a href="https://www.youtube.com/watch?v=WjO9mE43uec">▶ Watch the full demo on YouTube</a> · Click any screenshot to see it full size.</p>
- <table>
- <tr>
- <td width="25%" align="center">
- <a href="docs/images/tour/chat.webp"><img src="docs/images/tour/thumbs/chat.webp" alt="Chat with per-model cost tracking" width="100%"></a><br>
- <sub><b>Chat</b><br>Every answer shows what it cost</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/provider-setup.webp"><img src="docs/images/tour/thumbs/provider-setup.webp" alt="AI provider setup with live key validation" width="100%"></a><br>
- <sub><b>Provider setup</b><br>One key, tested and encrypted</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/model-selection.webp"><img src="docs/images/tour/thumbs/model-selection.webp" alt="Per-task model selection with cost badges" width="100%"></a><br>
- <sub><b>Model choice</b><br>A different model per task</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/rag-search.webp"><img src="docs/images/tour/thumbs/rag-search.webp" alt="Semantic search across uploaded documents" width="100%"></a><br>
- <sub><b>Document search</b><br>Answers from your own files</sub>
- </td>
- </tr>
- <tr>
- <td width="25%" align="center">
- <a href="docs/images/tour/media-generation.webp"><img src="docs/images/tour/thumbs/media-generation.webp" alt="Gallery of AI-generated images and video" width="100%"></a><br>
- <sub><b>Media generation</b><br>Images, video and audio in chat</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/chat-widget.webp"><img src="docs/images/tour/thumbs/chat-widget.webp" alt="Embed code for the chat widget" width="100%"></a><br>
- <sub><b>Chat widget</b><br>One snippet, any website</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/system-prompts.webp"><img src="docs/images/tour/thumbs/system-prompts.webp" alt="System prompt editor" width="100%"></a><br>
- <sub><b>AI instructions</b><br>Your own system prompts</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/file-manager.webp"><img src="docs/images/tour/thumbs/file-manager.webp" alt="File manager with folders and storage quota" width="100%"></a><br>
- <sub><b>Files</b><br>Uploads become knowledge</sub>
- </td>
- </tr>
- <tr>
- <td width="25%" align="center">
- <a href="docs/images/tour/plugins.webp"><img src="docs/images/tour/thumbs/plugins.webp" alt="Plugin view showing Synaform collections" width="100%"></a><br>
- <sub><b>Plugins</b><br>Extend without forking</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/admin-panel.webp"><img src="docs/images/tour/thumbs/admin-panel.webp" alt="Admin panel with system info and user counts" width="100%"></a><br>
- <sub><b>Admin</b><br>Users, usage and health</sub>
- </td>
- <td width="25%" align="center">
- <a href="docs/images/tour/branding.webp"><img src="docs/images/tour/thumbs/branding.webp" alt="White-label branding settings" width="100%"></a><br>
- <sub><b>Branding</b><br>White-label the whole app</sub>
- </td>
- <td width="25%"></td>
- </tr>
- </table>
- <!-- Regenerate these assets after a UI change with scripts/build-readme-tour.sh -->
- ---
- ## 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](https://apps.apple.com/app/id6784278288?ct=github-readme) · [Google Play](https://play.google.com/store/apps/details?id=com.synaplan.app&referrer=utm_source%3Dgithub-readme) |
- | **Outlook add-in** | Find and process mail inside Outlook (Web, new & classic, Mac) without sending it anywhere | [Synamail](https://github.com/metadist/Synamail) |
- | **Chat widget** | Your assistant on any website with one snippet, human takeover included | [Widget guide](https://docs.synaplan.com/widget) |
- | **WhatsApp & email** | The AI answers on the channel the question came in on | [WhatsApp](docs/WHATSAPP.md) · [Email](docs/EMAIL.md) |
- | **Nextcloud, ownCloud & OpenCloud** | Use your assistants inside your file cloud, with its files as knowledge – your file store stays in charge | [Nextcloud](https://web.synaplan.com/apps/nextcloud) · [ownCloud](https://web.synaplan.com/apps/owncloud) · [OpenCloud](https://github.com/metadist/synaplan-opencloud) |
- | **Synaplan Desktop** | Pair a computer and run skills on it (no installer yet – build from source) | [synaplan-desktop](https://github.com/metadist/synaplan-desktop) |
- | **MCP & Claude Code** | Your knowledge and memories as MCP tools, plus an Anthropic-compatible endpoint | [MCP guide](https://docs.synaplan.com/mcp) |
- **Connects to** Microsoft 365 · Dropbox · Nextcloud / ownCloud / WebDAV · CalDAV · IMAP · Jira & Confluence · your own MCP servers – [how to connect](docs/CONNECTIONS.md)
- ---
- ## Under the hood
- - **Stack:** Symfony (PHP) backend, Vue frontend, MariaDB VECTOR or Qdrant for document search, Redis, Docker.
- - **Lean core:** app, database and Redis. Local AI, office files, web search, voice and more are building blocks you switch on when you need them.
- - **Open by design:** OpenAPI REST API, MCP server and client, an Anthropic-compatible `/v1/messages` endpoint and a plugin system – extend Synaplan without forking it.
- Full feature list, every AI provider, all building blocks and developer commands: **[Platform reference](docs/PLATFORM_REFERENCE.md)**.
- ---
- ## Troubleshooting
- | Problem | What to do |
- | --- | --- |
- | "Port already in use" on start | A port Synaplan needs is taken – see [Port conflicts](docs/INSTALLATION.md#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](#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](https://discord.com/invite/kQB3eDjWfF) or open a [GitHub issue](https://github.com/metadist/synaplan/issues) |
- ---
- ## Learn more
- - **[docs.synaplan.com](https://docs.synaplan.com/)** – guides for users and admins
- - **[docs/README.md](docs/README.md)** – the technical manual, in five learning tracks
- - **[Platform reference](docs/PLATFORM_REFERENCE.md)** – install variants, features, providers and building blocks
- - Changing the code? Start with [adding an AI provider](docs/PROVIDERS.md) or [following a tool call](docs/ARCHITECTURE.md#tool-path).
- ---
- ## 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](https://github.com/metadist/synaplan/discussions) – we read everything.
- - 💬 **[Discord](https://discord.com/invite/kQB3eDjWfF)** – the fastest place for self-hosting and configuration questions
- - 🐛 **[Issues](https://github.com/metadist/synaplan/issues)** – bugs and feature requests
- - 🙌 **[Contributing](CONTRIBUTING.md)** – how to get your first pull request merged ([AGENTS.md](AGENTS.md) is the guide for coding agents)
- - 🔒 **[Security policy](SECURITY.md)** – report a vulnerability privately
- ---
- ## License
- [Apache-2.0](LICENSE) · Built in Düsseldorf by [metadist](https://www.synaplan.com) · Member of the Open Source Business Alliance
- <p align="center">
- <a href="https://osb-alliance.de/" target="_blank" rel="noopener noreferrer"><img src="docs/images/osba-member.png" alt="OSBA member" width="180" height="90"></a>
- </p>
- <p align="center"><b>If Synaplan helps you own your flow, a ⭐ helps the next team find it.</b></p>
- <p align="center">
- <a href="https://star-history.com/#metadist/synaplan&Date">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=metadist/synaplan&type=Date&theme=dark" />
- <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=metadist/synaplan&type=Date" />
- <img alt="Star history of metadist/synaplan" src="https://api.star-history.com/svg?repos=metadist/synaplan&type=Date" width="720">
- </picture>
- </a>
- </p>
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.