From DreamFactory
Jump to: navigation, search
Line 40: Line 40:
$ ../../../php/bin/php composer.phar self-update
$ ../../../php/bin/php composer.phar self-update
$ ../../../php/bin/php composer.phar install --no-dev
$ ../../../php/bin/php composer.phar install --no-dev
$ ../../../php/bin/php artisan migrate
$ ../../../php/bin/php artisan migrate --seed
$ ../../../php/bin/php artisan cache:clear
$ ../../../php/bin/php artisan cache:clear
$ ../../../ restart
$ ../../../ restart
Line 222: Line 222:
$ php composer.phar self-update
$ php composer.phar self-update
$ php composer.phar install --no-dev
$ php composer.phar install --no-dev
$ php artisan migrate
$ php artisan migrate --seed
$ php artisan cache:clear
$ php artisan cache:clear

Revision as of 16:44, 4 December 2015

DreamFactory is free open source software available under the [Apache License 2.0](

We provide optional paid support subscriptions for both development and production. More information on support packages is available on DreamFactory's [website](

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, documented below.

    1. 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 has all the same capabilities as the installed open source package (except for server-side scripting), but it's for trying out DreamFactory, not for running production applications. It is kept updated with the latest releases and patches.

    1. Bitnami Desktop/Server Installers
      1. Installation

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.

      1. Upgrade

Bitnami installers do not provide a direct method of upgrading, but you can upgrade the DreamFactory code base by using Git and Composer.

        1. Mac OS X and Linux
//change this line to your bitnami dreamfactory installation path. For example:
$ cd /Applications/dreamfactory-2.0.1-1/apps/dreamfactory
//this is taking a backup just in case
$ cp -r htdocs htdocs.old
$ cd htdocs
//stash only if you have changes you have made to the local install
$ git stash
$ git checkout master
$ git pull origin master
//self-update is optional, try it if you get an error without it
$ ../../../php/bin/php composer.phar self-update
$ ../../../php/bin/php composer.phar install --no-dev
$ ../../../php/bin/php artisan migrate --seed
$ ../../../php/bin/php artisan cache:clear
$ ../../../ restart
        1. Windows

This process requires you to have a Windows GIT client with a shell.

Copy the folder C:\Bitnami\dreamfactory-x.x.x-x\apps\dreamfactory\htdocs to C:\Bitnami\dreamfactory-x.x.x-x\apps\dreamfactory\htdocs.old

In your GIT client of choice run:

C:\path> cd C:\Bitnami\dreamfactory-x.x.x-x\apps\dreamfactory\htdocs
C:\path> git stash
C:\path> git checkout master
C:\path> git pull origin master
C:\path> C:\Bitnami\dreamfactory-x.x.x-x\php\php.exe composer.phar self-update
C:\path> C:\Bitnami\dreamfactory-x.x.x-x\php\php.exe composer.phar install --no-dev
C:\path> C:\Bitnami\dreamfactory-x.x.x-x\php\php.exe artisan migrate --seed
C:\path> C:\Bitnami\dreamfactory-x.x.x-x\php\php.exe artisan cache:clear

Use the Bitnami DreamFactory Stack Manager to restart your servers.

      1. Troubleshooting

Some upgrades require database schema updates to continue operating correctly. Try the following commands if you run into errors after a software upgrade.

$ php artisan migrate
$ php artisan db:seed
$ php artisan cache:clear

If you still encounter problems, please contact our [support](DreamFactory/Support) for help.

    1. Bitnami Virtual Machine

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

    1. Docker Image

You can build your own Docker [image]( or pull the latest [Docker image from Docker Hub](

    1. IaaS Clouds

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

    1. PaaS Clouds

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

  • [Pivotal Web Services]() - Coming Soon.
  • [IBM Bluemix]() - Coming Soon.
  • [Red Hat OpenShift]() - Coming Soon.
  • [Heroku]() - Coming Soon.
    1. GitHub

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._

      1. 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.
  • Git - see [[1]]
  • Composer - see [[2]], may require cURL to be installed from particular environment below.
        1. Linux
  • [CentOS or RedHat](Installation/Linux/Yum)
  • [Mint, Debian or Ubuntu](Installation/Linux/Apt)
        1. Mac OS X
  • Install mcrypt library
  • Install v8js library
  • Using MAMP
 Using MAMP allows simple stack setup and has some extensions already included, like mcrypt. 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.
        1. Windows

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.

      1. Setup a Database

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

  • [SQLite](Installation/Databases/SQLite)
  • [MySQL, MariaDB, or Percona](Installation/Databases/MySQL)
  • [PostgreSQL](Installation/Databases/PostgreSQL)
  • [Microsoft SQL Server](Installation/Databases/SQLServer)
  • [SAP SQL Anywhere](Installation/Databases/SQLAnywhere)
      1. 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 cache:clear
$ php artisan dreamfactory:setup
//Answer the on screen prompts
  • Restart Apache
      1. 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/
      1. 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...

        1. Nginx
  • [Debian/Mint/Ubuntu](Installation/Linux/Apt)
  • [CentOS/RedHat](Installation/Linux/Yum)
        1. Apache
  • [Debian/Mint/Ubuntu](Installation/Linux/Apt)
  • [CentOS/RedHat](Installation/Linux/Yum)
      1. Upgrade

Use git commands to pull the latest code from the dreamfactory repo. For example,

$ git stash
$ git checkout master
$ git pull origin master
//self-update is optional, you might get an error without the latest copy of composer
$ php composer.phar self-update
$ php composer.phar install --no-dev
$ php artisan migrate --seed
$ php artisan cache:clear

    1. Drivers
      1. MS SQL
        1. Windows
  • Install DreamFactory.
  • Download and install Microsoft ODBC Driver 11 for SQL Server (if not already installed). Currently this is available [here]( In 32-bit environments, install the x86 package. In 64-bit environments, install the x64 package.
  • Download and install the appropriate SQL Server Native Client (if not already installed and SQL Server is not hosted on the same machine as DSP). In 32-bit environments, install the x86 package. In 64-bit environments, install the x64 package. Currently the Microsoft SQL Server 2012 Native Client is available [here](, and the Microsoft SQL Server 2008 R2 Native Client is available [here](
  • DreamFactory uses PHP PDO drivers for DB connections. Full documentation on PDO_SQLSRV is available [here]( You will need to download and extract the Microsoft Drivers for PHP for SQL Server. Currently these are available [here](
  • Copy the DLLs for your version of PHP into your PHP's extensions directory. E.g., for PHP 5.5, the DLLs are php_pdo_sqlsrv_55_ts.dll and php_sqlsrv_55_ts.dll (which were extracted from the download in the third step). (Rare case: if you are integrating with IIS as your web server, use the non-thread-safe DLLs instead (php_pdo_sqlsrv_55_nts.dll and php_sqlsrv_55_nts.dll).)
  • Enable the copied DLLs in your php.ini file. Using the example DLLs from step #4, you would add the following lines to C:\Bitnami\dreamfactory-2.0.1-1\php\php.ini and save:
    • ```extension=php_pdo_sqlsrv_55_ts.dll```
    • ```extension=php_sqlsrv_55_ts.dll```
  • Restart your web server to apply these PHP configuration changes.