Goal

This procedure describes the steps required to extract, configure, and deploy code for running UQAM's Vivo-i18n in Canadian-French

Sommaire

Prerequisite

To carry out this procedure, the following steps must have been carried out

1) Starting with basic installation: Java-Maven-Solr-GIT

2) Installing MySQL for Vivo-i18n

3) Installing Tomcat 8.5 for Vivo-1.11.0-i18n

Procedure

1- Configuring the code's host environment and extract it

StepAction

1) Creating the GIT directory

sudo -i -u tomcat 
mkdir /opt/tomcat/GIT
cd /opt/tomcat/GIT

2) Retrieving the code

M1 - Milestone 1

The M1 Tag corresponds to the reference version of the code released by UQAM for the Vivo i18n community.

Without the '--branch M1' option, the clone is a checkout of the latest version in the container.

git clone https://bitbucket.org/uqam/vivo-uqam-i18n --branch M1

3) Extraction analysis

Two directories are under 'vivo-uqam-i18n'.

vivo-project-i18n: contains the vivo code itself.

vivo-project-i18n-config: contains the files needed to configure vivo

2- Configuring SOLR for Vivo

StepAction

1) Pepare Solr

sudo systemctl stop solr

2) Copy configuration files

 sudo -u solr cp -r /opt/tomcat/GIT/vivo-uqam-i18n/vivo-project-i18n-config/solr/server/* /opt/solr/server/ 

3) Check vivocore in Solr

sudo systemctl start solr
http://YOUR_URL:8983/solr/#/vivocore_i18n/core-overview

2- Preparing VIVO for first start

StepAction

1) Create VIVO home

sudo -u tomcat mkdir -p /opt/tomcat/vivo_i18n/home
sudo -u tomcat cp -r /opt/tomcat/GIT/vivo-uqam-i18n/vivo-project-i18n-config/vivo_i18n/home/* /opt/tomcat/vivo_i18n/home/

2) Edit runtime.properties file

Make sure that attribute properties fit with current installation


sudo -u tomcat vi /opt/tomcat/vivo_i18n/home/config/runtime.properties
runtime.properties
Vitro.defaultNamespace = http://<adresse-ip-du-serveur>:8080/vivo/individual/
...

rootUser.emailAddress = vivo_i18n@uqam.ca
...

VitroConnection.DataSource.url = jdbc:mysql://localhost/vivo_i18n
VitroConnection.DataSource.username = vivo_i18n
VitroConnection.DataSource.password = VIVO_I18N_MYSQL_PASSWORD
...

vitro.local.solr.url = http://<server-ip-adress>:8983/solr/vivocore_i18n
...
RDFService.languageFilter = true
languages.selectableLocales = fr_CA, en_US, de_DE

3) Edit and configure VIVO installation setting file 


Check that the file contains the following code:

sudo -u tomcat cp example_settings_i18n_linux.xml settings_i18n_linux.xml
sudo -u tomcat vi settings_i18n_linux.xml
settings_i18n_uqam.xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.1.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd">
        <profiles>
                <profile>
                        <id>defaults</id>
                        <properties>
                                <app-name>vivo_i18n</app-name>
                                <vivo-dir>/opt/tomcat/vivo_i18n/home</vivo-dir>
                                <tomcat-dir>/opt/tomcat</tomcat-dir>
                                <default-theme>wilma</default-theme>
                        </properties>
                </profile>
        </profiles>
        <activeProfiles>
                <activeProfile>defaults</activeProfile>
        </activeProfiles>
</settings>

3- Compiling code

StepAction

1) get into the proper directory

cd /opt/tomcat/GIT/vivo-uqam-i18n/vivo-project-i18n

2) Compile

First compile might take a while: lot of files to download and process

sudo -u tomcat /opt/apache-maven-3.6.3/bin/mvn -s ./vivo-installer-i18n/settings_i18n_linux.xml install

3) Validate

Compile process should result in the following message:

[INFO] 
[INFO] --- maven-dependency-plugin:3.1.1:unpack (install) @ vivo-installer-webapp-i18n ---
[INFO] Configured Artifact: org.vivoweb:vivo-installer-webapp-i18n:1.11.0-SNAPSHOT:war
[INFO] Unpacking /opt/tomcat/GIT/vivo-uqam-i18n/vivo-project-i18n/vivo-installer-i18n/webapp-i18n/target/vivo.war to /opt/tomcat/webapps/vivo with includes "" and excludes ""
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for VIVO Project for i18n 1.11.0-SNAPSHOT:
[INFO] 
[INFO] VIVO Languages Canadian French ..................... SUCCESS [  1.957 s]
[INFO] VIVO Languages Canadian French for Home ............ SUCCESS [  3.621 s]
[INFO] VIVO Languages Canadian French for Web Ap .......... SUCCESS [  8.434 s]
[INFO] Vitro Languages Canadian French .................... SUCCESS [  0.003 s]
[INFO] Vitro Languages Canadian French for Web App ........ SUCCESS [  1.702 s]
[INFO] VIVO Project for i18n .............................. SUCCESS [  0.879 s]
[INFO] Vitro API - for i18n ............................... SUCCESS [ 39.580 s]
[INFO] VIVO api for i18n .................................. SUCCESS [  7.767 s]
[INFO] VIVO installer for i18n ............................ SUCCESS [  0.004 s]
[INFO] VIVO Install Home for i18n ......................... SUCCESS [ 37.261 s]
[INFO] Vitro Web App for i18n ............................. SUCCESS [  4.192 s]
[INFO] VIVO Web App for i18n .............................. SUCCESS [  7.361 s]
[INFO] VIVO Web App Installer for i18n .................... SUCCESS [  7.937 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  02:11 min
[INFO] Finished at: 2019-11-27T23:43:06Z
[INFO] ------------------------------------------------------------------------

4- Accessing Vivo

StepAction

1) Restart tomcat

sudo systemctl restart tomcat

2) First access to VIVO from browser

On first web access after compile VIVO présents this page:

Click ot this link to get to the VIVO's start page

5- Final validation

To perform a final check, please refer to the Verify Your Installation section of the VIVO's documentation available on Lyrasis wiki.

  • No labels