README

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





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




  


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

---

 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 , 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:

bash
curl -fsSL https://raw.githubusercontent.com/metadist/synaplan/main/install.sh | \
  bash -s -- --m

Top issues

Discussions

Latest release

What's Changed
 docs(planning): host the first-party plugins in this repository by @orgaralf in https://github.com/metadist/synaplan/pull/2987
 feat: add the phone settings hub and keep chat with the keyboard by @cristiangrxs in https://github.com/metadist/synaplan/pull/2976
 feat: mark AI conversations and generated media for the AI Act by @cristiangrxs in https://github.com/metadist/synaplan/pull/2990
 chore(release): install 5.7.0 in new deployments by @synaplan-release-tagger[bot] in https://github.com/metadist/synaplan/pull/2986
 refactor: run the content-credentials signer inside the app