diff --git a/installing/index.html b/installing/index.html index 0bc54fc..a3f1515 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:

    @@ -94,6 +98,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 @@ -137,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

    + +

    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.

    -

    Setting up FRAPI's Administration Interface Virtual Host

    +

    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:

    @@ -176,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 @@ -187,11 +198,11 @@

    Setting up the 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 @@ -224,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:

    @@ -266,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:

    @@ -306,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