CrystalQore
Documentation

Everything you need to
get started.

Comprehensive guides, API references, and tutorials for deploying and managing CrystalQore.

View Full Documentation

Quick Start (5 minutes)

1

Prerequisites

# Ensure you have Node.js 20+ and PostgreSQL 15+ installed
node --version  # v20.x or higher
psql --version  # 15.x or higher
2

Clone & Install

git clone https://github.com/ClearConverse/crystalqore.git
cd crystalqore
npm install
3

Configure Environment

cp .env.example .env
# Edit .env with your database URL, secrets, and settings
nano .env
4

Set Up Database

npx prisma migrate deploy
npx prisma generate
npm run seed  # Optional: seed demo data
5

Start the Application

npm run build
npm start
# Application available at http://localhost:3000

System Requirements

Node.js 20+, PostgreSQL 15+, 2GB RAM minimum

Environment Variables

All required .env configuration options

Authentication

Session management, OAuth, and SSO setup

Configuration

Runtime configuration and feature flags

Guides & References

Installation Guide

Step-by-step setup for self-hosted deployment on bare metal, VMs, or Docker.

Database Setup

Configure PostgreSQL, run migrations, and set up your database for production.

PBX Integration (FusionPBX)

Connect CrystalQore to your FusionPBX or FreeSWITCH-based PBX instance.

Email Setup

Configure Gmail, Outlook, and IMAP email accounts for unified inbox.

Call Pop & Presence

Set up real-time Call Pop screen pops and presence monitoring via FreeSWITCH ESL.

Calendar & Notes

Configure team calendar and notes for your organization.

Fax Configuration

Set up fax sending and receiving through your PBX.

Security Hardening

TLS configuration, firewall rules, RBAC setup, and security best practices.

Multi-Tenant Setup

PREMIUM

Configure multi-tenant architecture for serving multiple organizations. (Premium)

API Reference

Complete REST API documentation for integrations, webhooks, and automation.

SMS / 10DLC Setup

PREMIUM

Configure QuestBlue integration, register 10DLC campaigns, and manage numbers. (Premium)

Desktop App

PREMIUM

Build and deploy the Electron desktop application for Windows, macOS, and Linux. (Premium)

Need help?

Can't find what you're looking for? Our community and support team are here to help.

Community Forum Contact Support