Documentation

Technical guides for
deploying and operating GiftSentry.

Reference documentation for IT teams, developers, and platform operators. Full deployment playbook, API reference, integration guides, and environment variable index.

Documentation Index

Everything you need to deploy, configure, and operate.

Deployment Playbook
Step-by-step Docker Compose deployment guide. Server setup, SSL configuration with Caddy, Cloudflared tunnel, multi-environment pinning, and first-run verification.
Getting Started
Environment Variables
Complete reference for all required and optional environment variables. Core platform, payment keys, AI providers, integrations, and ops configuration.
Configuration
API Reference
tRPC router definitions with full TypeScript contracts. All procedures documented with input validation, output types, and authentication requirements.
Developers
Stripe Integration Guide
Configuring Stripe live and test mode, webhook endpoint setup and secret rotation, partner mode for foundations, ACH configuration, and recurring payment engine.
Integrations
Google & Meta Integration
OAuth flow setup for Google Ads, GA4, and Calendar. Meta Business account connection. Audience sync configuration, attestation gate setup, and credential encryption.
Integrations
Blackbaud CSV Guide
Column mapping specifications for constituent and gift imports from Raiser's Edge NXT. Export format reference, data cleaning recommendations, and validation checklist.
Data Migration
Security Best Practices
Encryption key management, INTEGRATION_ENCRYPTION_KEY rotation, webhook secret rotation, RBAC configuration, and credential storage architecture.
Security
Cron Job Registry
Reference for all 20+ scheduled jobs. Frequency, trigger endpoint, manual execution via POST, job dependencies, and monitoring endpoint documentation.
Operations
Monitoring & Alerting
Ops status endpoint reference, deployment registry setup, health snapshot configuration, incident threshold tuning, alert silencing for maintenance windows.
Operations
Environment Variables

Quick reference for core configuration.

VariablePurposeRequired
AUTH_SECRETNextAuth session signing key — 32+ random bytesRequired
DATABASE_URLPostgreSQL connection string for primary databaseRequired
PASSPORT_ORIGINOrigin URL for cross-domain SSO token mintingRequired
STRIPE_SECRET_KEY_*Stripe secret key (live and test variants)Required
STRIPE_WEBHOOK_SECRET_*Webhook signing secret for payment event verificationRequired
INTEGRATION_ENCRYPTION_KEYAES key for encrypting third-party API credentials at restRequired
OPENAI_API_KEYOpenAI API key for AI features (research, content generation)If AI enabled
XAI_API_KEYxAI/Grok API key — alternative AI providerOptional
AI_PROVIDERSwitch between openai and xai providersOptional
GOOGLE_CLIENT_ID/SECRETGoogle OAuth for Ads, Analytics, Calendar connectionsIf Google enabled
RESEND_API_KEYResend API key for outbound and inbound emailIf email enabled
OPS_STATUS_TOKENBearer token for the /api/ops/status health endpointRequired
OPS_JOBS_CRON_SECRETSecret for authenticating cron job trigger requestsRequired
EVANET_ALERT_EMAILEmail address for incident alerting notificationsRecommended
Need Help?

Documentation questions? We respond directly.

During the proof-of-concept period, your IT team gets direct access to us via a dedicated Slack channel. No support ticket queues.

Contact Us → Request Demo