Instalační příručka systému InTouch CRM

Naše společnost ANNECA Vám děkuje, že jste se rozhodli používat internetový informační systém InTouch CRM. Jedná o software založený na progresivní technologii Java, využívající ke své práci SQL databázi. Tím je zaručena přenositelnost aplikace na většinu dnes dostupných operačních systémů.

Instalace podpůrného softwaru

InTouch CRM je tzv. vícevrstvý software. To znamená, že ke své činnosti využívá další software, který je nutné nainstalovat ještě před tím, než začnete instalovat vlastní aplikaci. Všechny požadované softwarové balíky jsou k dispozici zdarma na internetu. Zde je přehled toho, co musíte stáhnout:

  • JDK 11 - podpora technologie JAVA
  • MySQL 5.7 - databázový server
  • Apache Tomcat 9 - aplikační server

Instalace Java Platform (JDK)

Instalační balíček najdete na adrese http://www.oracle.com/technetwork/java/javase/downloads/index.html. Na této stránce naleznete několik tlačítek na stažení softwaru. Ten správný je pojmenován "JDK". Stáhněte si tento balíček, spusťte jej a nainstalujte JDK do libovolného adresáře.

Instalace MySQL

Instalační balíček databázového serveru je k dispozici na stránkách http://dev.mysql.com/downloads/mysql. Doporučujeme verzi 5.7 nebo 8.0.

Instalace tohoto SQL serveru je jednoduchá. Buď spustíte instalační program a nebo si necháte rozbalit na svůj disk stažený archiv. Doporučujeme Vám, abyste nechali MySQL spouštět jako službu hned po startu počítače.

Pro budoucí instalaci aplikace InTouch CRM budete potřebovat, aby byla v databázi založena prázdná databáze. Její založení je popsáno v další kapitole.

Adresář, do kterého je instalován SQL server budeme v dalším textu označovat jako [mysql].

Instalace aplikačního serveru Apache Tomcat

Instalační balíček aplikačního serveru je k dispozici na stránkách http://tomcat.apache.org/. Stáhněte si verzi 9.

V případě, že budete instalovat Tomcat na Linuxový server, doporučujeme jeho umístění do adresáře /usr/local/tomcat nebo /opt/tomcat. Pokud máte Windows server, Tomcat se standardně instaluje do adresáře c:\Program Files\Apache Software Foundation\Tomcat x. Nezapomeňte jej naistalovat jako službu. V dalším popisu budeme adresář s instalovaným Tomcatem označovat jako [tomcat].

Pozor, instalátor Tomcatu pro Windows nabízí uživateli při instalaci cestu k JRE (Java Runtime Environment), což je nedostatečná verze Javy pro plnohodnotný běh Tomcatu. Je potřeba ručně vybrat cestu k adresáři s celým JDK.

Důležité: InTouch CRM Enterprise (placená verze) vyžaduje pro svůj běh, aby byl Tomcat nakonfigurován s podporou HTTPS protokolu. Budete tedy potřebovat certifikát na web serveru. Dokumentaci, jak nakonfigurovat SSL/TLS v Tomcatu naleznete zde.

Nová instalace InTouch CRM

Upozornění: pokud provádíte aktualizaci InTouch CRM ze starší verze, přeskočte nyní ve čtení na další podkapitolu.

Produkt InTouch CRM je distribuován v souboru s názvem intouch.war. Při instalaci tohoto souboru postupujte podle následujících kroků:

  1. Ujistěte se, že neběží aplikační server (Tomcat) a pokud je spuštěn tak jej ukončete:
    Linux:
    # cd [tomcat]/bin 
    # ./shutdown.sh
    Windows:
    otevřete ovládací panel Služby a zastavte službu „Apache Tomcat“
  2. Ujistěte se, že je spuštěn databázový server MySQL. Pokud ne, spusťe jej. Nyní je třeba založit novou prázdnou databázi pomocí následujících příkazů:
    Windows i Linux:
    # cd [mysql]/bin
    # mysql -u root
    > CREATE SCHEMA intouch DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_czech_ci;
    > grant all privileges on intouch.* to UZIVATEL identified
    by 'HESLO';
    > exit
    Poznámka: [mysql] je název adresáře, ve kterém je instalován databázový server, údaje UZIVATEL a HESLO nahraďte jménem uživatele a jeho heslem, pod kterým se bude InTouch CRM přihlašovat do databáze. Tyto údaje budete potřebovat později.
  3. Do adresáře [tomcat]/webapps nakopírujte soubor intouch.war
  4. Spusťte aplikační server Tomcat
  5. Nyní se zkuste připojit k aplikačnímu serveru pomocí webového prohlížeče na adrese:
    https://<server>:<port>/intouch
    Údaje <server> a <port> jsou název stroje, na kterém běží Tomcat a http port, na kterém Tomcat čeká na spojení. Při instalaci Tomcatu je nabízen port 8080 (http) a 8443 (https). Můžete jej však změnit na 80 resp. 443, který je standardním portem a nemusí se pak v adrese uvádět.
  6. Pokud vše proběhlo správně, měl by vám prohlížeč zobrazit úvodní stránku pro konfiguraci InTouch CRM, která obsahuje volbu jazyka pro instalaci. Pro dokončení instalace postupujte podle pokynů v prohlížeči.
  7. Pozor: v další fázi instalace začne InTouch CRM vytvářet kompletní strukturu databáze. Tento proces může trvat i přes 5 minut a veškeré prováděné příkazy jsou vypisovány do logu. Pokud možno, nerestartujte Tomcat, dokud tvorba databáze neskončí.
  8. Na závěr se znovu připojte na adresu https://<server>:<port>/intouch. Mělo by se objevit přihlašovací okno pro vstup do InTouch CRM. Uveďte přihlašovací údaje, které jste specifikovali v rámci konfigurace InTouch CRM.

Aktualizace InTouch CRM

Při aktualizaci produktu InTouch CRM postupujte podle níže uvedených kroků.

  1. Pokud jste tak ještě neučinili, stáhněte si nejnovější verzi souboru intouch.war. Pokud používáte verzi InTouch CRM Start, můžete tak učinit kdykoliv. Jestliže používáte placenou verzi Profi nebo Enterprise, musíte mít aktivní službu technické podpory.
  2. Ujistěte se, že neběží aplikační server (Tomcat) a pokud je spuštěn tak jej ukončete:
    Linux:
    # cd [tomcat]/bin
    # ./shutdown.sh
    Windows:
    otevřete ovládací panel Služby a zastavte službu „Apache Tomcat“
  3. Důrazně doporučujeme udělat zálohu stávajícího stavu databáze a e-mailů pro případ, že by se aktualizace z nějakého důvodu nezdařila (např. výpadek proudu):
    1. Záloha databáze (Linux i Windows):
      # cd [mysql]/bin
      # ./mysqldump -u root -R intouch > [cesta]/[soubor]
    2. Záloha mailů (Linux i Windows): Při instalaci jste byli tázáni na cestu k složkám pro fulltext, e-maily a ostatní data. Nyní zkopírujte obsah složky pro ukládání mailů do adresáře [cesta].
    Poznámka: [cesta] je umístění libovolného adresáře do kterého budete zálohu ukládat, [soubor] je libovolný název souboru, který bude automaticky vytvořen.
  4. Záloha aplikace InTouch CRM:
    Linux i Windows:
    Z adresáře [tomcat]/webapps zkopírujte adresář intouch do adresáře [cesta]. Nyní odstraňte adresář [tomcat]/webaps/intouch a soubory [tomcat]/webaps/intouch.war, [tomcat]/webaps/intouch.install.data.
    Poznámka: Tento krok je nezbytně nutný pro aktualizaci InTouch CRM a proto jej nelze vynechat.
  5. Umístění nové verze InTouch CRM:
    Linux i Windows:
    Zkopírujte nový intouch.war do adresáře [tomcat]/webapps.
  6. Nyní spusťte aplikační server Tomcat:
    Linux:
    # cd [tomcat]/bin
    # ./startup.sh
    Windows:
    otevřete ovládací panel Služby a spusťte službu „Apache Tomcat“
  7. Nyní se zkuste připojit k aplikačnímu serveru pomocí webového prohlížeče na adresu:
    https://<server>:<port>/intouch
    Údaje <server> a <port> jsou název stroje, na kterém běží Tomcat a http port, na kterém Tomcat čeká na spojení. Při instalaci Tomcatu je nabízen port 8080 (http) a 8443 (https). Můžete jej však změnit na 80 resp. 443, který je standardním portem a nemusí se pak v adrese uvádět.
  8. Pokud vše proběhlo správně, měl by vám prohlížeč zobrazit úvodní stránku pro aktualizaci InTouch CRM, která obsahuje volbu jazyka. Pro dokončení aktualizace postupujte podle pokynů v prohlížeči. Cesta k předchozí verzi aplikace je [cesta]/intouch, kam jste provedi zálohu.
  9. Po dokončení průvodce v prohlížeči je třeba restartovat (tj. ukončit a následně spustit) aplikační server Tomcat.
  10. Na závěr se znovu připojte na adresu http://<server>:<port>/intouch. Mělo by se objevit přihlašovací okno pro vstup do InTouch CRM.

Další nastavení po skončení instalace

Pokud chcete InTouch CRM používat pro reálný provoz a neinstalujete jej pouze za účelem vyzkoušení, bude vás nejspíš zajímat několik dalších otázek. Následuje jejich přehled:

Paměť pro běh aplikačního serveru

Těsně po instalaci je aplikační server Tomcat spouštěn se standardním množstvím dostupné paměti, cca 64 MB. Pokud aplikace dosáhne této hranice, začne hlásit chybu OutOfMemoryError (nedostatek paměti). Děje se tak i přesto, že server má fyzicky třeba 2 GB RAM.

Na operačním systému typu UNIX nadefinujte proměnnou s názvem CATALINA_OPTS, která bude mít hodnotu -Xmx512m. Tento údaj znamená, že Tomcat může pro své potřeby použít až 512 MB paměti RAM. To by mělo pro běžnou instalaci InTouch CRM stačit.

CATALINA_OPTS=-Xmx512m

Jestliže používáte Windows, je nastavení tohoto parametru složitější. Tomcat, který běží jako NT služba očekává tento údaj v registrech operačního systému. Navíc je tento údaj umístěn pro různé verze Tomcatu na jiném místě.

Naštěstí je spolu s Tomcatem dodáván skript s názvem service.bat, který instaluje Tomcat jako službu. Parametry tohoto skriptu je možné velikost paměti určit. Doporučujeme přečíst návod k instalaci aplikačního serveru Tomcat.

Přístup k InTouch CRM přes HTTPS

Tomcat má po instalaci vypnutou podporu protokolu HTTPS, a proto je nutné upravit jeho konfigurační soubory, pokud chcete k InTouch CRM přistupovat v bezpečnějším režimu.

V souboru [tomcat]/conf/server.xml najdete v poznámkách postup jak aktivovat HTTPS protokol. Po úpravě konfigurace je nutné Tomcat restartovat.

InTouch CRM a firewall

Pokud již máte na serveru nainstalovaný InTouch CRM, měli byste pro přístup na tento server povolit porty 80 (HTTP) a 443 (HTTPS). Aby mohl InTouch CRM stahovat a odesílat poštu (obsahuje vestavěného e-mailového klienta), bude nutné povolit i přenos pro porty 110 (POP3), 143 (IMAP) a 25 (SMTP).