# Wymagania

Do poprawnego uruchomienia modułu 'e-muzeum' potrzebne są:
* Liferay Portal CE (7.1.3-ga4) - [download](https://sourceforge.net/projects/lportal/files/Liferay%20Portal/7.1.3%20GA4/liferay-ce-portal-tomcat-7.1.3-ga4-20190508171117552.7z/download)

Sam Liferay nie wymaga nic więcej, ale do uruchomienia produkcyjnego (zewnętrzna baza danych, zewnętrzne wyszukiwanie) potrzeba:

* PostgreSQL (10.8)
* Elasticsearch 6.x - Liferay w wersji 7.x korzysta z klienta elasticsearch 6.5.0. Ostatnią kompatybilną wersją z tym klientem jest Elasticsearch 6.8.0. - [download](https://www.elastic.co/downloads/past-releases/elasticsearch-6-8-0)

# Uruchomienie i konfiguracja

*Wersja **MVP***: Liferay + PostgreSQL

*Wersja **BETA***: Liferay + PostgreSQL

*Wersja **RTM***: Liferay + PostgreSQL + ElasticSearch


## Liferay produkcja

1. Należy pobrać wszystkie paczki zawarte w sekcji `Wymagania`

2. Należy przez komende scp scp -r /<ścieżka liferay-portal> <login>@<ip_prod>:/opt skopiować folder pobranego liferaya na serwer produkcyjny

3. Stworzyć dowiązanie do skopiowanego pliku na serwerze (ln -s liferay-portal-7.1.3-ga4 liferay)

4. Utworzyć tymczasowy pusty folder o dowolnej nazwie (np. emuseum) (np. na serwerze preprod pod ścieżką /home/<user>/emuseum)

5. Pobrać repozytorium e-museum naszych modułów (git clone aktualnie branch 432_emuseum_comments)

6. Folder e-museum naszych modułów należy wysłać analogicznie względem punktu 2, lecz najlepiej do ścieżki naszego użytkownika (scp -r /<ścieżka_do_emusuem> <login>@<ip_prod>:/home/<user>)

7. Po pobraniu przechodzimy do folderu z e-museum/install(z punktu 4.) i uruchamiamy plik `env.sh` i zmieniamy następujące atrybuty:

a) `path=<ścieżka do folderu tymczasowego, punkt 3>`

b) `liferay=<ścieżka do folderu zainstalowanego liferaya, "liferay-portal-7.1.3-ga4", punkt 2>` (

8. Następnie konfigurujemy pliki zawarte w e-museum/configs/prod/ (punkt 5) o nazwie `portal-setup-wizard.properties` oraz `portal-ext.properties`

a)
- W pliku `portal-ext-properties` ustawiamy dane bazy danych utworzonej w PostgreSQL:

## PostgreSQL

##
## Database
##
jdbc.default.driverClassName=org.postgresql.Driver
jdbc.default.password=<password>
jdbc.default.url=jdbc:postgresql://localhost:5432/<database_name>
jdbc.default.username=<username>

gdzie <password> to hasło użytkownika postgreSQL (defaultowo postgres), <database_name> to nazwa bazy danych, a <username> to użytkownik postgreSQL (defaultowo postgres)

- liferay.home=<liferay_home>

gdzie <liferay_home> to ścieżka do pobranego wcześniej liferaya (liferay-portal-7.1.3-ga4)


b) W pliku `portal-setup-wizard.properties` mamy możliwość ustawienia loginu i hasła podstawowego admina dostępnego od początku po stacie servera (nie jest to wymagane, zaleca się nie konfiguroawnia tego pliku)

Po konfiguracji oba pliki należy przenieść do folderu liferaya !! (./opt/liferay-portal-7.1.3-ga4)

9. Przechodzimy do ścieżki e-museum/install/ oraz uruchamiamy komendę w teminalu

```
sh install.sh 1 0 0
```

Co zbuduje wszystkie moduły dostępne e-człowiek

10. W tej samej ścieżce uruchamiamy komendę

```
sh install.sh 0 0 1
```

Co przekopiuje nam potrzebne pliki konfiguracyjne do liferay-portal-7.1.3-ga4/configs

11. Konfigurujemy Elasticsearch

##Elasticsearch

Należy ustawić parametr `cluster.name` w pliku konfiguracyjnym elasticsearcha `elasticsearch.yml` w wcześniej pobranym folderze `elasticsearch/config`.

```
    cluster.name: emuseum
```

Taką samą nazwę należy ustawić (*najlepiej przed wgraniem konfiguracji na serwer*) w pliku konfiguracyjnym `com.liferay.portal.search.elasticsearch6.configuration.ElasticsearchConfiguration.config` ('<moduł-e-muzeum>/osgi/configs/...').

Dodatkowo należy doinstalować zestaw pluginów do elasticsearcha, w celu umożliwienia indeksacji języków innych niż angielski (czyt. polski).

```
    $ cd <ścieżka_do_elasticsearch>/bin
    $ ./elasticsearch-plugin install analysis-icu
    $ ./elasticsearch-plugin install analysis-kuromoji
    $ ./elasticsearch-plugin install analysis-smartcn
    $ ./elasticsearch-plugin install analysis-stempel
```

Uruchomić Elasticsearch:

```
    $ cd <ścieżka_do_elasticsearch>/bin
    $ ./elasticsearch
```
UWAGA!!!
Jeśli przy starcie serwera wyrzuca nieznany błąd należy usunąć plik `com.liferay.portal.search.elasticsearch6.configuration.ElasticsearchConfiguration.config` ('<moduł-e-muzeum>/osgi/configs/...'), zresetować serwer oraz skonfigurować elasticsearcha ponownie od pierwszego punktu. Jest możliwe uruchomenie strony bez elasticsearcha, lecz należy koniecznie usunąć wspomniany plik.

Ewentualna reindeksacja danych na portalu:

* Control Panel -> Configuration -> Search -> Reindex all search indexes. -> Execute

12. Następnie przechodzimy do ścieżki `/liferay-portal-7.1.3-ga4/tomcat-9.0.17/bin` i w terminalu uruchamiamy komendę:

Gdy chcemy uruchomić serwer
```
./startup.sh
```
Gdy chcemy wyłączyć serwer
```
./shutdown.sh
```

Na serwerze prod i preprod

Start serwera

```
systemctl start liferay
```
Restart serwera
```
systemctl restart liferay
```
Stop serwera
```
systemctl stop liferay
```

13. Następnie przechodzimy do ścieżki z wcześniej używanym skryptem instalacyjnym `e-museum/install` i uruchamiamy ostatni krok instalacji modułów

```
sh install.sh 0 1 0
```



#Wskazówki

1. W przypadku posiadania bazy nic nie ruszać. Ewentualnie jeżeli potrzebna jest czysta instalacja wykonać skrypt 'deleteDatabase.sql'.

2. **Przed pierwszym uruchomieniem** koniecznie wgrać pliki `portal-setup-wizard.properties` oraz `portal-ext.properties` (z katalogu ./configs) do głównego katalogu serwera. Pliki te wymagają edycji danych takich jak dostęp do bazy danych, ścieżka do serwera oraz ewentualnie zmiana danych głównego konta administratora.

3. W przypadku kolejnej instalacji wykonać tylko ostatnio krok instalacji (7. Wgrywanie modułów).

4. Następnie wykorzystując plik `configs.txt` (z katalogu ./install) wgrać pliki konfiguracyjne do katalogu '<liferay>/osgi/configs'.

    ```
        $ sh install.sh 0 0 1
    ```

5. W przypadku zmiany konfiguracji wgrać nowe pliki konfiguracji (4. Wgrywanie konfiguracji) i zrestartować serwer.