Skip to content

metadist/synaplan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,245 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Synaplan

AI-powered knowledge management with RAG, chat widgets, and multi-channel integration.

License

Live instance: web.synaplan.com

Synaplan Dashboard


Quick Start

git clone <repository-url>
cd synaplan
docker compose up -d

Open http://localhost:5173 — ready in ~2 minutes.


Install Options

Mode Command Size Best For
Standard docker compose up -d ~9 GB Full features, local AI
Minimal docker compose -f docker-compose-minimal.yml up -d ~5 GB Cloud AI only (Groq/OpenAI)

For minimal install, add your API key:

echo "GROQ_API_KEY=your_key" >> backend/.env && docker compose restart backend

Access

Service URL
App http://localhost:5173
API http://localhost:8000
API Docs http://localhost:8000/api/doc
phpMyAdmin http://localhost:8082
MailHog http://localhost:8025

Default Login Credentials:

Email Password Level
admin@synaplan.com admin123 ADMIN
demo@synaplan.com demo123 PRO
test@example.com test123 NEW (unverified)

Features

  • AI Chat — Ollama, OpenAI, Anthropic, Groq, Gemini
  • RAG Search — Semantic document search with MariaDB VECTOR or Qdrant
  • Chat Widget — Embed on any website
  • WhatsApp — Meta Business API integration
  • Email — AI-powered email responses
  • Audio — Whisper transcription
  • Documents — PDF, Word, Excel, images with OCR
  • AI Memories — User profiling with Qdrant vector search
  • Feedback System — False-positive detection and learning

Qdrant Vector Database

Qdrant runs as an internal Docker service — no configuration needed. It powers AI memories, RAG document search, and the feedback system.

Starts automatically with docker compose up -d. Synaplan works fully without it (memories and vector search will be disabled).


Text-to-Speech (Optional)

For voice output, run synaplan-tts alongside Synaplan:

git clone https://github.com/metadist/synaplan-tts.git && cd synaplan-tts && docker compose up -d

Common Commands

# Logs
docker compose logs -f backend

# Restart
docker compose restart backend

# Reset database
docker compose down -v && docker compose up -d

# Run tests
make test

# Code quality
make lint

Documentation

Guide Description
Installation Detailed setup instructions
Configuration Environment variables, API keys
Development Commands, testing, architecture
RAG System Document search and processing
Chat Widget Embed chat on websites
WhatsApp Meta Business API setup
Email Email channel integration

Project Structure

synaplan/
├── backend/        # Symfony PHP API
├── frontend/       # Vue.js SPA
├── docs/           # Documentation
├── _docker/        # Docker configs
└── plugins/        # Plugin system

Contributing

See AGENTS.md for development guidelines and code standards.


License

Apache-2.0

About

Our AI framework for PHP8.3 and higher. Talk to various models and get a chat window with it

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors