# ZI-PILER - Installation and Administration Guide
# Installation
Unpack installer archive file \*.tar.gz in /var/tmp/ (as root):
```
mv /root/ZI-Piler-x.x.tar.gz /var/tmp/
cd /var/tmp/
tar xzvf ZI-Piler-x.x.tar.gz
cd /var/tmp/ZI-Piler-x.x
```
Run installation script (as root):
```
perl ZI-Installer --instal-deps
```
At the beginning required perl packages will be installed:
[](https://docs.intalioservices.com/uploads/images/gallery/2020-05/N6Wyd1fM7D7E78uA-screen1.png)
Answer: Y
[](https://docs.intalioservices.com/uploads/images/gallery/2020-05/sQcgBGimobM4R20i-screen2.png)
Press: Y
[](https://docs.intalioservices.com/uploads/images/gallery/2020-05/pdgeFk7I1RRvwH3L-screen3.png)
[](https://docs.intalioservices.com/uploads/images/gallery/2020-05/oVBvAHO0CWTi81U2-screen4.png)
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/WrFnAGveRarC2ljX-restartZimbra.png)
Answer: Y
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/C29Tz8Win7yZatV5-loginpanel.png)
Enter login and password received with the license.
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/a03NMawhnp1OgcTm-selectlicense.png)
Choose your license: 2
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/NeNnw5rAjRmG3yht-extensionLicense.png)
Choose: Y
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/LWmh6LliqXWXYkJD-restartZimbraFinish.png)
Choose: Y
If You answer Y, the zimbra mailbox will be restarted
After the mailbox restart, zimlet shoul be installed. To check it, login into the Panel Admin in Your ZCS Server and see Panel Administrator > Migration and tool > ZI-License. There should be informations about granted licenses.
In case of the **multi server** instalation, zimlet must bu installed on **every mailbox.**
Remeber to restart all mailboxes (as zimbra):
`zmmailboxdctl restart`
# Zimbra configuration
### Requirements
- Piler 1.3.5 or 1.3.8
- Zimbra 8.8.15
- ZI-Piler Zimlet
### Information needed:
- Piler address
- Piler SMTP port
- SSO authorization address
- Authorization server key
- Email account for notifications
### Configuration
To configure ZI-Piler zimlet, open Admin Console > Tools and migration > ZI-Piler
[](https://docs.intalioservices.com/uploads/images/gallery/2020-06/Ew4qsQbFIzsMSCJJ-adminpanel1.png)
#### Communication with piler
- **Piler address** - address of the mail piler server
- **Piler SMTP port** - service piler SMTP port
#### Daemon settings
- **Email account** - email address for notifications
- **Remove notifications older than** - number of days that notifications on "Email account" will be kept
- **Archive trash** - if set, trash will be archived
#### Auto archive settings
- **Start times** - time when auto archive will start on every day
- **Manual start** - When pressed, evokes manual archive
#### Preview and edit user
- **Select user** - selected from list user name to be previewed/edited
- **Settings** - archive settings of the user selected from list "Select user"
#### Preview and edit COS
- **Select COS** - selected from list COS name to be previewed/edited
- **Settings** - archive settings of the COS selected from list "Select COS"
#### SSO Settings
- **Active** - if set, activate SSO
- **SSO authorization address** - address to file [http://piler\_address](http://%7BPiler)/auth-server.php
- **Authorization server key** - the key generated on server-side
- **Protocol to piler connection - **protocol on which ZiPiler will communicate to piler server (http/https)
#### Multiserver installation status
# Piler configuration
#### Piler installed from original sources
Before installing the ZI-Piler must be install Piler server. To do this refer to the [http://ww.mailpiler.org/wiki/current:installation ](http://www.mailpiler.org/wiki/current:installation)
In order to enable Zimbra-Piler SSO functionality some changes must be done on already installed Piler. The following steps have to be followed:
1. Make a copy before the installation
2. Upgrade database
3. Patch Piler files (commonly in /var/www/piler directory)
4. Add ZIMBRA\_INITIALIZE\_URL parameter to config-site.php file
5. Generate server key
6. Zimlet
#### Upgrading database
User 'piler' password is in /usr/local/etc/piler/piler.conf file (mysqlpwd variable)
```
mysql -u piler -p piler < db-mysql-intalioupdate.sql
```
#### Patch piler files
In this example, the piler files are in /var/www/piler directory and Apache user is www-data.
```
patch -p1 -d /var/piler/www < pilerX.X.X.patch
patch -p0 -d /var/piler/www < config.patch
chown www-data:www-data .htaccess
chown www-data:www-data controller/login/remote_login.php
chown www-data:www-data controller/token/auth.php
chown www-data:www-data controller/token/login.php
chown www-data:www-data controller/token/logout.php
chown www-data:www-data gen_server_key.php
chown www-data:www-data index.php
chown www-data:www-data model/token/server_token.php
chown www-data:www-data model/token/user_token.php
chown www-data:www-data model/user/auth.php
chown www-data:www-data system/helper/Security.php
chown www-data:www-data view/theme/default/templates/common/layout-audit.tpl
chown www-data:www-data view/theme/default/templates/login/remote_login.tpl
chown www-data:www-data view/theme/mobile/templates/common/layout-email.tpl
```
#### Adding ZIMBRA\_INITIALIZE\_URL parameter to config-site.php
Edit /usr/local/etc/piler/config-site.php file and add this line. The <ZIMBRA\_HOSTNAME> string change to the hostname of your Zimbra (zimbraPublicHostname parameter).
```
$config['ZIMBRA_INITIALIZE_URL'] = 'https:///service/extension/IntalioZiPilerExt/ZiPilerSSO/?action=login';
```
#### Genereate server key
Call sever key generator and place this key to the ZI-Piler configuration (Zimbra administration console -> Tools and Migration -> ZI-Piler -> SSO Settings -> Authorization server key)
```
cd /var/piler/www/
php gen_server_key.php --webui /var/piler/www
```
# Release Notes
# ZI-Piler 2.0.
##### \[14.03.2023\] Wersja 2.12
#### Nowości
- Całkowita przebudowa mechanizmu archiwizującego wiadomości. Wyłączenie doklejania BCC(UDW) w przypadku gdy użytkownik nie występował w wiadomości oraz zaprzestanie modyfikowania odbiorców w przypadku błędnej struktury.
Od teraz do pilera trafia surowa, niemodyfikowana wersja wiadomości. Tym samym wyłączenie poprawek
z (25.02.2020 - \[Wersja 2.3\]) oraz (\* 18.12.2019 - \[Wersja 2.2\]), bo nie mają już zastosowania.
---
##### \[21.06.2022\] Wersja 2.11
#### Nowości
- Dodanie wsparcia dla JAVA 16.
---
##### \[01.03.2022\] Wersja 2.10
#### Poprawki
- Rozwiązano problem z logowaniem się przez SSO do Pilera, gdy w DisplayName występują PL znaki.
---
##### \[27.07.2021\] Wersja 2.9
#### Nowości
- Dodanie wsparcia dla menu ZI-Modules. Zmienił się troszkę layout przycisku wywołującego ZI-Piler Desktop (pod spodem zmieniony został całkowicie mechanizm renderowania).
---
##### \[29.04.2021\] Wersja 2.8
#### Nowości
- Dodanie automatycznego przenoszenie pliku language.properties do katalogu z extensionem (możliwość modyfikacji
w pliku zi-install-conf.json).
---
##### \[19.02.2021\] Wersja 2.8
#### Nowości/Poprawki
- Dodanie mechanizmu wylogowania użytkownika.
- Poprawiono wsparcie dla zimbry 9 w module pulpitu.
---
##### \[22.01.2021\] Wersja 2.7
#### Nowości
- Wsparcie dla zimbry 9, doszły 2 nowe zimlety:
- zimlet9User
- zimlet9UserIframe
---
#####
\[09.12.2020\] Wersja 2.7
#### Poprawki
- Rozwiązanie błędu "null" występującego podczas automatycznej archiwizacji. Błąd występował wtedy, gdy użytkownik sam sobie nie ustawił ustawień archiwizacyjnych, admin mu nie ustawił i COS też nie miał ustawionych żadnych wartości archiwizacyjnych. Teraz system w takim przypadku wyświetla ostrzeżenie w logu i archiwizuje całą skrzynkę.
#### Nowości
- Dodanie informacji o archiwizowanym użytkowniku podczas każdej akcji wykonywanej przez autoarchiwizację w logu.
Od teraz będzie można jeszcze łatwiej analizować logi użytkownika!
---
##### \[26.10.2020\] Wersja 2.6
#### Nowości
- Dodanie mechanizmu analizującego poprawność adresów email (rozwiązane problemy z illegal address, too long recipient itd.)
- Zmiana informacji o dostępnych tłumaczeniach w logu z info na debug `Available translations`.
---
##### \[01.06.2020\] Wersja 2.5
#### Nowości
- Dodanie nowego pola konfiguracji "Auto archive after (days)", dzięki temu można zdefiniować zakres pobieranych wiadomości (wartość 0 wyłącza ustawienie).
- Zmiana opisu pola w konfiguracji "Komunikacja z pilerem".
#### Poprawki
- Procesy wchodziły w swoje wątki co powodowało sumowanie błędnych/problematycznych/wszystkich wiadomości, każda kolejna archiwizacja pamiętała poprzednią.
---
##### \[02.04.2020\] Wersja 2.4
#### Nowości
- Dodanie weryfikacji portu SSL podczas sprawdzania licencji.
---
##### \[27.03.2020\] Wersja 2.4
#### Nowości
- Dodanie obsługi nowej wersji serwera licencji (>=1.0.6), zmiana sposobu odpytywania o licencje (mniejsze zużycie zasobów).
---
##### \[25.02.2020\] Wersja 2.3
#### Poprawki
- Analiza odbiorców wiadomości pod kątem występowania znaków zakazanych (spacji, znaku nowej linii), przetworzenie odbiorców i oczyszczenie ze znaków specjalnych.
- Zmiana wyświetlania w logu ilości wiadomości do archiwizacji (wcześniej wartość była o 1 mniejsza od poprawnej).
#### Nowości
- Dodanie ID wiadomości w informacji o błędzie wysyłki do pilera
---
##### \[18.12.2019\] Wersja 2.2
#### Nowości
- Obsługa wiadomości z UDW. Teraz jeżeli wiadomość ma pustą listę odbiorców, lub użytkownik archiwizowany nie jest na liście odbiorców. Zostaje dodany do UDW podczas archiwizacji w pilerze.
---
##### \[19.11.2019\] Wersja 2.1
#### Poprawki
- Gdy na liście użytkowników (w panelu administratora), nie było żadnej dostępnej pozycji, pojawiał się błąd JS'owy.
Problem od tej wersji został rozwiązany.
---
##### \[14.11.2019\] Wersja 2.0
#### Nowości
- Zakładka "Pulpit ZI-Piler" jest nieaktywna jeżeli aplikacja piler nie działa (np. została niepoprawnie skonfigurowana).
- Zwracanie błędu 404, gdy proxy nie może odnaleźć żądanego elementu.
- W przypadku dodania nowego cos'a podczas działania serwera, konfiguracja zostanie automatycznie zaktualizowana.
---
##### \[13.11.2019\] Wersja 2.0
#### Nowości
- Inicjowanie domyślnego configu i ustawień dla cos'ow, gdy nie istnieją.
---
##### \[12.11.2019\] Wersja 2.0
#### Nowości
- Dodanie możliwości włączenia/wyłączenia przez administratora archiwizacji wiadomości z kosza użytkownika.
- Dodanie możliwości archiwizacj wiadomości od dzisiaj (0 dni) (Archiwizacja ręczna przez admina).
- Przekierowywanie akcji administratora na mailboxa do którego należy użytkownik.
- Dodanie obsługi logów ZILogs.
- Pobieranie portu komunikacji z konfiguracji zimbry.
- Pobieranie informacji o mbx'ie użytkownika z zimbry.
- Dodanie katalogu ZI-Piler w paczce instalacyjnej.
#### Nowości/Poprawki
- Inicjowanie domyślnej konfiguracji - po instalacji zimletu, bez dotykania opcji, autoarchiwizacja nie działała, bo baza była pusta. Teraz domyślnie podczas instalacji extension sprawdza konfigurację i jeżeli nie istnieje, dodaje domyslną.
- Dodanie obsługi multiserwerowej archiwizacji skrzynki, jeżeli użytkownik któremu skrzynkę chcemy zarchiwizować, jest na innym mailboxie - archiwizacja przebiegnie poprawnie.
#### Poprawki
- Respektowanie ustawienia 0 dni w przypadku autoarchiwizacji (archiwizacja włącznie z dzisiaj).
- Od teraz nie będzie wysyłany do użytkownika email z podsumowaniem, gdy administrator będzie archiwizował skrzynkę ręcznie z poziomu panelu admina.
- Po wejściu na panel administratora przez domenę (nie IP), nie działał widget multiserver, wyświetlał informację o braku instancji, nie synchronizował danych.
---
##### \[10.10.2019\] Wersja 1.5
#### Poprawki
- Dynamiczna podmiana wartości Host, Referer, Origin - potrzebne w instalacjach multiserwerowych. Problem powodował zwracanie błędu 400 przez innego mbx'a na instalacji multiserwerowej.
---
##### \[19.06.2019\] Wersja 1.4
#### Poprawki
- Rozwiązanie błędu nie pozwalającego na archiwizację poczty na zimbrze 8.8.12 Path1 - wiadomości wracały na tę samą skrzynkę
- Rozwiązanie błędu nie pozwalającego na archiwizację poczty na zimbrze 8.8.12 Path1 - wiadomości wracały na tę samą skrzynkę
- Usunięcie przycisku "Archiwizuj ZI-Piler" z ekranu podglądu wiadomości
- Naprawa problemu z pobieraniem masowym - archiwum .zip nie dawało się rozpakować.
#### Nowości
- Dodanie nowego systemu wysyłki smtp
- Dodanie tłumaczenia do zakładki archiwum piler.
---
##### \[04.06.2019\] Wersja 1.3
#### Nowości
- Dodanie pełnej obfuskacji kodu produkcyjnego
---
##### \[23.05.2019\] Wersja 1.2
#### Poprawki
- Zmiana obfuskatora, wyłączenie minifikacji kodu - naprawa buga (?) "AD did not allow authorization : external LDAP auth failed, LDAP error: - unable to get connection: ldap host=: This connection pool has been closed."
---
##### \[16.05.2019\] Wersja 1.2
#### Nowości
- Dodanie nowego pola w panelu admina - Filtr daty, do ustawiania zakresu od kiedy dany użytkownik ma widzieć wiadomości w pilerze.
---
##### \[10.04.2019\] Wersja 1.2
#### Nowości
- Dodanie wsparcia dla zimbry > 8.8.12 (z zachowaniem kompatybilności wstecznej)
---
##### \[09.04.2019\]
#### Poprawki
- Zmiana systemu buildowania paczek
---
##### \[19.03.2019\]
#### Poprawki
- Usunięcie widoczności ikony "Intalio ZI-Piler (Desktop)" w widoku użytkownika.
- Poprawka błędu z problemem licencji podczas uruchamiania z parametrem ?dev.
---
##### \[18.03.2019\]
#### Poprawki
- Przystosowanie do nowej wersji serwera licencji (zmiana ścieżki sprawdzania licencji).
---
##### \[06.03.2019\]
#### Nowości
- Dodanie możliwości manualnej archiwizacji konta użytkownika z poziomu panelu administratora.
- Dodanie wsparcia dla serwera licencji.
---
##### \[07.02.2019\]
#### Poprawki
- Poprawa uruchamiania zimleu podczas inicjalizacji innego zimletu typu ZI
---
##### \[30.01.2019\]
#### Poprawki
- zmiana parametru after:- na before:-
#### Nowości
- proxowanie również katalogów /tmp/, dodanie obsługi nagłówka Accept-Ranges.