Skip to content
This repository has been archived by the owner on Dec 14, 2021. It is now read-only.

Latest commit

 

History

History
262 lines (188 loc) · 7.71 KB

INSTALL.md

File metadata and controls

262 lines (188 loc) · 7.71 KB

Installing VIPA

This guide will explain how you can install VIPA on an Ubuntu server.

NOTICE: Some steps takes longer time than others. So you may want to make some changes on your computer before connecting to the server over SSH for avoiding 'Broken pipe' situation. If you lost the connection between your computer and server (over SSH), you can't follow some steps' procesing status.

Before start

This script requires a domain name while creating cookies so if you run this project under a pseudo domain (instead of a real one like .com) you should modify your computer's host file in order to connect your server instead of IP adress. It's not a complicated step, feel free to visit Google and use search box.

Required Software

Install and run these services and extensions before attempting to install VIPA.

  • Nginx
  • PostgreSQL
  • Memcached
  • PHP7
  • Elasticsearch
  • Node
  • Bower
# Java

$ sudo add-apt-repository -y ppa:webupd8team/java
$ sudo apt-get update 
$ sudo apt-get -y install oracle-java8-installer


# Elastic

$ wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
$ echo "deb http://packages.elastic.co/elasticsearch/1.7/debian stable main" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-1.7.list
$ sudo apt-get update
$ sudo apt-get -y install elasticsearch

$ sudo update-rc.d elasticsearch defaults 95 10
$ sudo service elasticsearch restart

# Install PostgreSQL and Git
$ sudo apt-get install -y postgresql git

# Add php7 repo and update

$ LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php -y
$ apt-get update

# Install PHP and its extensions

$ apt-get install -y --force-yes php7.0-cli php7.0-dev \
php-pgsql php-sqlite3 php-gd php-apcu php7.0-curl php7.0-mcrypt \
php-imap php7.0-gd php-memcached php7.0-pgsql php7.0-readline \
php-xdebug php-mbstring php7.0-xml php7.0-zip php7.0-intl php7.0-bcmath

# Install Composer

$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/bin/composer

# Add Composer executable to PATH if you're using Vagrant

$ printf "\nPATH=\"$(composer config -g home 2>/dev/null)/vendor/bin:\$PATH\"\n" | tee -a /home/vagrant/.profile

# Configure PHP CLI

$ sudo sed -i "s/error_reporting = .*/error_reporting = E_ALL/" /etc/php/7.0/cli/php.ini
$ sudo sed -i "s/display_errors = .*/display_errors = On/" /etc/php/7.0/cli/php.ini
$ sudo sed -i "s/memory_limit = .*/memory_limit = 512M/" /etc/php/7.0/cli/php.ini
$ sudo sed -i "s/;date.timezone.*/date.timezone = UTC/" /etc/php/7.0/cli/php.ini

# Install Nginx & PHP-FPM

$ apt-get install -y --force-yes nginx php7.0-fpm

# If you don't have any websites which using files below
$ rm /etc/nginx/sites-enabled/default
$ rm /etc/nginx/sites-available/default
$ service nginx restart

# Configure PHP-FPM

$ sed -i "s/error_reporting = .*/error_reporting = E_ALL/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/display_errors = .*/display_errors = On/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/;cgi.fix_pathinfo=1/cgi.fix_pathinfo=0/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/memory_limit = .*/memory_limit = 512M/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/upload_max_filesize = .*/upload_max_filesize = 100M/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/post_max_size = .*/post_max_size = 100M/" /etc/php/7.0/fpm/php.ini
$ sed -i "s/;date.timezone.*/date.timezone = UTC/" /etc/php/7.0/fpm/php.ini

$ service nginx restart
$ service php7.0-fpm restart

# PostgreSQL database and user setup
$ su - postgres
$ psql -d template1 -U postgres

CREATE USER vipa WITH PASSWORD 'vipa';
CREATE DATABASE vipa;
GRANT ALL PRIVILEGES ON DATABASE vipa to vipa;
\q

$ su
$ cd $OLDPWD

# Node & Bower
$ sudo apt-get -y install nodejs nodejs-legacy
$ sudo apt-get -y install npm
$ sudo npm install -g bower

Getting most recent version

# Create the directory and set permissions
$ sudo mkdir -p /var/www
$ sudo chown -R www-data:www-data /var/www

# Switch to www-data user

$ sudo su -s /bin/bash www-data
$ cd /var/www

# Remove default nginx index.php page if you don't have any website in there
$ rm -rf html

# Obtain the latest code

$ git clone https://github.com/academic/vipa.git
$ cd vipa

Installing Dependencies

While installing some depenencies, Composer will ask for a GitHub access token. You don't have to proivde one, as it will try to download from the source but you will need to press ENTER each time it tries. If you want to provide, see GitHub's help article.

When installation is complete, you will need to provide some parameters to VIPA. Some of those are:

  • Database parameters: Use the one you have created before installing dependencies. Type them carefully as you might have to re-run this wizard if anything goes wrong.
  • database_driver (pdo_pgsql by default)
  • database_host (127.0.0.1 by default)
  • database_port (5432 by default)
  • database_name (vipa by default)
  • database_user (vipa by default)
  • database_password (vipa by default)
  • base_host: Treat this as your domain name. If you want to use a virtualhost, make sure you pass its name here.
$ composer update -vvv -o
$ bower update
$ php app/console assets:install web --symlink
$ php app/console assetic:dump
$ php app/console doctrine:schema:drop --force
$ php app/console doctrine:schema:create
$ php app/console vipa:install
$ php app/console vipa:install:samples

After the wizard is done, install the initial data if you would like: $ php app/console vipa:install:initial-data

Web Server Configuration Examples

/etc/nginx/sites-available/vipa

# Type this command (or change type your favourite text editor instead of 'nano') and paste the server example section
$ sudo nano /etc/nginx/sites-available/vipa

Server example

server {
    listen 80;
    server_name vipa.prod www.vipa.prod local.vipa.prod *.vipa.prod;
    client_max_body_size 1024M;

    root /var/www/vipa/web;

    rewrite ^/app.php?(.*)$ /$1 permanent;

    try_files $uri @rewriteapp;
    location @rewriteapp {
        rewrite ^(.*)$ /app.php/$1 last;
    }
    
    location ~ ^/(app|config)\.php(/|$) {
        fastcgi_pass            127.0.0.1:9000;
        fastcgi_buffer_size     16k;
        fastcgi_buffers         4 16k;
        fastcgi_split_path_info ^(.+\.php)(/.*)$;
        include                 fastcgi_params;
        fastcgi_param           SCRIPT_FILENAME     $document_root$fastcgi_script_name;
        fastcgi_param           HTTPS               off;
    }
}

server {
    listen 80;
    server_name vipa.dev www.vipa.dev local.vipa.dev *.vipa.dev;
    client_max_body_size 1024M;

    root /var/www/vipa/web;

    rewrite ^/app_dev.php?(.*)$ /$1 permanent;

    try_files $uri @rewriteapp;

    location @rewriteapp {
        rewrite ^(.*)$ /app_dev.php/$1 last;
    }

    location ~ ^/(app|app_dev|app_local|config)\.php(/|$) {
        fastcgi_pass            127.0.0.1:9000;
        fastcgi_buffer_size     16k;
        fastcgi_buffers         4 16k;
        fastcgi_split_path_info ^(.+\.php)(/.*)$;
        include                 fastcgi_params;
        fastcgi_param           SCRIPT_FILENAME     $document_root$fastcgi_script_name;
        fastcgi_param           HTTPS               off;
    }
}

Restart nginx service

$ service nginx restart

Install Bundles

You should run this command in vipa folder, if you're not sure, run this before:

$ cd /var/www/vipa

Then

# Citation bundle

$ app/console vipa:install:package citation

Troubleshooting

If anything goes wrong (ie. you get a blank page instead of VIPA home) check logs under app/log directory and Nginx's own log file.