Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor edits to installation instructions #9

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Minor edits to installation instructions #9

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92bc4f3
Minor edits to installation instructions file
Aug 2, 2012
9825fa7
Modify id of h3 tag for new submodule heading
Aug 2, 2012
84d2f5e
Further modifications to text
Aug 14, 2012
261151d
Fix a stray h3 under Apache Config to h4
Aug 14, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 37 additions & 32 deletions installing/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,22 @@ <h1 id="frapi.installing">Installing FRAPI</h1>
<li><a href="#frapi.installing.directory.and.file.permissions.permissions">Directory Permissions</a></li>
</ul>
</li>
<li><a href="#frapi.installing.configuring.apache">Configuring Apache</a>
<li><a href="#frapi.installing.http.server.configuration">HTTP Server Configuration</a>
<ul>
<li><a href="#frapi.installing.configuring.apache.admin.vhost">Setting up FRAPI's administration interface virtual host</a></li>
<li><a href="#frapi.installing.configuring.apache.api.vhost">Setting up the API frontend</a></li>
</ul>
</li>
<li><a href="#frapi.installing.configuring.nginx">Configuring Nginx</a>
<ul>
<li><a href="#frapi.installing.configuring.nginx.before">Before we Start</a></li>
<li><a href="#frapi.installing.configuring.nginx.fastcgi.params">FastCGI Parameters</a></li>
<li><a href="#frapi.installing.configuring.nginx.admin.vhost">Setting up FRAPI's administration interface virtual host</a></li>
<li><a href="#frapi.installing.configuring.nginx.api.vhost">Setting up the API frontend</a></li>
<li><a href="#frapi.installing.configuring.apache">Configuring Apache</a>
<ul>
<li><a href="#frapi.installing.configuring.apache.admin.vhost">Setting up FRAPI's administration interface virtual host</a></li>
<li><a href="#frapi.installing.configuring.apache.api.vhost">Setting up the API frontend</a></li>
</ul>
</li>
<li><a href="#frapi.installing.configuring.nginx">Configuring Nginx</a>
<ul>
<li><a href="#frapi.installing.configuring.nginx.before">Before we Start</a></li>
<li><a href="#frapi.installing.configuring.nginx.fastcgi.params">FastCGI Parameters</a></li>
<li><a href="#frapi.installing.configuring.nginx.admin.vhost">Setting up FRAPI's administration interface virtual host</a></li>
<li><a href="#frapi.installing.configuring.nginx.api.vhost">Setting up the API frontend</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand All @@ -61,7 +65,7 @@ <h3 id="frapi.installing.requirements.and.dependencies.frapi">FRAPI</h3>
<p>FRAPI also has dependencies on the following modules:</p>

<ul>
<li><em>(Enabled by default and strongly recommended)</em> <a href="http://php.net/manual/en/book.apc.php">APC</a>: Required for caching of actions, errors, etc. See the <a href="/installing/caching.html" title="FRAPI caching adapters">Caching Adapters</a> section for more details on other caching mechanisms available.</li>
<li><em>(Enabled by default and strongly recommended)</em> <a href="http://php.net/manual/en/book.apc.php">APC</a>: Required for caching of actions, errors, etc. See the <a href="/installing/caching.html" title="FRAPI caching adapters">Caching Adapters</a> section for more details on other caching mechanisms available (and <a href="/installing/caching.html#frapi.caching.mechanisms.dummy" title="FRAPI without caching">how to run FRAPI without caching</a>, although this is not recommended).</li>
<li><em>(Required by the admin interface)</em> <a href="http://php.net/gettext">PHP Gettext</a> is used for multilingualism in the administration interface. On Ubuntu Linux, install the package php-gettext.</li>
<li><em>(Required by the admin interface)</em> <a href="http://php.net/xmlwriter">XMLWriter</a> 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.</li>
</ul>
Expand Down Expand Up @@ -94,6 +98,9 @@ <h3 id="frapi.installing.getting.frapi.downloading.tarball">Downloading the Tarb
<p>Go to <a href="https://github.com/frapi/frapi/tarball/master">https://github.com/frapi/frapi/tarball/master</a> and download the tar.gz to your install directory.</p>
<p>Uncompress the tar using the <code>tar -xzvf frapi-frapi-VERSION.tar.gz</code> command.</p>

<h3 id="frapi.installing.getting.frapi.downloading.submodule">Install required submodule</h3>
<p>From within the FRAPI_PATH root directory, run <code>git submodule update --init</code> to install the required Ace (Ajax.org Cloud9 Editor) submodule.</p>

<h2 id="frapi.installing.directory.and.file.permissions">Setting Directory and File Permissions</h2>

<p>You're about see a lot of references to something called
Expand Down Expand Up @@ -137,14 +144,18 @@ <h3 id="frapi.installing.directory.and.file.permissions.permissions">Directory P
chmod 664 FRAPI_PATH/src/frapi/custom/Config/*.xml
</pre>

<p>If you're using Linux you could run the <code>FRAPI_PATH/setup.sh</code> script. The <code>setup.sh</code> script will
initialize the <a href="http://github.com/till/armchair">ArmChair</a> submodule and set directory permissions with the commands you see above.</p>
<p>If you're using Linux you could run the <code>FRAPI_PATH/setup.sh</code> script.

<pre>sudo sh setup.sh</pre>

<h2 id="frapi.installing.configuring.apache">Configuring Apache</h2>
<h2 id="frapi.installing.http.server.configuration">HTTP Server Configuration</h2>

<p>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.</p>

<h3 id="frapi.installing.configuring.apache.admin.vhost">Setting up FRAPI's Administration Interface Virtual Host</h3>
<h3 id="frapi.installing.configuring.apache">Configuring Apache</h3>

<h4 id="frapi.installing.configuring.apache.admin.vhost">Setting up FRAPI's Administration Interface Virtual Host</h4>

<p>In order to setup FRAPI's admin interface, you'll need to setup a virtual
host with the following configuration:</p>
Expand Down Expand Up @@ -176,7 +187,7 @@ <h3 id="frapi.installing.configuring.apache.admin.vhost">Setting up FRAPI's Admi
screen with a login and password (Username: <strong>admin</strong>, password:
<strong>password</strong>)</p>

<h3 id="frapi.installing.configuring.apache.api.vhost">Setting up the <span class="caps">API</span> frontend</h3>
<h4 id="frapi.installing.configuring.apache.api.vhost">Setting up the <span class="caps">API</span> frontend</h4>

<p>The <span class="caps">API</span> frontend is the <span
class="caps">API</span> that third party developers will be accessing. Very
Expand All @@ -187,11 +198,11 @@ <h3 id="frapi.installing.configuring.apache.api.vhost">Setting up the <span clas
&lt;VirtualHost *:80&gt;
ServerName api.frapi
ServerAdmin admin@api.frapi
DocumentRoot FRAPI_PATH/src/frapi/public


# This should be omitted in the production environment
SetEnv APPLICATION_ENV development


DocumentRoot FRAPI_PATH/src/frapi/public
&lt;Directory FRAPI_PATH/src/frapi/public&gt;
AllowOverride All
Order deny,allow
Expand All @@ -205,17 +216,11 @@ <h3 id="frapi.installing.configuring.apache.api.vhost">Setting up the <span clas
FRAPI_PATH (Defined in <a
href="#frapi.installing.directory.and.file.permissions">Setting Directory and File Permissions</a>) are correct then restart Apache.</p>

<p>If you open your browser to <a href="http://api.frapi">http://api.frapi</a> you should now see an <span
class="caps">XML</span> payload that has an error that has the code
<strong>ERROR_INVALID_ACTION_REQUEST</strong></p>

<h2 id="frapi.installing.configuring.nginx">Configuring Nginx</h2>
<p>If you open your browser to <a href="http://api.frapi">http://api.frapi</a> you should now see the API documentation page</p>

<p><strong>NOTE</strong>: 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.</p>
<h3 id="frapi.installing.configuring.nginx">Configuring Nginx</h3>

<h3 id="frapi.installing.configuring.nginx.before">Before we Start</h3>
<h4 id="frapi.installing.configuring.nginx.before">Before we Start</h4>

<p>This documentation section assumes that you have Nginx setup to run with
<span class="caps">PHP</span> as FastCGI. If you haven't setup
Expand All @@ -224,7 +229,7 @@ <h3 id="frapi.installing.configuring.nginx.before">Before we Start</h3>
post</a> as it will be vital to your understanding and fulfillment of
this setup.</p>

<h3 id="frapi.installing.configuring.nginx.fastcgi.params">FastCGI Parameters</h3>
<h4 id="frapi.installing.configuring.nginx.fastcgi.params">FastCGI Parameters</h4>

<p>Here's a list of the parameters you'll need in your fastcgi_params in order
for Nginx and FRAPI to work nicely together:</p>
Expand Down Expand Up @@ -266,7 +271,7 @@ <h3 id="frapi.installing.configuring.nginx.fastcgi.params">FastCGI Parameters</h
for fastcgi params or look in your /etc/nginx/fastcgi_params configuration
file.</p>

<h3 id="frapi.installing.configuring.nginx.admin.vhost">Setting up FRAPI's Administration Interface Virtual Host</h3>
<h4 id="frapi.installing.configuring.nginx.admin.vhost">Setting up FRAPI's Administration Interface Virtual Host</h4>

<p>In order to setup FRAPI's admin interface, you'll need to setup a virtual
host with the following configuration:</p>
Expand Down Expand Up @@ -306,7 +311,7 @@ <h3 id="frapi.installing.configuring.nginx.admin.vhost">Setting up FRAPI's Admin
screen with a login and password (Username: <strong>admin</strong>, password:
<strong>password</strong>)</p>

<h3 id="frapi.installing.configuring.nginx.api.vhost">Setting up the <span class="caps">API</span> frontend</h3>
<h4 id="frapi.installing.configuring.nginx.api.vhost">Setting up the <span class="caps">API</span> frontend</h4>

<p>The <span class="caps">API</span> frontend is the <span
class="caps">API</span> that third party developers will be accessing. Very
Expand Down