Instrukcja instalacji i wstępnej konfiguracji oprogramowania
Informacje o dokumencie
Data dokumentu: 02-2014
Autor: Kamil Gromadzki (RETEK) Wersja dokumentu: 1.1
Wersja systemu: 1.1
Spis treści
I. Wprowadzenie ... 3
1. Wstęp ... 3
2. Zawartość płyty ... 3
II. Instalacja oprogramowania... 4
1. Wstęp ... 4
2. Instalacja Javy ... 4
3. Baza danych ... 6
3.1. Instalacja ... 6
3.2. Połączenie do PostgreSQLa oraz tworzenie użytkownika i bazy danych...10
4. Serwer ...14
4.1. Instalacja serwera Tomcat ...14
4.2. Konfiguracja i optymalizacja serwera ...17
III. Wdrożenie oprogramowania SERWISANT ...19
1. Wstęp ...19
2. Przygotowanie konfiguracji dla SERWISANT’a ...19
2.1. Konfiguracja skrzynki pocztowej ...20
2.2. Ustawienie adresu IP serwera ...20
2.3. Konfiguracja bazy danych ...21
2.4. Pozostała konfiguracja ...22
3. Wdrożenie SERWISANT’a ...22
4. Pierwsze uruchomienie ...23
IV. Materiały dodatkowe ...25
1. Instalacja i konfiguracja TeamView’a ...25
I. Wprowadzenie
1. Wstęp
Niniejsza instrukcja przedstawia, jak krok po kroku przygotować środowisko uruchomieniowe oraz jak prawidłowo wdrożyć oprogramowanie SERWISANT w systemie operacyjnym Windows 7. Wszystkie kroki należy wykonywać w kolejności w jakiej zostały opisane.
Proces instalacji oprogramowania SERWISANT składa się z kilku kroków:
1. Instalacja wymaganych programów tworzących środowisko uruchomieniowe, w skład których wchodzą:
a. JAVA: Java Development Kit w wersji 1.7,
b. Baza danych:RDBMS PostgreSQL (zalecana wersja: 9.2), c. Serwer: Tomcat 7.0.
2. Konfiguracja oraz wdrożenie serwisanta.
Wszystkie wymienione programy znajdują się na dołączonej płycie. Proces ich instalacji oraz konfiguracji został opisany krok po kroku w niniejszej instrukcji.
Użytkowniku pamiętaj: W przypadku problemów skontaktuj się z nami.
Zainstalujemy wymagana oprogramowanie zdalnie i przygotujemy do pracy.
2. Zawartość płyty
Płyta zawiera wszystkie programy oraz pliki konfiguracyjne potrzebne do prawidłowej pracy oprogramowania Serwisant.
Zawartość płyty:
1. JAVA
o jdk-7u51-windows-i586 (32bity).exe o jdk-7u51-windows-x64 (64bity).exe
2. BAZA DANYCH
o postgresql-9.2.6-3-windows-x64 (64bity).exe o postgresql-9.3.2-3-windows (32bity).exe
o skrypt - tworzenie uzytkownika i bazy danych.sql
3. SERWER
o apache-tomcat-7.0.50.exe
4. SERWISANT o serwisant.war
o serwisantConfig.groovy o serwisant-raporty.zip
5. MATERIAŁY DODATKOWE
o TeamViewer_Setup_pl (wersja 9).exe
Retek Serwisant - Podrecznik użytkownika.pdf
II. Instalacja oprogramowania
1. Wstęp
Przed rozpoczęciem instalacji poszczególnych programów upewnij się, że konto na którym jesteś zalogowany w systemie Windows ma prawa administratora.
Przed rozpoczęciem instalacji warto również poznać typ systemu Windows: 32bitowy czy 64bitowy. Informacje o typie systemu będą potrzebne w przypadku instalacji poszczególnych programów dołączonych do płyty.
Aby sprawdzić typ systemu należy:
1. Przejść na pulpit,
2. Kliknąć prawym klawiszem myszki „Mój komputer”,
3. Z wyświetlonego menu kontekstowego wybrać „Właściwości”
2. Instalacja Javy
Kroki:
1. Włóż płytę instalacyjną,
2. Przejdź do katalogu: „1. JAVA” znajdującego się na płycie,
3. Kliknij dwukrotnie na odpowiednią wersję pliku (w zależności od posiadanego typu systemu operacyjnego):
a. jdk-7u51-windows-i586 (32bity).exe – typ systemu: 32 bity, b. jdk-7u51-windows-x64 (64bity).exe – typ systemu: 64 bity 4. Zostanie uruchomiony kreator użytkownika. Kliknij „Next >”.
5. W kolejnym oknie zmień lokalizację miejsca docelowego. Zaleca się wybór
lokalizacji: C:\SERWISANT\JAVA\JDK7. W ty celu kliknij przycisk „Change…” i zmień lokalizację. Klikamy „Next ->”.
6. W kolejnym oknie zostanie wyświetlony wybór miejsca instalacji JRE. Postępujemy analogicznie do punktu 5, wybierając lokalizację: C:\SERWISANT\JAVA\JRE7.
Klikamy „Next ->”.
7. W kolejnym oknie klikamy „Close”.
8. Java została zainstalowana.
3. Baza danych
3.1. Instalacja
Serwisant wykorzystuje do zapisywania danych relacyjną system bazodanowym PostgreSQL. Zaleca się instalację PostgreSQL w wersji 9.2 lub nowszej.
Kroki:
1. Włóż płytę instalacyjną,
2. Przejdź do katalogu: „2. BAZA DANYCH” znajdującego się na płycie,
3. Kliknij dwukrotnie na odpowiednią wersję pliku (w zależności od posiadanego systemu operacyjnego):
a. postgresql-9.3.2-3-windows (32bity).exe – typ systemu: 32 bity, b. postgresql-9.2.6-3-windows-x64 (64bity).exe – typ systemu: 64 bity 4. Zostanie uruchomiony kreator użytkownika. Kliknij „Next >”.
5. W oknie „Installation Directory”, zmień lokalizację na: C:\SERWISANT\BAZA DANYCH\POSGRESQL9. Klinij „Next >”
UWAGA: Nie zaleca się instalowanie PostgreSQL w katalogu „C:\Program Files” lub innym katalogu systemowym. Użytkownik można mieć później problem z uruchomieniem PostgreSQL jako usługi w systemie Windows.
6. W kolejnym oknie „Data Directory” pozostaw lokalizację bez zmian. Domyślnie powinna wskazywać: C:\SERWISANT\BAZA DANYCH\POSGRESQL9\data.
Kliknij „Next >”
7. Wpisz hasło w polu „Password” i powtórz je w polu „Retype password”. Hasło dotyczy użytkownika bazy danych, który jest superużytkownikiem (login:
posgres). Superużytkownik posiada pełne uprawnienia do bazy danych.
Na potrzeby instrukcji podano hasło: posgres. Kliknij „Next >”
8. Pole port domyślnie wskazuje wartość: 5432. Pole pozostaw bez zmian. Kliknij
„Next >”.
9. W oknie „Advanced Options”, w polu „Locale” należy wybrać „Polish, Poland” i kliknąć „Next >”
10. W kolejnym oknie „Ready to Install”, kliknij „Next >”. Po tej czynności kreator rozpocznie instalację PosgreSQL.
11. Po ukończeniu instalacji zostanie zaprezentowane okno „Completing the
PostgreSQL Setup Wizard”. W oknie należy odznaczyć pole „Stack Builder may be used …” i kliknąć „Finish”.
12. PostgreSQL został pomyślnie zainstalowany i uruchomiony w systemie Windows, jako usługa (pracuje w tle i jest uruchamiana przy każdym starcie systemu).
bazy danych
Wraz z PostgreSQL zostało zainstalowane narzędzie pgAdmin III, które ułatwia administrowanie bazami danych, umożliwia m.in. tworzenie i przywracanie kopii bezpieczeństwa.
W przypadku SERWISANTA będzie przydatny do stworzenia użytkownika do bazy danych oraz samej bazy danych, z której będzie korzystać SERWISANT.
Kroki :
1. Kliknij „Start”, w polu wyszukiwania wpisz: „pgAdmin” i wybierz „pgAdmin III”
2. W oknie głównym pgAdmina III kliknij przycisk „Zdefiniuj połączenie do serwera”
3. Uruchomi się nowe okno „Rejestracja Nowego Serwera”. Należy uzupełnić poszczególne pola i kliknąć „OK”.
Uzupełnianie pól:
Nazwa: „serwer SERWISANT”
Host: 127.0.0.1
Port: 5432 (podany podczas instalacji PostgreSQL)
Serwisowa DB: postgres
Użytkownik: postgres
Hasło: postgres (podawane podczas instalacji PostgreSQL)
Zaznaczyć „Pamiętać hasło”
4. W oknie głównym, w lewym panelu „Okno obiektów” należy kolejno rozwinąć drzewo. Szczegóły na poniższym zrzucie.
5. Mając zaznaczoną bazę postgres został odblokowany przycisk SQL w menu głównym. Należy na niego kliknąć. Uruchomi się nowe okno „Query”. W którym
systemu SERWISANT.
6. W oknie „Query” wybierz z menu głównego: „Plik -> Otwórz..” i wskaż plik znajdujący się na płycie instalacyjnej w lokalizacji:
2. BAZA DANYCH\skrypt - tworzenie uzytkownika i bazy danych.sql”
7. Po załadowaniu pliku (zrzut ekranu punkt 6) wciśnij przycisk F6. PostgreSQL utworzy użytkownika „serwisant” z hasłem dostępu „serwisant.123” oraz bazę danych „serwisant_prod”. Możesz zamknąć okno „Query”.
8. Użytkownik oraz baza danych została utworzona. Aby zobaczyć bazę danych przejdź do okna głównego pgAdmina.
9. W lewym panelu „Okno obiektów” zaznacz „Bazy danych(2)” i kliknij F5 (drzewo zostanie odświeżone i zostanie zaprezentowana czysta baza danych do obsługi SERWISANT’a: serwisant_prod. Możesz zamknąć „pgAdmina”.
Podsumowując, w punkcie został utworzony nowy użytkownik oraz baza danych:
IP serwera: 127.0.0.1
port: 5432
baza danych: serwisant_prod użytkownik: serwisant hasło: serwisant.123
Powyższe dane będą potrzebne w punkcie: „III. Wdrożenie oprogramowania SERWISANT” do modyfikacji pliku z konfiguracją dla SERWISANT’a
4. Serwer
SERWISANT działa w technologii klient-serwer. Co oznacza, że oprogramowanie instalowane jest tylko na jednym komputerze, a do pracy wykorzystywana jest wyłącznie przeglądarka internetowa (klient). W tym punkcie zajmiemy się instalacją serwera na którym w późniejszych punktach zostanie zainstalowany SERWISANT.
4.1. Instalacja serwera Tomcat
Kroki:
1. Włóż płytę instalacyjną,
2. Przejdź do katalogu: 3. SERWER znajdującego się na płycie, 3. Uruchom plik: apache-tomcat-7.0.50.exe”
W przypadku pojawienie się poniższego komunikatu należy kliknąć „Uruchom”.
4. Zostanie uruchomiony kreator, kliknij „Next >”, 5. Zaakceptuj warunki licencji klikając „I Agree”,
6. W kolejnym oknie „Choose Components” pola pozostawiamy bez zmian, klikamy
„Next >”
7. W Oknie „Configuration”, uzupełniamy pola według poniższych wskazówek:
Server Shutdown Port: 8005
HTTP/1.1 Connector Port: 8080
AJP/1.3 Connector Port:8009
Windows Service Name: Tomcat7Serwisant
User Name: admin
Password: serwisant.123 (przykładowe hasło)
Roles: admin-gui,manager-gui,manager Po uzupełnieniu pól kliknij „Next >”
8. W oknie „Java Virtual machine” powinna widnieć lokalizacja:
C:\SERWISANT\JAVA\JRE7, klikamy „Next>”
9. W oknie „Choose Install Location”, zmieniamy „Destination Folder” na:
C:\SERWISANT\SERWER\Tomcat7. Klikamy „Install”
10. W oknie „Completing the Apache Tomcat Setup Wizard”, zostawiamy zaznaczone pole „Run Apache Tomcat”. Odznaczamy natomiast pole „Show Readme”. Klikamy
„Finish”.
11. Serwer zostanie uruchomiony podobnie jak PostgreSQL, jako usługa systemu Windows i będzie uruchamiany manualnie przez użytkownika (aby przełączyć tryb uruchamianie serwisu postępuj zgodnie ze wskazówkami w punkcie poniżej:
„Konfiguracja i optymalizacja serwera”).
W zasobniku systemowym (obok zegara) wyświetli się nowa ikona, która informuje o tym, że serwer Tomcat działa i jest dostępny.
4.2. Konfiguracja i optymalizacja serwera
W celu optymalnej pracy serwera, zaleca się wykonanie kilku czynności.
Kroki:
1. Kliknij podwójnie na ikonkę Tomcat’a w zasobniku systemowy.
2. W nowym oknie, zakładka: „General” ustaw „Startup type: „Automatic”, dzięki czemu serwer będzie uruchamiał się po każdym restarcie systemu Windows.
Kliknij „Zastosuj”
3. Przejdź do zakładki „Java”.
a. W sekcji „Java Options” dopisz parametr: -XX:MaxPermSize=1024m b. Pole „Initial memory pool”: 1024
c. Pole „Maximum memory pool”: 2048
Aby się upewnić czy serwer jest gotowy do pracy, uruchom przeglądarkę internetową i wpisz adres: http://127.0.0.1:8080/. Przeglądarka powinna wyświetlić stronę:
III. Wdrożenie oprogramowania SERWISANT
1. Wstęp
Warunkiem prawidłowego przejścia wszystkich kroków opisanych w punkcie III jest wcześniejsza instalacja oprogramowania stanowiącego środowisko uruchomieniowe SERWISANTA tj. programów:
1. JAVA: Java Development Kit w wersji 1.7,
2. Baza danych:RDBMS PostgreSQL (zalecana wersja: 9.2), 3. Serwer: Tomcat 7.0.
Sposób instalacji poszczególnych programów opisano we wcześniejszych rozdziałach.
2. Przygotowanie konfiguracji dla SERWISANT’a
KROKI:
1. Włóż płytę instalacyjną,
2. przejdź do katalogu: 4. SERWISANT,
3. Skopiuj plik serwisantConfig.groovy do katalogu:
C:\SERWISANT\SERWER\Tomcat7\lib
4. Otwórz skopiowany plik serwisantConfig.groovy w dowolnym edytorze tekstowym (np. notatniku)
5. W celu modyfikacji postępuj według poniższych punktów 6. Zapisz zmiany w pliku.
Informacje o pliku serwisantConfig.groovy
Plik zawiera wstępną konfigurację dla programu SERWISANT. Składa się z 4 sekcji, które zostaną omówione poniżej:
1. Konfiguracja skrzynki pocztowej 2. Ustawienie adresu IP serwera 3. Konfiguracja bazy danych 4. Pozostała konfiguracja
Sekcja w domyślnie pliku za komentowana. Domyślnie SERWISANT korzysta ze skrzynki mailowej: serwisant@retek.pl do informowania mailowego użytkowników o powiadomieniach w systemie.
/* ustwic w przypadku gdy administratora aplikacji chce wysyłać powiadomienia z SERWISANTa
* z definiowanej własnej skrzynki mailowej * *
grails { mail {
host = "smtp.gmail.com"
port = 465
username = "wpisz_login_do_skrzynki@gmail.com"
password = "haslo_do_skrzynki_mailowej"
props = ["mail.smtp.auth":"true", "mail.smtp.socketFactory.port":"465",
"mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory", "mail.smtp.socketFactory.fallback":"false"]
} }
grails.mail.default.from="wpisz_login_do_skrzynki@gmail.com"
*/
Aby wprowadzić swoje ustawienia należy od komentować sekcję (w tym celu usuń znaki /* * / z powyższej sekcji) i zmienić zawartość według wytycznych. Poniżej przykład konfiguracji skrzynki mailowej gmail: serwisant@gmail.com
grails { mail {
host = "smtp.gmail.com"
port = 465
username = "serwisant@gmail.com"
password = "TajneHasło"
props = ["mail.smtp.auth":"true", "mail.smtp.socketFactory.port":"465",
"mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory", "mail.smtp.socketFactory.fallback":"false"]
} }
grails.mail.default.from="serwisant@gmail.com"
2.2. Ustawienie adresu IP serwera
Aby zainstalowany serwer Tomcat wraz z aplikacją SERWISANT był dostępny dla innych użytkowników Twojej sieci należy zdefiniować adres IP pod jakim będzie
widoczny.
W przypadku, gdy użytkownik zamierza korzystać z SERWISANTA tylko na komputerze, który jest serwerem można pominąć ten punkt.
environments { production {
grails.serverURL = "http://127.0.0.1:8080/serwisant"
} }
Przed zmianą adresu IP upewnij się, że nie jest on nadawany dynamicznie przez router!.
Aby sprawdzić aktualny IP komputera serwera należy wykonać kroki:
1. Kliknij kombinacje klawiszy WIN + R lub kliknij „Start -> Uruchom…”.
2. Windows wyświetli nowe okienko w którym należy wpisać cmd
3. W konsoli wpisz: ipconfig i kliknij klawisz Enter
4. Z powyższego okno wynika, że system na którym zainstalowano serwer posiada zdefiniowane IP: 10.0.9.43. Zatem poprawny wpis definiujący serwer powinien wyglądać następująco:
environments { production {
grails.serverURL = "http://10.0.9.43:8080serwisant"
} }
2.3. Konfiguracja bazy danych
W punkcie 3.2. Połączenie do PostgreSQLa oraz tworzenie użytkownika i bazy danych został stworzony użytkownik oraz baza danych do obsługi systemu SERWISANT.
O następujących atrybutach:
IP serwera: 127.0.0.1
port: 5432
baza danych: serwisant_prod użytkownik: serwisant hasło: serwisant.123
nazwy lub zmienić hasło. Jeśli tak się zdarzyło, należy zmodyfikować poniższą sekcję:
dataSource {
pooled = true
username = "serwisant"
password = "serwisant.123"
url = "jdbc:postgresql://127.0.0.1:5432/serwisant_prod"
}
2.4. Pozostała konfiguracja
System SERWISANT umożliwia odzyskiwanie hasła dla użytkownika. Domyślnie opcja jest wyłączona. Aby ją włączyć należy zmodyfikować poniższy fragment kodu:
serwisant { modul {
bezpieczenstwo {
odzyskiwanieHasla=false }
} }
Ustawienia:
true - w widoku logowania zostanie zaprezentowany link z możliwością odzyskania hasła przez użytkownika,
false – wyłączenie możliwości odzyskiwania hasła. Wówczas hasło dla użytkownika może zmienić wyłącznie administrator systemu.
3. Wdrożenie SERWISANT’a
Kroki:
1. Włóż płytę instalacyjną,
2. przejdź do katalogu: 4. SERWISANT, 3. Skopiuj plik „serwisant.war” do katalogu:
C:\SERWISANT\SERWER\Tomcat7\webapps
4. Skopiowany plik: serwisant.war powinien zostać automatycznie rozpakowany do katalogu: „Serwisant”. Jeśli tak się nie dzieje, należy zrestartować serwer.
5. Aby zrestartować serwer: W zasobniku systemowym (obok zegara) wyświetla się ikona Tomcata, która informuje o tym, że serwer Tomcat działa i jest dostępny.
6. Kliknij na ikonę podwójnie lewym klawiszem myszki, 7. System wyświetli okno:
8. Kliknij przycisk „Stop”, serwer zostanie wyłączony.
9. Kliknij przycisk „Start”, serwer zostanie ponownie włączony, (restart został wykonany)
10. Kliknij „Ok”,
11. Po restarcie w katalogu: C:\SERWISANT\SERWER\Tomcat7\webapps, powinien pojawić się katalog Serwisant.
12. Serwisant został wdrożony.
UWAGA: Restart serwera należy wykonywać również w przypadku, gdy dokonasz modyfikacji pliku serwisantConfig.groovy w przeciwnym wypadku zmiany nie zostaną uwzględnione.
4. Pierwsze uruchomienie
Kroki:
1. Uruchom przeglądarkę internetową (ze względu na wysoki poziom
bezpieczeństwa, zachęcamy do korzystania z przeglądarki firmy google: Chrome)
IP komputera zdefiniowany w punkcie 2.2. Ustawienie adresu IP serwera.
Dla zdefiniowanego przykładu:
http://10.0.9.43:8080/serwisant lub http://127.0.0.1:8080/serwisant
3. Przeglądarka uruchomi okno logowania do systemu:
4. W oknie logowania wpisz w poszczególne pola poniższe dane i kliknij „Zaloguj”
a. Login: admin@app.com b. Hasło: admin123
5. System jest gotowy do pracy.
IV. Materiały dodatkowe
1. Instalacja i konfiguracja TeamView’a
TeamViewer jest programem, który pozwala w przeciągu niewielu sekund nawiązać połączenie internetowe z dowolnym komputerem osobistym lub serwerem i zdalnie nim sterować tak, jakbyś tuż przed nim siedział. (http://www.teamviewer.com/pl/)
Na dołączonej płycie znajduje się program instalacyjny TeamViewer. Zainstaluj TeamViewer na komputerze na którym ma być wdrożony SERWISANT i przekaż nam Twój ID wygenerowanego przez program oraz hasło dostępu.
ID oraz hasło pozwolą nam na szybkie i sprawne zainstalowanie oprogramowania Serwisant, bez potrzeby angażowania Twoje czasu.
Pamiętaj: Abyśmy mogli się połączyć zdalnie, komputer na którym zamierzasz zainstalować SERWISANTA musi posiadać dostęp do Internetu.
Aby zainstalować program postępuj według poniższych kroków:
1. Włóż płytę instalacyjną,
2. przejdź do katalogu: 5. MATERIAŁY DODATKOWE,
3. Uruchom program instalacyjny: TeamViewer_Setup_pl (wersja 9).exe 4. Zostanie uruchomiony kreator programu. Zaznacz pole „do celów
indywidualnych/niekomercyjnych” i kliknij „Akceptuj – zakończ”
5. Program zostanie zainstalowany, po czym pokaże się okno z krótkimi informacjami dotyczącymi możliwości programu. Kliknij „Zamknij”
6. Po zamknięciu okienka pokaże się okno główne, w którym widnieje Twój unikatowy ID oraz wygenerowane hasło.
7. Przekaż zespołowi firmy RETEK „Twój ID” oraz „Hasło”, dzięki czemu będziemy mogli połączyć się zdalnie i zainstalować SERWISANT’a lub supportować wersję już zainstalowaną.
Zespół firmy RETEK
Strona: www.retek.pl Email: info@retek.pl tel. 792 003 974 606 468 947
