omowne / Periphraser

Instrukcja przeznaczona jest dla systemu operacyjnego Ubuntu.

Zainstaluj easy_install:
>> sudo apt-get install python-setuptools

Zainstaluj pipa:
>> sudo apt-get update
>> sudo apt-get -y install python-pip

Zainstaluj bibliotekę jsonpickle:
>> sudo easy_install jsonpickle

Zainstaluj bibliotekę thrift:
>> sudo easy_install thrift

Pobierz z repozytorium Multiserwisu plik multiservice-0.1-py2.7.egg dostępny pod adresem http://git.nlp.ipipan.waw.pl/multiservice/clients/blob/master/python/multiservice-0.1-py2.7.egg i zainstaluj go:
>> sudo easy_install multiservice-0.1-py2.7.egg

Zainstaluj Django w wersji 1.4.11+:
>> sudo pip install Django==1.4.11

Zainstaluj Django south:
>> sudo apt-get install python-django-south

Zainstaluj Django REST framework w wersji 2.4.8:
>> sudo pip install djangorestframework==2.4.8

Zainstaluj Django extensions:
>> sudo apt-get install python-django-extensions

Zainstaluj Django registration w wersji 0.8:
>> sudo pip install django-registration==0.8

Zainstaluj django-datatables-view:
>> sudo pip install django-datatables-view

Zainstaluj pythonowy moduł lxml:
>> sudo apt-get install python-lxml

Zainstaluj pythonowy moduł natsort:
>> sudo apt-get install python-natsort

Zainstaluj Postgresa:
>> sudo apt-get update
>> sudo apt-get install postgresql postgresql-contrib
Zmień użytkownika na postgres:
>> sudo -i -u postgres
A następnie dodaj poszczególne role do postgresa komendą:
>> createuser --interactive
Stwórz pustą bazę danych dla Periphrasera:
>> createdb periphraser -E UTF8 -T template0 -l pl_PL.utf8
Jeśli locale pl_PL.utf8 nie istnieje dodatkowo należy uruchomić komendy:
>> sudo locale-gen pl_PL.utf8
>> sudo service postgresql restart
Załaduj dump bazy danych poleceniem (zrzut bazy umieszczony jest w archiwum INSTALL_PACK.zip):
>> psql periphraser < obraz_bazy.db

Zainstaluj gita:
>> sudo apt-get install git

** DODATKOWE OPCJE:
    * Jeśli chcesz korzystać z weryfikacji korpusowej potrzebny będzie obraz korpusu NKJP w wersji nkjp1800x (x = extended) w formacie poliqarp i zainstalowany program Poliqarp 1.3. Obraz korpusu z racji praw autorskich nie może być udostępniany z niniejszym programem. Dodatkowe informacje na temat programu Poliqarp można znaleźć na stronie (http://clip.ipipan.waw.pl/Poliqarp).
    * Jeśli chcesz korzystać z weryfikacji za pomocą wyszukiwarki DuckDuckGo potrzebny będzie program ddgr dostępny pod adresem https://github.com/jarun/ddgr.

Sklonuj repozytorium gitowe z GitLaba:
>> git clone http://git.nlp.ipipan.waw.pl/omowne/Periphraser.git

Dodaj w głównym folderze projektu plik konfiguracyjny settings.py (plik umieszczony jest w archiwum INSTALL_PACK.zip):
	Zmień w nim zmienną STATIC_ROOT, tak by wskazywała na położenie plików statycznych strony, np.:
		STATIC_ROOT = "/.../static/Periphraser"

	Jeśli chcesz korzystać z weryfikacji korpusowej i zainstalowałeś odpowiednie komponenty, ustaw wartość pola NKJP_VALIDATION na True.

Dodaj w głównym folderze projektu plik konfiguracyjny database_data.py (plik umieszczony jest w archiwum INSTALL_PACK.zip) oraz zdefiniuj w nim połączenie z bazą danych, np.:
	DATABASES = {
	    'default': {
		'ENGINE': 'django.db.backends.postgresql_psycopg2',
		'NAME': 'db_name',
		'USER': 'user_name',
		'PASSWORD': '',
		'HOST': '',
		'PORT': '5432',
	    }
	}

Zainstaluj moduł psycopg2:
>> sudo apt-get install python-psycopg2

Zainstaluj Morfeusza2 zgodnie z instrukcjami na stronie http://sgjp.pl/morfeusz/dopobrania.html.

Zgraj pliki statyczne do dedykowanego katalogu poleceniem:
>> python manage.py collectstatic

Zainstaluj Apacha:
>> sudo apt-get install apache2

Zainstaluj mod-wsgi:
>> sudo apt-get install libapache2-mod-wsgi

Utwórz plik periphraser.wsgi odpowiednio definiując w nim ścieżki do plików statycznych. Przykładowa treść pliku poniżej:
--------------------------------------------
import os, sys

sys.path.append('/home/zil/Periphraser')
sys.path.append('/home/zil')
os.environ['DJANGO_SETTINGS_MODULE'] = 'Periphraser.settings'

import django.core.handlers.wsgi

application = django.core.handlers.wsgi.WSGIHandler()
--------------------------------------------

Skonfiguruj apacha dodając plik konfiguracyjny (np. o nazwie periphraser.conf) do folderu sites-available apacha (domyślnie /etc/apache2/sites-available/), ścieżka WSGIScriptAlias musi wskazywać na plik periphraser.wsgi. Przykładowy plik konfiguracyjny poniżej:
--------------------------------------------
<VirtualHost *:80>
    ServerAdmin name@gmail.com
    ServerName periphraser.nlp.ipipan.waw.pl

    ServerAlias periphraser.ipipan.waw.pl

    DocumentRoot /.../Periphraser/templates/
    <Directory />
      Options FollowSymLinks
      AllowOverride None
      Require all granted
    </Directory>
    WSGIScriptAlias / /.../scripts/periphraser.wsgi
    WSGIDaemonProcess Periphraser user=zil group=zil processes=2 threads=15
    WSGIProcessGroup Periphraser
    Alias /static/ /.../static/Periphraser/
    <Directory "/.../static/Periphraser">
        Require all granted
    </Directory>

    ErrorLog /.../logs/Periphraser/error.log
    CustomLog /.../logs/Periphraser/access.log combined
</VirtualHost>
--------------------------------------------

Uruchom stronę poleceniem:
>> sudo a2ensite periphraser.conf

Zrestartuj apacha:
>> sudo service apache2 restart

Aby uruchomić mechanizm automatycznego wykrywania potencjalnych błędów należy kolejno uruchomić w głównym folderze Periphrasera komendy:
>> python manage.py add_statuses
>> python manage.py mark_potential_errors