3.2 documentation

Platform

Core Components

Optional Components

Installation

  1. Minimum Server Requirements
  2. Install Composer
  3. Install Orchestra Platform
  4. Pretty URLs

Minimum Server Requirements

System requirements for Orchestra Platform:

  • PHP >= 5.5.9 (we highly recommend using PHP 5.6 or newer for your projects).
  • PHP Extensions:
    • OpenSSL
    • Mbstring
  • Apache, Nginx, or another compatible web server.
  • SQLite, MySQL, PostgreSQL, or SQL Server PDO drivers.

Install Composer

Orchestra Platform utilizes Composer to manage its dependencies. So, before using Orchestra Platform, you will need to make sure you have Composer installed on your machine.

Install Orchestra Platform

Download

You can install Orchestra Platform using Composer:

composer create-project orchestra/platform --prefer-dist

Preparing Installation

To running the setup to install Orchestra Platform on your local machine, it best to do the following:

  1. Set the application key by running php artisan key:generate, this will be reflected as APP_KEY in .env.
  2. Setup APP_ENV values, the default local environment is commonly used for local (development) environment.
  3. Configure database connection via .env.
  4. Folders within storage and bootstrap/cache requires write access by the web server.

Setup

Once Orchestra Platform is properly configured, we need to run the installation and create the application basic schema (including the creation of administrator user).

  1. Run php artisan serve or use your prefered web server stack or Vagrant (Homestead etc).
  2. Browse to the installation page, for example http://localhost:8000/admin and follow the installation process.
  3. And... you're done.

Pretty URLs

Apache

The framework ships with a public/.htaccess file that is used to allow URLs without index.php. If you use Apache to serve your Orchestra Platform application, be sure to enable the mod_rewrite module.

If the .htaccess file that ships with Orchestra Platform does not work with your Apache installation, try this one:

Options +FollowSymLinks
RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]

Nginx

On Nginx, the following directive in your site configuration will allow "pretty" URLs:

location / {
    try_files $uri $uri/ /index.php?$query_string;
}

Of course, when using Homestead, pretty URLs will be configured automatically.