Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getcore.me/llms.txt

Use this file to discover all available pages before exploring further.

CORE runs as a set of Docker containers: the web app, PostgreSQL, Neo4j (memory graph), and Redis. You manage the infrastructure; your data never leaves your machine. Requirements: Docker 20.10+, Docker Compose 2.20+, 4 vCPU / 8 GB RAM / 20 GB storage

Option A: One step with the CLI

npm install -g @redplanethq/corebrain && corebrain setup
The wizard asks for an install directory, an AI provider (OpenAI / Anthropic / Google / Ollama / Azure / OpenRouter / DeepSeek / Vercel / Groq / Mistral / xAI), the API key, and a chat model. It auto-generates SESSION_SECRET, ENCRYPTION_KEY, MAGIC_LINK_SECRET, and the Neo4j password, drops a docker-compose.yaml + .env into the directory you picked, and runs docker compose up -d for you. Verify: Open http://localhost:3033 — you should see the CORE login screen. If it doesn’t load, check logs with docker compose logs -f webapp from your install directory.

Option B: One-click on Railway

Deploy on Railway Railway sets up all services automatically. Once deployed, jump to Create your account.

Create your account

Sign in with your email. CORE sends a magic link — check your terminal logs (or Railway service logs) if you haven’t configured an email provider yet:
docker compose logs webapp | grep "magic link"
Copy the link from the logs and open it in your browser.

Connect a channel

A channel is how you message your butler. Email is the easiest to start with: it requires a Resend account and a verified domain. Set up Email with Resend
ChannelEffortGuide
Email (Resend)LowSetup guide
SlackMediumSetup guide
WhatsAppMediumRequires Twilio: TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, TWILIO_WHATSAPP_NUMBER
TelegramCommunitySetup guide
Once a channel is connected, send your first message: your butler will respond.

Next steps

Environment Variables

Full reference for all configuration options.

Embedding Models

Configure OpenAI, Google, or local Ollama embeddings.

Remote Sessions

Trigger Claude Code sessions from WhatsApp or Slack.

Need help? Join #self-hosting on Discord.