Difference between revisions of "GOCDB/Regional Module Technical Documentation"

From EGIWiki
Jump to: navigation, search
(Download)
Line 1: Line 1:
{{Template:Op menubar}}
+
{{Template:Op menubar}} {{Template:GOCDB_menubar}} {{TOC_top}} This page is the main install documentation for GOCDB  
{{Template:GOCDB_menubar}}
+
 
{{TOC_top}}
 
[[Category:GOCDB]]
 
This page is the main install documentation for GOCDB  
 
[[Category:GOCDB]]
 
 
== Download  ==
 
== Download  ==
  
'''LATEST VERSION: GOCDBv5'''  
+
'''LATEST VERSION: GOCDBv5''' <br>  
<br/>
+
 
* Install docs for V5 comming soon.  
+
*Install docs for V5 comming soon.  
* A packaged V5 release will also be made available for download soon.  
+
*A packaged V5 release will also be made available for download soon.  
* In the meantime, early adopters can check out the v5 src from svn:  
+
*In the meantime, early adopters can check out the v5 src from svn:
<pre>
+
<pre>svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/Doctrine%20Web%20Portal  
svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/Doctrine%20Web%20Portal  
+
</pre>  
</pre>
+
Note, if you are asked to authenticate with a client certificate as below, you can dismiss by pressing Enter  
Note, if you are asked to authenticate with a client certificate as below, you can dismiss by pressing Enter
+
<pre>Authentication realm: https://www.sysadmin.hep.ac.uk:443
<pre>
+
Client certificate filename: &lt;ENTER to dismiss&gt;
Authentication realm: https://www.sysadmin.hep.ac.uk:443
+
</pre>
Client certificate filename: <ENTER to dismiss>
+
<br> '''OLD v4.4 Install doc has been relocated''' <br>
</pre>
+
 
 +
*https://wiki.egi.eu/wiki/GOCDB/v4/Regional_Module_Technical_Documentation
 +
 
 +
<!---
 +
 
 +
== Deployment  ==
 +
 
 +
=== System prerequisites  ===
 +
 
 +
GOCDB-5 regional module has two components: a database and a web front end. Both components can work on the same machine but it is very likely that in most environments they will be separated. This is what we would advise anyway. Machine requirements for these 2 components are described below.
 +
 
 +
==== Database  ====
 +
 
 +
*'''Mysql/Oracle/Sqlite'''
 +
 
 +
<br>
 +
 
 +
==== Web frontend  ====
 +
 
 +
The machine to use as the web frontend will need the following:
 +
 
 +
*'''Apache http server'''&nbsp;version 2.2 or higher.
 +
*'''PHP'''&nbsp;version 5.3 or higher (version &lt;=5.2 has some OOP related bugs).
 +
**'''PHP'''&nbsp;oci8 extension<br>  
 +
*<span style="line-height: 1.5em;">a X509 host certificate for the machine</span>
 +
 
 +
<br>
 +
 
 +
==== Optional  ====
 +
 
 +
*'''PHP Unit''' for testing developments
 +
 
 +
<br>
 +
 
 +
== Preparing your installation  ==
 +
 
 +
=== Database preparation  ===
 +
 
 +
=== PEAR  ===
 +
 
 +
==== Installing PEAR  ====
 +
 
 +
Pear is recommended to install Doctrine and PHPUnit, many builds of PHP come pre-bundled with PEAR.&nbsp;
 +
 
 +
[http://pear.php.net/manual/en/installation.getting.php http://pear.php.net/manual/en/installation.getting.php]
 +
 
 +
Verify the PEAR installation by running pear version on the command line.
 +
<pre>$ pear version
 +
PEAR Version: 1.9.4
 +
PHP Version: 5.3.8
 +
Zend Engine Version: 2.3.0
 +
Running on: Windows NT ESCPC0095 6.1 build 7601 (Windows 7 Business Edition Service Pack 1) i586
 +
</pre>
 +
=== Doctrine  ===
 +
 
 +
Doctrine can be installed using PEAR. First add the Doctrine and Symfony channels to PEAR:
 +
<pre>$pear channel-discover pear.doctrine-project.org
 +
$pear channel-discover pear.symfony.com
 +
</pre>
 +
Then install Doctrine and it's dependencies:
 +
<pre>$pear install --alldeps doctrine/DoctrineORM
 +
</pre>
 +
Verify the Doctrine installation by running "doctrine --version" on the command line:
 +
<pre>$ doctrine --version
 +
Doctrine Command Line Interface version 2.3.3
 +
</pre>
 +
<span style="line-height: 1.5em;">See the possible errors and troubleshooting section if you encounter errors at this point.</span>
 +
 
 +
=== Apache  ===
 +
 
 +
A few modules need to be enabled for GOCDB to work, check these are enabled on your Apache and if not enable them.&nbsp;
 +
 
 +
In httpd.conf enable ssl_module by un-commenting these lines:
 +
<pre>LoadModule ssl_module modules/mod_ssl.so</pre>
 +
and
 +
<pre>extension=php_openssl.dll</pre>
 +
Depending on the database you are using the supporting module may also need to be enabled. For example Oracle requires:
 +
<pre>extension=php_oci8_11g.dll</pre>
 +
<br>  
  
 +
=== PHPUnit - Optional  ===
  
'''OLD v4.4 Install doc has been relocated'''
+
GOCDB5 includes a test suite of unit tests that can be used to verify buisness logic and database connections for an instance of GOCDB. In addition developers extending and modifying GOCDB can write unit tests for their own developements. To install PHPUnit use PEAR:
<br/>
+
<pre>$pear clear-cache
* https://wiki.egi.eu/wiki/GOCDB/v4/Regional_Module_Technical_Documentation
+
$pear config-set auto_discover 1
 +
$pear install pear.phpunit.de/PHPUnit
 +
</pre>  
 +
This install can then be verified using "phpunit --version" on the command line:  
 +
<pre>$ phpunit --version
 +
PHPUnit 3.7.27 by Sebastian Bergmann.
 +
</pre>
 +
[[Category:GOCDB]]-->

Revision as of 19:16, 5 November 2013

Main EGI.eu operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security


GOC DB menu: Home Documentation Index


Contents

This page is the main install documentation for GOCDB 

Download

LATEST VERSION: GOCDBv5

  • Install docs for V5 comming soon.
  • A packaged V5 release will also be made available for download soon.
  • In the meantime, early adopters can check out the v5 src from svn:
svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/Doctrine%20Web%20Portal 

Note, if you are asked to authenticate with a client certificate as below, you can dismiss by pressing Enter

Authentication realm: https://www.sysadmin.hep.ac.uk:443
Client certificate filename: <ENTER to dismiss>


OLD v4.4 Install doc has been relocated