From DreamFactory
Jump to: navigation, search
Line 1: Line 1:
DreamFactory is free open source software available under the [ Apache License 2.0].  
DreamFactory is free open source software available under the [ Apache License 2.0].  
We auto-generate REST APIs for a wide variety of services such as databases, file storage, and web services. We also offer a commercial package that includes additional services and support options. More information is available on DreamFactory's [ website].  
DreamFactory runs on Linux, Windows, and Mac OS X.  
There's also a developer forum at The forum is a good way to ask questions and get help from other developers.
There are many ways to try out and use DreamFactory. Follow the installation instructions below.
There are many ways to try out and use DreamFactory, documented below.  
== Free Hosted Developer Environment ==
== Free Hosted Developer Environment ==

Revision as of 17:33, 13 July 2016

DreamFactory is free open source software available under the Apache License 2.0.

DreamFactory runs on Linux, Windows, and Mac OS X.

There are many ways to try out and use DreamFactory. Follow the installation instructions below.

Free Hosted Developer Environment

Sign up for a free DreamFactory-hosted developer account at Your developer environment is hosted by DreamFactory and lets you try out the software. It supports almost all of the available service types including the paid services so you can try before you buy. It's kept updated with the latest releases and patches. Please note that the hosted environment is for trying out the platform, not for running production applications. For production applications you should install DreamFactory for yourself using one of the methods described below.

Bitnami Desktop/Server Installers


You can download DreamFactory as a simple click-through installer for the following desktop operating systems. Most common extensions and drivers are pre-packaged and available in these installers.

  • Linux (CentOS, Red Hat, Mint, Debian, and Ubuntu desktop and server).
  • Mac OS X.
  • Microsoft Windows (Windows 7, 8, 10 and Server 2008R2). Note: that some features may not be available or may be limited in this environment.

Bitnami Virtual Machine

You can download DreamFactory as a virtual machine for VMware, VirtualBox, or other hypervisor environments.

Docker Image

You can build your own Docker image or pull the latest Docker image from Docker Hub.

IaaS Clouds

You can install DreamFactory on IaaS cloud platforms (Infrastructure as a Service). Follow the instructions for the desired platform.

PaaS Clouds

You can install DreamFactory on PaaS cloud platforms (Platform as a Service). Follow the instructions below.


You can also install DreamFactory directly from GitHub. Follow the general instructions after taking care of the requirements for your particular environment.

Note: This quick setup instruction assumes that you are familiar with composer, git and the basics of how to setup a web and database server.

Required Software and Extensions

At minimum, you will need the following software and extensions installed and enabled on your system in order to successfully install and run DreamFactory 2.0 from GitHub.

  • PHP 5.5+ - check and install the requirements below for your particular environment.
    • PHP required modules: curl, sqlite, mongodb (see below)
  • Git - see
  • Composer - see, may require cURL to be installed from particular environment below.
  • MongoDB driver (i.e. - Versions >= 2.1 require the new MongoDB driver to be installed to run composer successfully. If MongoDB is not to be used on your install, please remove the df-mongodb requirement from composer.json before running composer install or upgrade.


Mac OS X

  • Install v8js library
  • Using MAMP
 Using MAMP allows simple stack setup and has some extensions already included. It does not however include v8js. You can follow the above compile instructions and place the file in the desired MAMP PHP extension directory. Also note that MAMP ships with an older version of MySQL (5.5) which does not support some databases options that you may run into, particularly dealing with timestamp fields.


To date, the best way to install DreamFactory on Windows is to use the Bitnami installer mentioned above. Some have had success running DreamFactory on existing WAMP stacks or even IIS. We don't currently have a set of installable instructions, but will address this in the near future.

Setup a Database

Install your native database and any additional drivers required for your database.

Switch System Database

If you want to change from one system database to another after you've already run setup/installation:

  • Stop Apache
  • Edit .env file (in the htdocs folder) to include the right driver, host, and port number. Example:
  • In your shell navigate to the dreamfactory root folder (htdocs in Bitnami installs)
  • Run these commands:
$ php artisan config:clear
$ php artisan cache:clear
$ php artisan dreamfactory:setup
//Answer the on screen prompts
  • Restart Apache

General Instructions

The commands shown here are primarily for a Linux based OS, but should also work on Windows (directory structure is obviously different) with all the required software and extensions installed.

  • Clone this repository to a directory on your system. For testing, using a directory under your home directory is easiest, otherwise choices like /var/www/ or /opt may be preferred.
$ git clone ~/df2
  • Change your working path to that directory.
$ cd ~/df2
  • Install dependencies using composer. For production environment, use --no-dev, otherwise discard that option for a development environment.
$ composer install --no-dev
  • Run DreamFactory setup command-line wizard. This will set up your configuration and prompt you for things like database settings, first admin user account, etc. It will also allow you make environment settings changes midway and then run it again to complete the setup.
$ php artisan dreamfactory:setup
  • Make sure your web server can read/write from/to storage/ (sub directories) and bootstrap/cache/ directories.
$ sudo chown -R {www user}:{your user group} storage/ bootstrap/cache/
$ sudo chmod -R 2775 storage/ bootstrap/cache/

Setup a web server

Use PHP's built in web server (**Note**:: Testing only, not for production use)...

$ php artisan serve

Or provision a web server to run your DreamFactory instance by following these instructions...



Raspberry Pi 2

You can install and configure DreamFactory on Raspberry Pi 2 as an open source IoT gateway. Follow the general instructions here.

Additional Drivers and Modules