
Deploy Synaplan
Open-source AI platform for your knowledge, models and chat channels
MariaDB
Just deployed
/var/lib/mysql
Just deployed
Synaplan
Just deployed
/var/www/backend/var/uploads
Redis
Just deployed
/data
Deploy and Host Synaplan on Railway
Synaplan is an open-source AI platform for your own knowledge, models and channels: chat with many model providers, upload documents for retrieval-augmented answers, and reach the same assistant from the web, a website widget, email or messengers. This template runs a private Synaplan with its database, cache and document parser.
About Hosting Synaplan
This template deploys four services from published images:
- Synaplan (
ghcr.io/metadist/synaplan): the web app and API on a public HTTPS domain, plus the background worker and scheduler in the same container, with a volume for uploaded files - MariaDB: the database, including document search on MariaDB's vector type, on a volume
- Redis: queue, cache and locks, on a volume
- Tika: Apache Tika for text extraction from PDFs and office files, private only It matches upstream's "lite" quickstart: spoken answers, Qdrant memories and live widget takeover are left out. After deploy:
- Open the Synaplan service's Variables tab and copy
BOOTSTRAP_ADMIN_PASSWORD. - Open https://YOUR-RAILWAY-DOMAIN/login and sign in with
BOOTSTRAP_ADMIN_EMAIL(defaultadmin@synaplan.local) and that password. - Add at least one model key (
GROQ_API_KEY,OPENAI_API_KEY,ANTHROPIC_API_KEYorGOOGLE_GEMINI_API_KEY) to the service variables, or in the app. Synaplan's free Demo tier is switched on too, but its server may refuse requests from cloud hosts. Self-sign-up and guest chat are off; invite users from the admin area.
Common Use Cases
- A private ChatGPT-style assistant for a team, with the model provider of your choice
- Answers grounded in your own PDFs and documents
- One assistant reachable from the web, a website chat widget and email
- Trying many models side by side without sending data to a hosted SaaS
Dependencies for Synaplan Hosting
- An API key for Groq, OpenAI, Anthropic or Google Gemini (or an Ollama server)
- Optional SMTP settings (
MAILER_DSN) for password resets and email channels
Deployment Dependencies
- Synaplan: https://github.com/metadist/synaplan (Apache-2.0)
- Configuration reference: https://github.com/metadist/synaplan/blob/main/docs/CONFIGURATION.md
Implementation Details
- Upstream runs web, worker and scheduler as three containers that share the uploads folder. A Railway volume belongs to one service, so the start command runs the worker and scheduler next to the web role in one container, once the web role has applied migrations and answers its health check. Each restarts on its own if it exits.
APP_SECRET,TOKEN_SECRET, the database and Redis passwords and the first admin password are generated at deploy time.APP_URLandFRONTEND_URLfollow the Railway domain. If you add a custom domain, update both.- Pin a newer release by changing the image tag and
APP_VERSIONtogether; migrations run on start.
Why Deploy Synaplan on Railway?
Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it. By deploying Synaplan on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.
Template Content




