Installation¶

Download from composer¶

Download the latest version of 2.1, in the current directory

composer create-project -sdev --no-interaction ppi/skeleton-app /var/www/skeleton "^2.1"

Downloading from the website¶

http://www.ppi.io/downloads

Automatic Vagrant Installation¶

The recommended install procedure is to use the pre-built vagrant image that ships with the skeleton app in the ansible directory.

Installing vagrant and ansible¶

Before you can run vagrant you’ll need to install a few system dependencies.

Install vagrant https://docs.vagrantup.com/v2/installation/

Install ansible: http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip

Running vagrant¶

Running the vagrant image - it’s that easy!

vagrant up

Accessing the application¶

If you wish to use the skeletonapp as a hostname, run this command and browse to http://skeletonapp.ppi

sudo sh -c 'echo "192.168.33.99 skeletonapp.ppi" >> /etc/hosts'

Otherwise you can browse straight to the ip address of: http://192.168.33.99

Manual Web Server Configuration¶

Security is crucial to consider. As a result all your app code and configuration is kept hidden away outside of /public/ and is inaccessible via the browser. Therefore we need to create a virtual host in order to route all web requests to the /public/ folder and from there your public assets (css/js/images) are loaded normally. The .htaccess or web server’s rewrite rules kick in which route all non-asset files to /public/index.php.

Apache Configuration¶

We are now creating an Apache virtual host for the application to make http://skeletonapp.ppi serve index.php from the skeletonapp/public directory.

<VirtualHost *:80>
    ServerName    skeletonapp.ppi
    DocumentRoot  "/var/www/skeleton/public"
    SetEnv        PPI_ENV dev
    SetEnv        PPI_DEBUG true

    <Directory "/var/www/skeleton/public">
        AllowOverride All
        Allow from all
        DirectoryIndex index.php
        Options Indexes FollowSymLinks

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

    </Directory>
</VirtualHost>

Nginx Virtual Host¶

server {
    listen 80;
    server_name skeletonapp.ppi;
    root /var/www/skeleton/public;
    index index.php;

    location / {
        try_files $uri /index.php$is_args$args;
    }

    location ~ \.php$ {
        fastcgi_pass 127.0.0.1:9000;
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param HTTPS off;
    }
}

Restart your web server. The skeletonapp website can now be accessed using http://skeletonapp.ppi

Requirements¶

To easily check if your system passes all requirements, PPI provides two ways and we recommend you do both.

Why do we have both scripts? Because your CLI environment can have a separate php.ini file from your web environment so this will ensure you’re good to go from both sides.

Requirements checking on the command-line¶

$ ./app/check
                       _
        _____   _____ |_|
      / __  | / __ | / |
      | |__| || |__| || |
      |  ___/ |  ___/ | |
      | |     | |     |_|
      |/      |/

      Framework Version 2

    -- Requirements Check --

* Configuration file used by PHP: /etc/php/cli-php5.4/php.ini
* Mandatory requirements **

OK       PHP version must be at least 5.3.3 (5.4.13--pl0-gentoo installed)
OK       PHP version must not be 5.3.16 as PPI won't work properly with it
OK       Vendor libraries must be installed
OK       app/cache/ directory must be writable
OK       app/logs/ directory must be writable
OK       date.timezone setting must be set
OK       Configured default timezone "Europe/Lisbon" must be supported by your installation of PHP
OK       json_encode() must be available
OK       session_start() must be available
OK       ctype_alpha() must be available
OK       token_get_all() must be available
OK       simplexml_import_dom() must be available
OK       detect_unicode must be disabled in php.ini
OK       xdebug.show_exception_trace must be disabled in php.ini
OK       xdebug.scream must be disabled in php.ini
OK       PCRE extension must be available

Watch out for the green OK markers. If they all light up, congratulations, you’re good to go!

Below is the list of required and optional requirements.

Requirements checking in the browser¶

The check.php script is accessible in your browser at: http://skeletonapp.ppi/check.php

Must have requirements¶

PHP needs to be a minimum version of PHP 5.3.3
JSON needs to be enabled
ctype needs to be enabled
Your PHP.ini needs to have the date.timezone setting

Optional requirements¶

You need to have the PHP-XML module installed
You need to have at least version 2.6.21 of libxml
PHP tokenizer needs to be enabled
mbstring functions need to be enabled
iconv needs to be enabled
POSIX needs to be enabled (only on *nix)
Intl needs to be installed with ICU 4+
APC 3.0.17+ (or another opcode cache needs to be installed)
PHP.ini recommended settings
- short_open_tag = On
- magic_quotes_gpc = Off
- register_globals = Off
- session.autostart = Off