Welcome to DreamFactory Documentation
DreamFactory is an open-source REST API platform that automatically generates secure, fully documented APIs for any data source in minutes. Whether you're connecting to databases, external services, or file systems, DreamFactory eliminates the need to write backend code.
Getting Started
New to DreamFactory? Start here to get up and running quickly.
- Introducing REST & DreamFactory - Understanding REST APIs and how DreamFactory works
- Docker Installation - Quick start with Docker containers
- Helm/Kubernetes Installation - Deploy to Kubernetes clusters
- Linux Installation - Traditional Linux server installation
- Windows Installation - Install on Windows servers
- Basic Configuration - Essential setup after installation
API Generation & Connections
Learn how to create and manage APIs for your data sources.
Database APIs
- Generating Database-Backed APIs - Connect MySQL, PostgreSQL, MongoDB, SQL Server, Oracle, and more
- Querying & Filtering - Advanced database queries, filtering, sorting, and pagination
- SQL Server - SQL Server specific configuration
File Storage APIs
- Creating AWS S3 REST API - S3 file storage integration
- Creating SFTP REST API - SFTP server integration
- Converting Excel to JSON - Transform Excel files to JSON
Scripting
- Scripted Services & Endpoints - Add custom business logic with JavaScript, PHP, or Python
- Event Scripts - Trigger scripts before/after API calls
- Scripting Resources - Available scripting libraries and examples
General
- API Keys - Generate and manage API keys
- Interacting with APIs - Making API calls and using the API Docs tab
- Advanced Database Features - Stored procedures, relationships, and virtual fields
Security & Access Control
Implement enterprise-grade security for your APIs.
- Role-Based Access Control - Define granular permissions for users and endpoints
- Authentication APIs - API-based authentication workflows
- Okta Setup - Integrate with Okta OAuth
- SQL Server Security - SQL Server authentication configuration
- Security FAQ - Common security questions answered
System API
Programmatically manage DreamFactory for automation and DevOps workflows.
- System API Overview - Introduction to the System API
- User Management - Manage users programmatically
- Service Management - Manage services via API
- Role Management - Manage roles via API
- API Key Management - Manage API keys via API
Configuration
- CORS & SSL - Configure CORS and SSL settings
- Date & Time - Time zone and date format settings
Optimization & Performance
- Database Optimization - Database caching and connection pooling
Upgrades & Migrations
Keep your DreamFactory instance up to date.
- Upgrading & Migrating DreamFactory - Move between environments
- Upgrading to PHP 8.1 - PHP 8.1 migration guide
- Upgrading PHP on Windows - Windows-specific PHP upgrades
Additional Resources
- DreamFactory Blog - Tutorials, use cases, and product updates
- GitHub Repository - Contribute to the open-source project
- Legacy Guide - Previous version documentation