ASWI - Pokročilé softwarové inženýrství » ASWI 2020 » Indexace a fulltextové vyhledávání v historických obrazových dokumentech (KIV) - ANONYMOUS

h1. Příručka pro nasazení

Aplikace je rozdělena do třech základních částí FE (Angular), BE (Spring) a Solr. Každá část je spustitelná v dockeru jako container.

Potřebný software:

* Docker

* Docker composer

h2. Automatické spuštění pomocí skriptu

Aplikaci je možno spustit spustit jedni skriptem. Postup pro spuštění:

* stáhnout root adresář z gitu bez adresářů fe a be

* přesunout se do složky root projektu 'aswi2020anonymous' (zde by měl být soubor docker-compose.yml)

* spustit skript pro automatické spuštění

** pro windows run.bat

** pro linux run.sh (sudo sh run.sh)

* skript provede následující kroky

** zastaví všechny běžící kontejnery

** smaže všechny existující image

** (pro linux nastaví práva na adresář solr)

** stáhne image z docker hubu

** nastaruje všechny potřebné image

** pokusí se smazat existující jádra (files a documents)

** vytvoření nových jader files a documents

** skript na konci vypíše hlášku APP STARTED ON localhost:4200

* následně již by aplikace měla běžet na localhostu na portu 4200 (frontend)

* aplikaci je možné spustit jedním skriptem, který je přiložen k projektu

** pro operační systém windows skript run.bat

** pro operační systém linux skript run.sh

* po spuštění skritpu dojde k následujícím krokům

** smazání všech předchozích image v dockeru

** stažení potřebných image z docker hubu

** zastavení všech běžících kontejnerů

** nastartování potřebných kontejnerů

** vytvoření jader(dosuments, files) pro solr

* skript na konci vypíše hlášku APP STARTED ON localhost:4200

* následně již by aplikace měla běžet na localhostu na portu 4200

h2. Získání docker image

Pro získání jednotlivých docker image aplikace máme dva následující způsoby:

# Lokální build aplikace

* stáhnout veškeré kódů z Gitu 

* přesunout se do složky root projektu 'aswi2020anonymous' (zde by měl být soubor docker-compose.yml)

* spustit příkaz 'docker-compose build'

* v dockeru proběhne build aplikace a následné vytvoření docker image pro každou část aplikace (fe, be)

# Stáhnutí existujících docker image

* stáhnout root adresář z gitu bez adresářů fe a be

* spustit příkaz 'docker-compose pull'

* existující image poslední verze se stáhnou z docker hubu

h2. Spuštění aplikace

* před spustěním zkontrolujeme

** zda máme všechny image aplikace příkazem 'docker image ls'

** zda máme ve složce, kde voláme příkazy, soubor docker-compose.yml a adresář solr s konfigurací Solru

* spustit aplikace lze příkazem 'docker compose up''

* webová aplikace nastartuje na portu 80

** port webové aplikace lze upravit v souboru docker-compose.yml