From 92bc4f3c852fc2567dd793ace736d67d966a0248 Mon Sep 17 00:00:00 2001 From: Kim Rowan Date: Thu, 2 Aug 2012 13:27:04 +0100 Subject: [PATCH 1/4] Minor edits to installation instructions file --- installing/index.html | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/installing/index.html b/installing/index.html index 0bc54fc..967ba48 100644 --- a/installing/index.html +++ b/installing/index.html @@ -94,6 +94,9 @@

Downloading the Tarb

Go to https://github.com/frapi/frapi/tarball/master and download the tar.gz to your install directory.

Uncompress the tar using the tar -xzvf frapi-frapi-VERSION.tar.gz command.

+

Install required submodule

+

From within the FRAPI_PATH root directory, run git submodule update --init to install the required Ace (Ajax.org Cloud9 Editor) submodule.

+

Setting Directory and File Permissions

You're about see a lot of references to something called @@ -187,11 +190,11 @@

Setting up the Date: Thu, 2 Aug 2012 13:29:12 +0100 Subject: [PATCH 2/4] Modify id of h3 tag for new submodule heading --- installing/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installing/index.html b/installing/index.html index 967ba48..a147eaa 100644 --- a/installing/index.html +++ b/installing/index.html @@ -94,7 +94,7 @@

Downloading the Tarb

Go to https://github.com/frapi/frapi/tarball/master and download the tar.gz to your install directory.

Uncompress the tar using the tar -xzvf frapi-frapi-VERSION.tar.gz command.

-

Install required submodule

+

Install required submodule

From within the FRAPI_PATH root directory, run git submodule update --init to install the required Ace (Ajax.org Cloud9 Editor) submodule.

Setting Directory and File Permissions

From 84d2f5ee50710242376060070fb48ef012274111 Mon Sep 17 00:00:00 2001 From: Kim Rowan Date: Tue, 14 Aug 2012 15:46:17 +0100 Subject: [PATCH 3/4] Further modifications to text --- installing/index.html | 58 ++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/installing/index.html b/installing/index.html index a147eaa..c464385 100644 --- a/installing/index.html +++ b/installing/index.html @@ -35,18 +35,22 @@

Installing FRAPI

  • Directory Permissions
    • -
  • Configuring Apache +
  • HTTP Server Configuration -
    • -
  • Configuring Nginx -
    • @@ -61,7 +65,7 @@

    FRAPI

    FRAPI also has dependencies on the following modules:

      -
    • (Enabled by default and strongly recommended) APC: Required for caching of actions, errors, etc. See the Caching Adapters section for more details on other caching mechanisms available.
      • +
    • (Enabled by default and strongly recommended) APC: Required for caching of actions, errors, etc. See the Caching Adapters section for more details on other caching mechanisms available (and how to run FRAPI without caching, although this is not recommended).
    • (Required by the admin interface) PHP Gettext is used for multilingualism in the administration interface. On Ubuntu Linux, install the package php-gettext.
    • (Required by the admin interface) XMLWriter is used to write all of the configuration files. This extension is enabled by default in PHP core but it is known to be disabled in some PHP packages.
    @@ -140,14 +144,18 @@

    Directory P chmod 664 FRAPI_PATH/src/frapi/custom/Config/*.xml -

    If you're using Linux you could run the FRAPI_PATH/setup.sh script. The setup.sh script will -initialize the ArmChair submodule and set directory permissions with the commands you see above.

    +

    If you're using Linux you could run the FRAPI_PATH/setup.sh script. 

    sudo sh setup.sh
    -

    Configuring Apache

    +

    HTTP Server Configuration

    -

    Setting up FRAPI's Administration Interface Virtual Host

    +

    At echolibre we run nearly all our FRAPI services under Nginx for performance reasons. We therefore recommend using Nginx instead +of Apache whenever possible when it comes to FRAPI, however, configuration settings for both are provided below.

    + +

    Configuring Apache

    + +

    Setting up FRAPI's Administration Interface Virtual Host

    In order to setup FRAPI's admin interface, you'll need to setup a virtual host with the following configuration:

    @@ -208,17 +216,11 @@

    Setting up the Setting Directory and File Permissions) are correct then restart Apache.

    -

    If you open your browser to http://api.frapi you should now see an XML payload that has an error that has the code -ERROR_INVALID_ACTION_REQUEST

    - -

    Configuring Nginx

    +

    If you open your browser to http://api.frapi you should now see the API documentation page

    -

    NOTE: At echolibre we run nearly all our FRAPI services -under Nginx for performance reasons. We therefore recommend using Nginx instead -of Apache whenever possible when it comes to FRAPI.

    +

    Configuring Nginx

    -

    Before we Start

    +

    Before we Start

    This documentation section assumes that you have Nginx setup to run with PHP as FastCGI. If you haven't setup @@ -227,7 +229,7 @@

    Before we Start

    post as it will be vital to your understanding and fulfillment of this setup.

    -

    FastCGI Parameters

    +

    FastCGI Parameters

    Here's a list of the parameters you'll need in your fastcgi_params in order for Nginx and FRAPI to work nicely together:

    @@ -269,7 +271,7 @@

    FastCGI Parameters -

    Setting up FRAPI's Administration Interface Virtual Host

    +

    Setting up FRAPI's Administration Interface Virtual Host

    In order to setup FRAPI's admin interface, you'll need to setup a virtual host with the following configuration:

    @@ -309,7 +311,7 @@

    Setting up FRAPI's Admin screen with a login and password (Username: admin, password: password)

    -

    Setting up the API frontend

    +

    Setting up the API frontend

    The API frontend is the API that third party developers will be accessing. Very From 261151da4c957b0600f8ba4f24c9e00287c4e46d Mon Sep 17 00:00:00 2001 From: Kim Rowan Date: Tue, 14 Aug 2012 15:54:20 +0100 Subject: [PATCH 4/4] Fix a stray h3 under Apache Config to h4 --- installing/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installing/index.html b/installing/index.html index c464385..a3f1515 100644 --- a/installing/index.html +++ b/installing/index.html @@ -187,7 +187,7 @@

    Setting up FRAPI's Admi screen with a login and password (Username: admin, password: password)

    -

    Setting up the API frontend

    +

    Setting up the API frontend

    The API frontend is the API that third party developers will be accessing. Very