Difference between revisions of "Main Page"

From GGBN Portal Software
Jump to: navigation, search
m (Configuration)
m (Configuration)
Line 30: Line 30:
  
 
*Check that the Apache User has writing/editing rights in the whole "my_portal" folder.
 
*Check that the Apache User has writing/editing rights in the whole "my_portal" folder.
*Edit the file "my_portal/frontend/config/main.php".
+
#Edit the file "my_portal/frontend/config/main.php".
**Configure the portal URL: <code>$baseUrl = str_replace ( '/SUBDIR_AFTER_YOUR_WEB_FOLDER/my_portal/frontend/web', '/ggbn_portal', (new Request ())->getBaseUrl () );</code>
+
*Configure the portal URL: <code>$baseUrl = str_replace ( '/SUBDIR_AFTER_YOUR_WEB_FOLDER/my_portal/frontend/web', '/ggbn_portal', (new Request ())->getBaseUrl () );</code>
**Configure the MySQL database credentials <code>  
+
*Configure the MySQL database credentials <code>  
 
                                                 'db' => [
 
                                                 'db' => [
 
                                                 'class' => '\yii\db\Connection',
 
                                                 'class' => '\yii\db\Connection',
Line 40: Line 40:
 
                                                 'charset' => 'utf8'  
 
                                                 'charset' => 'utf8'  
 
                                 ],</code>
 
                                 ],</code>
*Edit the file "my_portal/frontend/config/params.php".
+
#Edit the file "my_portal/frontend/config/params.php".
**e-mails
+
*e-mails
***Configure the admin e-mail <code>'adminEmail' => 'ADMIN@DOMAIN',</code>. The admin will get error/bug messages.
+
**Configure the admin e-mail <code>'adminEmail' => 'ADMIN@DOMAIN',</code>. The admin will get error/bug messages.
***Configure the support e-mail(s) <code>'supportEmail' => ['MAIL1','MAIL2'..],</code>.  
+
**Configure the support e-mail(s) <code>'supportEmail' => ['MAIL1','MAIL2'..],</code>.  
***Configure the feedback e-mail(s) <code>'feedbackMail' => ['MAIL1','MAIL2'..],</code>. They will get the messages sent with the feedback function.
+
**Configure the feedback e-mail(s) <code>'feedbackMail' => ['MAIL1','MAIL2'..],</code>. They will get the messages sent with the feedback function.
***Configure the no-reply-mail (who is supposed to sent e-mail(s) to the users) <code>'noreplyMail'=>'MAIL'
+
**Configure the no-reply-mail (who is supposed to sent e-mail(s) to the users) <code>'noreplyMail'=>'MAIL'
**Configure the location of the DarwinCore Archives (harvested with B-HIT) <code>'dwcArchivesPath' => 'PATH_TO_THE_PARENT_FOLDER' ,</code>. Check the access rights! (read is enough)
+
*Configure the location of the DarwinCore Archives (harvested with B-HIT) <code>'dwcArchivesPath' => 'PATH_TO_THE_PARENT_FOLDER' ,</code>. Check the access rights! (read is enough)
**Configure the location(root) of your SOLR instance <code>'solrhost'=> 'SOLR_HOST'</code> and the SOLR core names  
+
*Configure the location(root) of your SOLR instance <code>'solrhost'=> 'SOLR_HOST'</code> and the SOLR core names  
 
<code>
 
<code>
 
                                                 $searchname="SEARCH_CORE";
 
                                                 $searchname="SEARCH_CORE";
Line 53: Line 53:
 
                                                 $detailsname="DETAILS_CORE";
 
                                                 $detailsname="DETAILS_CORE";
 
</code>
 
</code>
**Set the temporary folder <code>'tmpFolder'=>'TEMP_FOLDER'</code>. Check the access rights! (write is needed)
+
*Set the temporary folder <code>'tmpFolder'=>'TEMP_FOLDER'</code>. Check the access rights! (write is needed)

Revision as of 17:35, 11 January 2016

Welcome to the Wiki of the GGBN Portal Software

Further information about the software will follow soon.


Presentation

TBD

Workflow

TBD

Installation

You will need

  • Apache (tested with Apache/2.4.7 (Ubuntu), Apache/2.2.22 (Debian), Apache/2.4.10 (Win64)) with libapache2-mod-php5
  • PHP5 (tested with 5.5.9, 5.5.30 and 5.5.15). You also might need to install php5-xsl, php5-gd and php5-mysql.
  • a SOLR instance (tested with Apache SOLR 4.9.0). Contact us for getting the appropriate SOLR configuration files.
  • a MySQL database (tested with MySQL 5.5.46). It will contain data harvested thanks to B-HIT

Yii (version 2) will be fully contained in the subversion code of the portal software.

Copy a working version from the svn

Create a destination folder, for the rest of this documentation we will choose "my_portal" in your web-folder (ie. /var/www/, or *WINPATH*).
Get http://ww2.biocase.org/svn/dnabank/Dnabank_Portal/ggbn_portal/trunk/ into "my_portal".

Configuration

TBD yii, Apache, rights, SOLR (SOLR config files also & Java)
First, let say we want to access the portal under the URL http://localhost/ggbn_portal.

  • Check that the Apache User has writing/editing rights in the whole "my_portal" folder.
  1. Edit the file "my_portal/frontend/config/main.php".
  • Configure the portal URL: $baseUrl = str_replace ( '/SUBDIR_AFTER_YOUR_WEB_FOLDER/my_portal/frontend/web', '/ggbn_portal', (new Request ())->getBaseUrl () );
  • Configure the MySQL database credentials
                                               'db' => [
                                               'class' => '\yii\db\Connection',
                                               'dsn' => 'mysql:host=IP;dbname=DBNAME',
                                               'username' => 'USER',
                                               'password' => 'PASS',
                                               'charset' => 'utf8' 
                               ],
  1. Edit the file "my_portal/frontend/config/params.php".
  • e-mails
    • Configure the admin e-mail 'adminEmail' => 'ADMIN@DOMAIN',. The admin will get error/bug messages.
    • Configure the support e-mail(s) 'supportEmail' => ['MAIL1','MAIL2'..],.
    • Configure the feedback e-mail(s) 'feedbackMail' => ['MAIL1','MAIL2'..],. They will get the messages sent with the feedback function.
    • Configure the no-reply-mail (who is supposed to sent e-mail(s) to the users) 'noreplyMail'=>'MAIL'
  • Configure the location of the DarwinCore Archives (harvested with B-HIT) <code>'dwcArchivesPath' => 'PATH_TO_THE_PARENT_FOLDER' ,. Check the access rights! (read is enough)
  • Configure the location(root) of your SOLR instance 'solrhost'=> 'SOLR_HOST' and the SOLR core names

                                               $searchname="SEARCH_CORE";
                                               $previewname="PREVIEW_CORE";
                                               $detailsname="DETAILS_CORE";

  • Set the temporary folder 'tmpFolder'=>'TEMP_FOLDER'. Check the access rights! (write is needed)