1. ve spot.properties odkomentovat spravne nastaveni posilani emailu - smtp server, uzivatel, heslo, ssl (od verze 2.8.1: tento bod preskocit, odesilani funguje jen pres seznamovy email - tj. stejny jako na lokale)

1. ve spot.properties odkomentovat spravne nastaveni posilani emailu - smtp server, uzivatel, heslo, ssl (od verze 2.8.1: tento bod preskocit, odesilani funguje jen pres seznamovy email, jinak ne)

• ve scriptu je třeba používat uživatele spot_zcu_cz tak aby příkazy typu ALTER TABLE ... OWNER TO ...; prošly bez warningů.

• ve scriptu je třeba používat uživatele @spot_zcu_cz@ tak aby příkazy typu @ALTER TABLE ... OWNER TO ...;@ prošly bez warningů.

Databáze

1. Příkaz "pg_dump -U username --clean dbname > dump.sql" vytvoří dump z lokální DB. Tento soubor bude obsahovat příkazy pro smazání všech tabulek, sekvencí apd.
2. Ze souboru dump.sql smazat řádky s mazáním schématu public, jeho vytvářením a řádku "ALTER SCHEMA public OWNER TO postgres"
3. Při nasazení na server do konzole: "psql dbname user"
4. A spustit příkaz: "\i cestaKSouboru"

Pozn: Poslední dva body platí i pro spouštění update skriptů

Existuje i krátký návod na rozchození užitečný pro vývoj na lokále (Březen 2013).

SPOT - nasazení projektu, verze z roku 2012

Existuje i aktuální návod na spuštění (Březen 2013)

SPOT - nasazení projektu, stará verze z roku 2012

Poznámka

Existuje i aktuální návod na spuštění (Březen 2013)

Překlad

1. V příkazové řádce příkazem mvn compile. Tento a další příkazy se volají z kořenového adresáře projektu.
2. Vytvoření archivu se provede z příkazové řádky příkazem mvn war:war, který se volá z kořenového adresáře projektu. Tedy toho adresáře, ve kterém se nachází soubor pom.xml. Nebo je možné spustit skript buildwar.cmd(windows) nebo buildwar.sh(linux) v adresáři /.src/scripts/, který se postará o kompletní překompilování tříd a sestavení finálního war souboru.
3. Po provedení příkazu se vytvořil v kořenovém adresáři projektu adresář target, který obsahuje mimo jiné požadovaný war archiv aplikace.

Backup

1. pg_dump -U username dbname > outfile #záloha databáze

Vlastní deploy .war souboru

Před samotným nasazením na ostrý server je doporučeno vyzkoušet tento release na testovacím serveru, podrobnosti na stránce BetaSpot

WAR archiv nahrajte do adresáře webapps, který se nachází v kořenovém adresáři servletového kontejneru jetty.

• databázový server Postgresql 8.x -- původně běžel SPOT na 7.4, dále na 8.1, ověřena je funkčnost na 8.3 pod Windows

Známé problémy

• pouze Windows - občas Jetty "zamkne" při spuštění statické soubory (css, js) aplikace, takže je není možné updatovat, řešení viz http://docs.codehaus.org/display/JETTY/Files+locked+on+Windows

• $ sudo apt-get install postgresql #yum install postgresql
• $ sudo passwd postgres #Změní heslo uživaleli 'postgres'
• $ sudo /etc/init.d/postgresql-* restart #Restartuje server
• $ su postgres #Přihlášení jako administrátor databáze
• $ createdb postgres #vytvoří databázi nazvanou 'postgres'
• $ psql postgres #přihlášení do databáze 'postgres'
• postgres=# ALTER USER postgres with password 'postgres'; #nastaví heslo uživateli 'postgres' v databázi na 'postgres'
• postgres=# \i spot.sql #provedení příkazů ze souboru, př. nahraje dump databáze projektu
• $ dropdb postgres #smaže databázi nazvanou 'postgres'
• $ pg_dump dbname > outfile #záloha databáze
• $ psql dbname < outfile #obnova databáze
• postgres=# select * from pg_stat_activity; #zjisteni jake selecty prave probihaji v databazi

• A nebo je tu možnost, že uživatel v kořenovém adresáři s aplikací zadá v příkazové řádce příkaz mvn jetty:run. Tímto příkazem se spouští servletový kontejner, který je pluginem do mavenu a v něm aplikace. Toto ovšem není ideální řešení pro produkční nasazení aplikace. Jde jen o testovací spouštění aplikace. Přihlašovací údaje pro administrátorský účet aplikace jsou username: admin, password:admin

Samostatné spuštění servletového kontejneru

1. spustit mvn clean, mvn compile, mvn war:war
2. z adresáře {SPOT}/target zkopírovat do {jetty}/webapps celou složku spot-2.0-rcX, kde {SPOT} je adresář projektu Spot a {jetty} je kořenový adresář rozbaleného archivu jetty
3. spuštění jetty se provede například příkazem java -jar start.jar z kořenového adresáře kontejneru (kam jste rozbalili archiv s jetty). Aplikace by měla nyní běžet na http://localhost:8080/spot-2.0-rcX (v případě problémů vyzkoušejte i http://localhost:8080/spot)

• A nebo je tu možnost, že se přeskočí kroky 2-5 a uživatel v kořenovém adresáři s aplikací zadá v příkazové řádce příkaz mvn jetty:run. Tímto příkazem se spouští servletový kontejner, který je pluginem do mavenu a v něm aplikace. Toto ovšem není ideální řešení pro produkční nasazení aplikace. Jde jen o testovací spouštění aplikace. Přihlašovací údaje pro administrátorský účet aplikace jsou: username: admin password:admin

postgres=# select * from pg_stat_activity; #zjisteni jake selecty prave probihaji v databazi

databázového serveru, se kterou je aplikace úspěšně otestována je verze 8.1 (zde je lokální kopie ke stažení Δ). S verzemi nižšími jsou problémy a verze vyšší nejsou zatím kompletně otestovány. Z těchto vyšších verzí je otestována pouze verze 8.4.1, která také způsobuje problémy, hlavně kvůli novým datovým typům.

• Při instalaci si PostgreSQL vytvoří defaultně databázi 'postgres', která nejde smazat (hláška "Maintenance database cant be dropped"). Pokud tuto databázi využíváte na localhostu jako databázi pro SPOT, můžete smazat pouze její obsah (tabulky atd.)

Restart databáze

Windows

• spuštění, zastavení nebo restart databáze: Start -> Spustit -> napsat services.msc -> vybrat službu PostgreSQL Database server 8.1, kliknout pravým tlačítkem a vybrat požadovanou událost (Spustit, Restartovat atd.)

Linux (debian)

Požadované operace v konzoli pomocí příkazů:

• sudo /etc/init.d/postgresql restart - restartování databáze
• sudo /etc/init.d/postgresql start - spuštění databáze
• sudo /etc/init.d/postgresql stop - zastavení databáze

Tipy a triky s db

• Platí pouze pro OS Windows: Nespouštění db serveru postgres hned po startu windows (např. kvůli rychlosti bootování, málo RAM atd.): kliknutím na Start -> Spustit -> napsat services.msc -> vybrat službu PostgreSQL Database server 8.1, kliknout pravým tlačítkem a vybrat Vlastnosti, vybrat Typ spuštění a zvolit ručně.

• Platí pouze pro windows: Pro instalaci je nutné mít spuštěnou systémovou službu Sekundární přihlašování, její stav lze zjistit kliknutím na Start -> Spustit -> napsat services.msc -> vybrat službu Sekundární přihlašování, pravým tlačítkem kliknout na Spustit, dále na Vlastnosti a vybrat Typ spuštění automaticky

• Při instalaci si PostgreSQL vytvoří defaultně databázi 'postgres', která nejde smazat. Pokud tuto databázi využíváte na localhostu jako databázi pro SPOT, můžete smazat pouze její obsah (tabulky atd.)

Tipy a triky s db

• Pokud si chcete urychlit práce a přidat uživatele přímo pomocí GUI pgAdminIII, setkáte se s tím, že uživatelovo heslo je MD5 hash. Nemůžete tedy vložit heslo jako plan text, řešením je tedy použítí nějakého programu pro vygenerování MD5 hashe, který následně můžete vložit. Poté nezapomeňte uživatele rovnou aktivovat, změnou hodnoty tabulky active na '1'.
• Platí pouze pro OS Windows: Změna hesla systémového uživatele 'postgres': Pro změnu se do windows přihlašte jako admin, Tento počítač -> pravym tlačítkem myši -> Spravovat -> vyberte něco jako 'Mistni uzivatele a skupiny', -> 'Uzivatele' -> vybeter uživatele postgres a změňte mu heslo na Vámi vybrané (doporučeno 'postgres')

• Při instalaci si PostgreSQL? vytvoří defaultně databázi 'postgres', která nejde smazat. Pokud tuto databázi využíváte na localhostu jako databázi pro SPOT, můžete smazat pouze její obsah (tabulky atd.)

• ./src/main/resources/WEB-INF/properties/jdbc.properties - přístup k postgresql(heslo a jméno databáze a uživatele, který k ní má práva). Tento soubor je nutné editovat, jinak se aplikace nepřipojí k DB a je více méně k ničemu. Více o JDBC na stránce NavrhAplikace

1. volbou je mít "nainstalovaný" servletový kontejner Tomcat a nebo Jetty, na kterých SPOT určitě běží. A poslední možností je používat spouštění aplikace z IDE. Předchůdci vyvíjeli v eclipse a zásadně buildili z něj. Přehledný návod pro instalaci Tomcatu do IDE k dispozici na http://keyboardsamurais.de/2007/02/26/eclipse-wtp-and-tomcat-tutorial/

1. overit stavajici implementaci nasazením na testovací server BetaSpot a pridat (ověřit) potrebny testovaci scenare - http://wiki.kiv.zcu.cz/SlovnikTerminologie/TestovaciScenare

• Před samotným nasazením na ostrý server je doporučeno vyzkoušet tento release na testovacím serveru, podrobnosti na stránce BetaSpot

1. pro první nasazení SPOTu na serveru: připravit si instalační skripty (případně binární soubory) na používané programy 3. stran, hlavně program [enca]. Instalační skript pro linux se nacházi v ./scripts/install.sh.

1. Před samotným nasazením na ostrý server je doporučeno vyzkoušet tento release na testovacím serveru, podrobnosti na stránce BetaSpot

1. v jdbc.properties zmenit podle nastaveni ostreho serveru hodnoty jdbc.url, jdbc.username, jdbc.password
2. ve log4j.properties podle potreby změnit cesty k logu: log4j.appender.R.File, log4j.appender.U.File
3. pokud byly nejake zmeny v databazi, připravit si SQL update skript, který bude potřeba spustit na ostré existujici databázi
4. pro první nasazení SPOTu na serveru: připravit si instalační skripty (případně binární soubory) na používané programy 3. stran, hlavně program [enca]. Instalační skript se nacházi v adresáři ./scripts.
5. na ReleaseNotes na FeatureList přidat info o nových vlastnostech
6. doplnit postup a změny instalace v nové verzi (dolů na tuto stránku - odstavecc Deploy)

1. pokud byly nejake zmeny v databazi, připravit si SQL update skript, který bude potřeba spustit na ostré databázi (případně další instalační skripty)

1. od uvolnene RC9? jsou změny v databázi, info o nasazení RC9? dále

1. Před vlastní přípravou balíčku je třeba nastavit property soubory (viz předchozí odstavec).

Návod instalace je určen pro linux. Práce v psql konzoli je nezávislá na platformě, tato konzole se v OS windows nachází standartně v c:\Program Files\PostgreSQL\8.1\bin\psql.exe nebo ji můžete spusit přes tlačíko Start -> PostgreSQL 8.1 -> 'psql' to postgres

• Platí pouze pro OS Windows: Změna hesla systémového uživatele 'postgres': Pro změnu se do windows přihlašte jako admin, Tento počítač -> pravym tlačítkem myši -> Spravovat -> vyberte něco jako 'Mistni uzivatele a skupiny', -> 'Uzivatele' -> vybeter uživatele postgres a změňte mu heslo na Vámi vybrané (doporučeno 'postgres')

Při importu slov ze souboru je k překódování obsahu souboru do správného kódování (UTF8?) používán program enca. Pokud jste si jisti, že uživatelé aplikace budou importovat soubory pouze ve správném kódování, není potřeba program instalovat (nedoporučuje se).

• Instalace v linuxové ditribuci založené na debianu se provede příkazem sudo apt-get install enca. V linuxových distribucích využívající balíčkovací systém rpm slouží pro nainstalování programu příkaz sudo yum install enca. Program enca se nachází standartně v repozitářích debianu i ubuntu. K instalaci na linuxových systémech je také možné použít jednoduchý bash skript v adresáři ./src/scripts.
• Případě systému windows je nutné zahrnout nainstalovaný program enca do PATH cygwinu.

• pokud spouštíte skipt přes gui pgAdminIII, můžete se setkat s chybou: ERROR: syntax error at or near "2" na znaku 26242, řešením je využít příkazovou řádku databáze postgres (viz návod u databáze Postgres uvedený výše)

Obrázkový tutoriál instalace Postgres 8.1 na OS windows turorial-postgres-instalace-win.zip [0,7 MB]

Obrázkový tutoriál instalace Postgres 8.1 na OS windows

 turorial-postgres-instalace-win.zip [0,7 MB]

Obrázkový tutoriál instalace Postgres 8.1 na OS windows turorial-postgres-instalace-win.zip [0,7 MB]

Obrázkový tutoriál instalace Postgres 8.1 na OS windowsturorial-postgres-instalace-win.zip [0,7 MB]

• Platí pouze pro nové Windows 7: na tomto operačním systému má gui pgAdminIII verze 1.4.2 (verze z instalačky postgres 8.1) občas menší problémy při překreslování okna, řešení je okno zavřít a spustit znovu.

1. Kodovani cele databaze je doporuceno nastavit pri instalaci jako UTF8

1. doplnit dolů na tuto stránku postup a změny instalace v nové verzi (odstavecc Deploy)

• nastaveni smtp serveru, e-mailového účtu a hesla pro pro odesílaní potvrzovacích e-mailů pro dvoufázovou registraci. Nutno přenastavit pro ostrý provoz, jinak nepůjdou vytvořit nové účty! Stačí v tomto souboru odkomentovat a zakomentovat příslušný odstavec s nastavením, viz komentáře uvnitř souboru.

1. ve spot.properties odkomentovat spravne nastaveni posilani emailu - smtp server, uzivatel, heslo, ssl (localhost nebo mail.kiv.zcu.cz)
2. Odkomentovat v header.jsp javascripty (+ google link ?) kvuli google analytics (na localhostu by behem vyvoje melo zustat zakomentovane)
3. zkontrolovat verzi aplikace; nejaka verze aplikace je uvedena ve pom.xml a spot.properties; ve footer.jsp se nacita uz z properties, nekdo tam to nacitani verze uz vyresil
4. v jdbc.properties zmenit podle nastaveni ostreho serveru hodnoty jdbc.url, jdbc.username, jdbc.password
5. ve log4j.properties podle potreby zmenit cesty k logu: log4j.appender.R.File, log4j.appender.U.File

1. od uvolnene RC9? jsou změny v databázi, info nasazení RC9? dále

1. Po provedení příkazu se vytvořil v kořenovém adresáři projektu adresář target, který obsahuje mimo jiné požadovaný war archiv aplikace. Tento archiv nahrajte do adresáře webapps, který se nachází v kořenovém adresáři servletového kontejneru jetty.

1. od uvolnene RC9? jsou změny v databázi, infoo nasazení RC9? dále

1. Vytvoření archivu se provede z příkazové řádky příkazem mvn war:war, který se volá z kořenového adresáře projektu. Tedy toho adresáře, ve kterém se nachází soubor pom.xml. Nebo je možné spustit skript buildwar.cmd(windows) nebo buildwar.sh(linux) v adresáři /.src/scripts/, který se postará o kompletní překompilování tříd a sestavení finálního war souboru.

spot-2.0-rc7 (depricated)

1. nainstalovat program enca (standartne v repozitarich debianu) na server - spustit instalacni bash skript /scripts/install.sh
2. aktualizovat databazi - spustit SQL skript /scripts/spot_update.sql

spot-2.0-rc9

1. nainstalovat program enca (standartne v repozitarich debianu) na server - spustit instalacni bash skript /scripts/install.sh
2. sql skript pro databazi - je potřeba spustit nový SQL skript /scripts/2009-11-23/2009-11-23.sql

• Při změně hodnoty v některém property souboru je nutný restart servletového kontejneru, protože tyto hodnoty se načítají pouze při jeho startu

1. volbou je využívat pluginu do mavenu jetty, o používání více v dokumentu PouzivaneTechnologie a NavrhAplikace.

• ./src/main/resources/WEB-INF/properties/jdbc.properties - přístup k postgresql(heslo a jméno databáze a uživatele, který k ní má práva). Tento soubor je nutné editovat, jinak se aplikace nepřipojí k DB a je více méně k ničemu.
• ./src/main/resources/WEB-INF/classes/log4j.properties - nastavení cesty, kam se budou zapisovat logy, jméno logovacího souboru, zakázání výpisu logu do příkazové řádky nebo do souboru, velikost logovacího souboru, případně jiné atributy logování. Defaultně se logy nacházejí v ./logs
• ./src/main/resources/WEB-INF/classes/spot.properties
  • nastaveni smtp serveru, e-mailového účtu a hesla pro pro odesílaní potvrzovacích e-mailů pro dvoufázovou registraci. Nutno přenastavit pro ostrý ptovoz, jinak nepůjdou vytvořit nové účty! Stačí v tomto souboru odkomentovat a zakomentovat příslušný odstavec s nastavením, viz komentáře uvnitř souboru.
  • nastavení globálního počtu položek na stránkované stránce.
  • nastavení oddělovačů při parsování importovaných souborů. Toto nastavení není doporučeno měnit bez bližší znalosti dané problematiky!
  • nastavení souboru, kam se nahrají provizorní data při hromadném importu. Taktéž je třeba přenastavit, případně zvolenému adresáři přidělit potřebná práva.
  • nastavení váhy práv jednotlivých rolí uživatelů. Toto nastavení není doporučeno měnit bez bližší znalosti dané problematiky!

Při importu slov ze souboru je k překódování obsahu souboru do správného kódování (UTF8?) používán program enca. Instalace v linuxové ditribuci založené na debianu se provede příkazem sudo apt-get install enca. V linuxových distribucích využívající balíčkovací systém rpm slouží pro nainstalování programu příkaz sudo yum install enca. Program enca se nachází standartně v repozitářích debianu i ubuntu. K instalaci na linuxových systémech je také možné použít jednoduchý bash skript v adresáři ./src/scripts. Případě systému windows je nutné zahrnout nainstalovaný program enca do PATH cygwinu

Import slov ze souboru

Při importu slov ze souboru je k překódování obsahu souboru do správného kódování (UTF8?) používán program enca. Instalace v linuxové ditribuci založené na debianu se provede příkazem sudo apt-get install enca. V linuxových distribucích využívající balíčkovací systém rpm slouží pro nainstalování programu příkaz sudo yum install enca. Program enca se nachází standartně v repozitářích debianu i ubuntu. K instalaci na linuxových systémech je také možné použít jednoduchý bash skript v adresáři ./src/scripts

Konfigurace property souborů

Příprava souborů

1. na spot.zcu.cz bezi ted rc7, od uvolnene rc7 je zmena v databazi, takze pri upgradu spot.zcu.cz je potreba update databaze /sql/2009-05-26/spot_update.sql

Deploy

Vlastní deploy aplikace se provede následovně:

1. Před vlastní přípravou balíčku je třeba nastavit property soubory(vit předchozí odstavec).
2. Dalším krokem je překompilování zdrojových souborů v příkazové řádce příkazem mvn compile. Tento a další příkazy se volají z kořenového adresáře projektu.
3. Vytvoření archivu se provede z příkazové řádky příkazem mvn war:war, který se volá z kořenového adresáře projektu. Tedy toho adresáře, ve kterém se nachází soubor pom.xml. Nebo je možné spustit skript buildwar.cmd(windows) nebo buildwar.sh(linux) v adresáři /.src/scripts/, který se postará o kompletní překompilování tříd a sestavení finálního war souboru.
4. Po provedení příkazu se vytvořil v kořenovém adresáři projektu adresář target, který obsahuje mimo jiné požadovaný war archiv aplikace. Tento archiv nahrajte do adresáře webapps, který se nachází v kořenovém adresáři servletového kontejneru jetty.

Spuštění aplikace

Spuštění servletového kontejneru se provede například příkazem java -jar start.jar z kořenového adresáře kontejneru. Aplikace by měla nyní běžet na http://localhost:8080/spot-2.0 (v případě problémů vyzkoušejte i http://localhost:8080/spot) A nebo je tu možnost, že se přeskočí kroky 2-5 a uživatel v kořenovém adresáři s aplikací zadá v příkazové řádce příkaz mvn jetty:run. Tímto příkazem se spouští servletový kontejner, který je pluginem do mavenu a v něm aplikace. Toto ovšem není ideální řešení pro produkční nasazení aplikace. Jde jen o testovací spouštění aplikace. Přihlašovací údaje pro administrátorský účet aplikace jsou: username: admin password:admin

spot-2.0-rc7

1. nainstalovat program enca (standartne v repozitarich debianu) na server - spustit instalacni bash skript /scripts/install.sh
2. aktualizovat databazi - spustit SQL skript /scripts/spot_update.sql

spot-2.0-rc9

1. sql skript pro databazi - je potřeba spustit nový SQL skript /scripts/2009-11-23/2009-11-23.sql

$ dropdb postgres #smaže databázi nazvanou 'postgres' $ pg_dump dbname > outfile #záloha databáze $ psql dbname < outfile #obnova databáze

1. Spusťte jediný inicializační SQL skript (/sql/<nejnovějěí datum>) pod vámi vytvořenou databází, v tomtéž adresáři se nachází soubor readme.txt s podrobnějšími informacemi

• ikona "Execute arbitary SQl? queries" na hlavnim panelu slouží pro SQL operace s db

• Platí pouze pro windows: Pro instalaci je nutné mít spuštěnou systémovou službu Sekundární přihlašování, její stav lze zjistit kliknutím na Start -> Spustit > napsat services.msc -> vybrat službu Sekundární přihlašování, pravým tlačítkem kliknout na Spustit, dále na Vlastnosti a vybrat Typ spuštění automaticky

Známe problémy

• Platí pouze pro windows: Pro instalaci je nutné mít spuštěnou systémovou službu Sekundární přihlšování, její stav lze zjistit kliknutím na Start -> Spustit > napsat services.msc -> vybrat službu Sekundární přihlašování, pravým tlačítkem kliknout ma Spustit, dále na [Vlastnosti@] a vybrat Typ spuštění automaticky

1. Spusťte jediný inicializační SQL skript (./sql) pod vámi vytvořenou databází

Známe problémy

• Platí pouze pro windows: Pro instalaci je nutné mít spuštěnou systémovou službu Sekundární přihlšování, její stav lze zjistit kliknutím na Start -> Spustit > napsat services.msc -> vybrat službu Sekundární přihlašování, pravým tlačítkem kliknout ma Spustit, dále na [Vlastnosti@] a vybrat Typ spuštění automaticky

Instalace a spuštění postgresql databáze

Konzole

pgAdmin gui

• pro úpravu databáze lze použít i program pgAdmin, který se standartně instaluje s databází
• práce v pgAdmin je intuitivní
• změnu databáze lze provést v položce "Databases", kde je potřeba vybrat požadovanou db a rozkliknutím položky editovat hodnoty
• ikona "Execute arbitary SQlqueries?" na hlavnim panelu slouží pro SQL operace s db
• uživatele lze přidat v položce "Login Roles"

Nyní by jste měli mít připraven maven k použití. To se lehce ověří příkazem "mvn -version", po kterém maven vypíše mimo jiné verzi operačního systému a běžícího mavenu. Doporučuji spouštět maven jen s připojením k internetu a to z toho důvodu, že maven si stahuje do lokálního repositáře potřebné balíčky z výchozích repositářů. Na úplném začátku je tedy doporučeno jednou spustit alespoň příkazy:

* mvn clean
* mvn compile
* mvn war:war
* mvn javadoc:javadoc
* mvn jetty:run

Více informací můžete najít v anglickém jazyce na URL: http://maven.apache.org/download.html

• JemnyUvodDoMavenu¨
• http://beans.seartipy.com/2008/08/22/installing-sun-java-se-6-apache-maven-2-and-tomcat-55-on-windows-os/

• Pouze pro Windows: pro načtení systémových proměnných budete muset pravděpodobně restartovat počítač

Tutoriál pro windows: turorial-spot-app-spusteni.zip [0,4 MB]

• v adresáři projektu /scripts lze nalézt jednoduché pomocné skripty

1. Po úspěšné instalaci vytvořte v proměnných prostředích systémovou proměnnou JAVA_HOME s hodnotou odkazující na adresář s nainstalovanou Javou JDK, Napr.: C:\Program Files\Java\jdk1.5.0_02
2. Pak přidejte do PATH řetězec %JAVA_HOME%/bin a zakončete středníkem.

1. Pouze pro Windows: pro načtení systémových proměnných budete muset pravděpodobně restartovat počítač

Aktuální verze (listopad 2009) je 2.2.1.

1. Vytvorime v promennych prostredi systémovou promennou MAVEN_HOME s hodnotou odkazujici na adresar, kde se prave nachazi maven. Napr.: c:/Program Files/Apache Software Foundation/maven-2.0.x
2. Do systémové proměnné PATH přidejte řětězec %MAVEN_HOME%/bin a zakončete středníkem. Tim zajistime, ze OS bude hledat pro spusteni prikazu mvn(spustitelny soubor) ve spravnem adresari.
3. Spravne nastaveni zjistime v bash / cmd(command line) napriklad prikazem "mvn -version". POZOR: JE NUTNE BYT PRIPOJEN K ITERNETU! Pri prvnim spusteni temer kazdeho prikazu nebo pripadne pridani knihovny do pom.xml se vzdy tahaji potrebne knihovny a soubory z hlavni repository z netu. Pokud se vypise verze mavenu, tak mate spravne nastaveny krok 4 a muzete pokracovat dále), jinak opakujte. Muze se take stat, ze nemate nastaveny JAVA_HOME v PATH, takže je nutné tuto systémovou proměnnou pridat podle návodu uvedeného výše.

1. instalaci spustit příkazem "sudo apt-get install sun-java6-jdk sun-java6-plugin"
2. pokud máte nainstalováno více verzí Javy, zobrazíte verze přikazem "update-java-alternatives -l" a vyberete výchozí verzi příkazem "sudo update-java-alternatives -s java-6-sun"

Ověření funkčnosti

1. úspěšnou instalaci lze ověřit v konzoli příkazem "java" a "javac", kdy by oba měly vypsat nápovědu.
2. Pouze pro Windows: pokud se vyskytl problém s kompilátorem javac, který nemůže najít žádné *.java soubory, zkuste do PATH přidat pouze znak '.' (tečka) a zakončit znakem ';' (středník).

• http://cs.wikipedia.org/wiki/Java_(programovací_jazyk)

Maven je nástroj sloužící k snazšímu řízení projektů. Zároveň je to kus software, který programátorům usnadňuje jejich činnost. Dal by se přirovnat k nástroji Ant, jen s tím rozdílem, že v antu programátor musí nadefinovat, co vlastně ant má provést, kdežto v mavenu jen stačí nadeklarovat, co chce programátor provést. Doporučená verze je 2.0.8, avšak je velmi pravděpodobné, že pro všechny verze řady 2.0.x poběží aplikace korektně.

Postgre SQL

Postgresql je databázový server, se kterým pracuje aplikace SPOT. Jediná verze databázového serveru, se kterou je aplikace úspěšně otestována je verze 8.1. S verzemi nižšími jsou problémy a verze vyšší nejsou zatím kompletně otestovány. Z těchto vyšších verzí je otestována pouze verze 8.4.1, která také způsobuje problémy, hlavně kvůli novým datovým typům.

Instalace

Před vlastním nasazením aplikace je třeba mít nainstalován potřebný software.

• Java JDK 5.0 nebo vyšší
• nástroj Maven, ideálně 2.0.x
• databázový server Postgresql 8.1 - na toto pozor! Při mém 1. deploy běžel SPOT nad postgres 7.4 a kvůli mě a mým předchůdcům se překlápěl na 8.1...
• servletový kontejner Jetty

Základní popis jejich instalace se nachází na následujících řádcích.

Maven lze stahnout z http://maven.apache.org/download.html Podrobny navod se da najit v dokumentaci a nebo ve volne stazitelne knize Better builds with Maven, volne stazitelna z http://www.exist.com/better-build-maven.

1. rozbalime archiv do adresare, kde se nachazi uzivatelske programy. Doporucuje se neco ve stylu c:/Program Files/Apache Software Foundation/maven-2.0.x
2. Nastavime v promennych prostredi MAVEN_HOME odkazujici na adresar, kde se prave nachazi maven. Napr.: /home/programy/maven-2.0.x
3. Do PATH přidejte odkaz na /bin. Tim zajistime, ze OS bude hledat pro spusteni prikazu mvn(spustitelny soubor) ve spravnem adresari. Spravne nastaveni zjistime v bash / cmd(command line) napriklad prikazem mvn -version. POZOR: JE NUTNE BYT PRIPOJEN K ITERNETU! Pri prvnim spusteni temer kazdeho prikazu nebo pripadne pridani knihovny do pom.xml se vzdy tahaji potrebne knihovny a soubory z hlavni repository z netu. Pokud se vypise verze mavenu, tak mate spravne nastaveny krok 2 a muzete pokracovat na 3), jinak opakujte. Muze se take stat, ze nemate nastaveny JAVA_HOME v PATH, takze pridat.

1. Pod operačním systémem linux, distribuce Debian, stačí nainstalovat balík maven2 příkazem "sudo apt-get install maven2", pokud Vaše distribuce založená na Debianu nemůže balík najít, zkuste ho najít ručně příkazem "sudo apt-cache search maven2".

Ověření funkčnosti

Nyní by jste měli mít připraven maven k použití. To se lehce ověří příkazem "mvn -version", po kterém maven vypíše mimo jiné verzi operačního systému a běžícího mavenu. Doporučuji spouštět maven jen s připojením k internetu a to z toho důvodu, že maven si stahuje do lokálního repositáře potřebné balíčky z výchozích repositářů. Více informací můžete najít v anglickém jazyce na URL: http://maven.apache.org/download.html

Instalace Maven

Maven lze stahnout z http://maven.apache.org/download.html Podrobny navod se da najit v dokumentaci a nebo ve volne stazitelne knize Better builds with Maven, volne stazitelna z http://www.exist.com/better-build-maven.

Linux - Debian

Pod operačním systémem linux, distribuce Debian, stačí nainstalovat balík maven2 příkazem "sudo apt-get install maven2", pokud naše distribuce založená na Debianu nemůže balík najít, zkuste ho najít ručně příkazem "sudo apt-cache search maven2", poté můžeme ověřit správnou instalaci například příkazem "mvn -version"

Strucny popis instalace Mavenu:

• rozbalime archiv do adresare, kde se nachazi uzivatelske programy. Doporucuje se neco ve stylu c:/Program Files/Apache Software Foundation/maven-2.0.x
• Nastavime v promennych prostredi MAVEN_HOME odkazujici na adresar, kde se prave nachazi maven. Napr.: /home/programy/maven-2.0.x a pak do PATH MAVEN_HOME/bin. Tim zajistime, ze OS bude hledat pro spusteni prikazu mvn(spustitelny soubor) ve spravnem adresari. Spravne nastaveni zjistime v bash / cmd(command line) napriklad prikazem mvn -version. POZOR: JE NUTNE BYT PRIPOJEN K ITERNETU! Pri prvnim spusteni temer kazdeho prikazu nebo pripadne pridani knihovny do pom.xml se vzdy tahaji potrebne knihovny a soubory z hlavni repository z netu. Pokud se vypise verze mavenu, tak mate spravne nastaveny krok 2 a muzete pokracovat na 3), jinak opakujte. Muze se take stat, ze nemate nastaveny JAVA_HOME v PATH, takze pridat.
• Nyni uz mame pripraveno vse dulezite k beznemu chodu a vyvoji aplikace.

1. Stáhněte si archiv z URL: http://www.postgresql.org/download/ (instalacni soubor pro postgres 8.1 win32 lze docasne stahnout z http://home.zcu.cz/~jsobisek/spot)

Instalace a spuštění postgresql databáze - linux

Spuštění aplikace

Pro windows: turorial-spot-app-spusteni.zip [0,4 MB]

Instalace a spuštění postgresql databáze

Návod instalce je určen pro linux. Práce v psql konzoli je nezávislá na platformě.

$ sudo apt-get install postgresql         #yum install postgresql
$ sudo passwd postgres			   #Změní heslo uživaleli 'postgres'
$ sudo /etc/init.d/postgresql-* restart	   #Restartuje server
$ su postgres				   #Přihlášení jako administrátor databáze

$ createdb postgres		#vytvoří databázi nazvanou 'postgres'
$ psql postgres			#přihlášení do databáze 'postgres'
postgres=# ALTER USER postgres with password 'postgres';	#nastaví heslo uživateli 'postgres' v databázi na 'postgres'
postgres=# \i spot.sql    #provedení příkazů ze souboru, př. nahraje dump databáze projektu 

Konfigurace aplikace

Je potřeba mít nainstalovaný:

• Java 5.0 nebo vyšší
• Maven, ideálně 2.0.x
• Postgresql 8.1 - na toto pozor! Při mém 1. deploy běžel SPOT nad postgres 7.4 a kvůli mě a mým předchůdcům se překlápěl na 8.1...- a to je více méně vše.

Nyní to záleží na zvycích vývojáře jak to vyřeší se servletovým kontejnerem.

1. volbou je využívat pluginu do mavenu jetty, o používání více v dokumentu popisTechnologii.
2. volbou je mít "nainstalovaný" servletový kontejner Tomcat a nebo Jetty, na kterých SPOT určitě běží. A poslední možností je používat spouštění aplikace z IDE. Předchůdci vyvíjeli v eclipse a zásadně buildili z něj.

Pro zdárný běh aplikace je potřeba nakonfigurovat pár konfiguračních souborů pro local:

./src/main/resources/WEB-INF/properties/jdbc.properties - přístup k postgresql(heslo a jméno databáze a uživatele, který k ní má práva)

./src/main/resources/WEB-INF/classes/log4j.properties - nastavení cesty, kam se budou zapisovat logy, případně velikost logovacího souboru.

./src/main/resources/WEB-INF/classes/spot.properties - různé možnosti nastaveni vlastní aplikace.

Instalace windows

1. Přidejte do proměnných prostředí přidejte proměnnou MAVEN_HOME odkazující na adresář s umístěním rozbaleného archivu.

Instalace linux (debian)

1. instalaci stačí spustit příkazem sudo apt-get install maven2

Ověření funkčnosti

Nyní by jste měli mít připraven maven k použití. To se lehce ověří příkazem mvn –version, po kterém maven vypíše mimo jiné verzi operačního systému a běžícího mavenu. Doporučuji spouštět maven jen s připojením k internetu a to z toho důvodu, že maven si stahuje do lokálního repositáře potřebné balíčky z výchozích repositářů. Více informací můžete najít v anglickém jazyce na URL: http://maven.apache.org/download.html

V případě problému zkuste najít řešení problému na URL: http://java.sun.com/javase/

Instalace windows:

Instalace linux (debian)

1. instalaci spustit příkazem sudo apt-get install sun-java6-jdk sun-java6-plugin
2. pokud máte nainstalováno více verzí Javy, zobrazíte verze přikazem update-java-alternatives -l a vyberete výchozí verzi příkazem sudo update-java-alternatives -s java-6-sun

Odkazy

• http://wiki.ubuntu.cz/Java

1. Stáhněte si archiv z URL: http://www.postgresql.org/download/ (instalacku pro postgres 8.1 win32 lze docasne stahnout z http://home.zcu.cz/~jsobisek/spot)

Odkazy

• http://wiki.ubuntu.cz/PostgreSQL
• http://www.mangui.e-blog.cz/index.php?clanek=4

1. na spot.zcu.cz bezi ted rc6, od uvolnene rc7 je zmena v databazi, takze pri upgradu spot.zcu.cz je potreba update databaze /sql/2009-05-26/spot_update.sql

Konfigurace property souborů

Deploy info z bugzilly // TODO merge

1. ve spot.properties odkomentovat spravne nastaveni posilani emailu - smtp server, uzivatel, heslo, ssl (localhost nebo mail.kiv.zcu.cz)
2. Odkomentovat v header.jsp javascripty (+ google link ?) kvuli google analytics (na localhostu by behem vyvoje melo zustat zakomentovane)
3. zkontrolovat verzi aplikace; nejaka verze aplikace je uvedena ve pom.xml a spot.properties; ve footer.jsp se nacita uz z properties, nekdo tam to nacitani verze uz vyresil
4. v jdbc.properties zmenit podle nastaveni ostreho serveru hodnoty jdbc.url, jdbc.username, jdbc.password
5. ve log4j.properties podle potreby zmenit cesty k logu: log4j.appender.R.File, log4j.appender.U.File
6. na ReleaseNotes na FeatureList pridat info o novych vlastnostech
7. overit stavajici implementaci a pridat potrebny testovaci scenare - http://wiki.kiv.zcu.cz/SlovnikTerminologie/TestovaciScenare
8. na spot.zcu.cz bezi ted rc6, od uvolnene rc7 je zmena v databazi, takze pri upgradu spot.zcu.cz je potreba

update databaze /sql/2009-05-26/spot_update.sql

1. Vytvoření archivu se provede z příkazové řádky příkazem mvn war:war, který se volá z kořenového adresáře projektu. Tedy toho adresáře, ve kterém se nachází soubor pom.xml.
2. Po provedení příkazu se vytvořil v kořenovém adresáři projektu adresář target, který obsahuje mimo jiné požadovaný war archiv aplikace. Tento archiv nahrajte do adresáře webapps, který se nachází v kořenovém adresáři servletového kontejneru jetty.
3. Spuštění servletového kontejneru se provede například příkazem java -jar start.jar z kořenového adresáře kontejneru. Aplikace by měla nyní běžet na http://localhost:8080/spot-2.0 A nebo je tu možnost, že se přeskočí kroky 2-5 a uživatel v kořenovém adresáři s aplikací zadá v příkazové řádce příkaz mvn jetty:run. Tímto příkazem se spouští servletový kontejner, který je pluginem do mavenu a v něm aplikace. Toto ovšem není ideální řešení pro produkční nasazení aplikace. Jde jen o testovací spouštění aplikace. Přihlašovací údaje pro administrátorský účet aplikace jsou: username: admin password:admin

Odkazy

• JemnyUvodDoMavenu

SPOT - nasazení projektu

Potřebný software

Před vlastním nasazením aplikace je třeba mít nainstalován potřebný software. Jedná se o Java JDK, nástroj Maven 2, databázový server PostgreSQL? a servletový kontejner Jetty. Základní popis jejich instalace se nachází na následujících řádcích.

Java

Pro úspěšný běh aplikace je třeba mít nainstalovanou Javu 5.0 nebo vyšší. Instalace:

1. Z URL: http://java.sun.com/javase/downloads/index.jsp si stáhněte potřebný instalační soubor.
2. Spusťte instalaci.
3. Po úspěšné instalaci nastavte JAVA_HOME v proměnných prostředí.
4. Pak přidejte do PATH /bin
5. Nyní by jste měli mít Javu nainstalovanou tak, jak je třeba pro další software.

V případě problému zkuste najít řešení problému na URL: http://java.sun.com/javase/

Maven 2

Maven je nástroj sloužící k snazšímu řízení projektů. Zároveň je to kus software, který programátorům usnadňuje jejich činnost. Dal by se přirovnat k nástroji Ant, jen s tím rozdílem, že v antu programátor musí nadefinovat, co vlastně ant má provést, kdežto v mavenu jen stačí nadeklarovat, co chce programátor provést. Doporučená verze je 2.0.8, avšak je velmi pravděpodobné, že pro všechny verze řady 2.0.x poběží aplikace korektně.

Instalace

1. Stáhněte si archiv mavenu z URL: http://maven.apache.org/download.html
2. Rozbalte archiv do umístění, ze kterého bude spouštěn.
3. Přidejte do proměnných prostředí přidejte proměnnou MAVEN_HOME

odkazující na adresář s umístěním rozbaleného archivu.

1. Do PATH přidejte odkaz na /bin.
2. Nyní by jste měli mít připraven maven k použití. To se lehce ověří příkazem mvn –version,

po kterém maven vypíše mimo jiné verzi operačního systému a běžícího mavenu. Doporučuji spouštět maven jen s připojením k internetu a to z toho důvodu, že maven si stahuje do lokálního repositáře potřebné balíčky z výchozích repositářů. Více informací můžete najít v anglickém jazyce na URL: http://maven.apache.org/download.html

PostgreSQL?

PostgreSQL? je databázový server, se kterým pracuje aplikace SPOT. Jediná verze databázového serveru, se kterou je aplikace úspěšně otestována je verze 8.1. S verzemi nižšími jsou problémy a verze vyšší nejsou zatím otestovány.

Instalace

1. Stáhněte si archiv z URL: http://www.postgresql.org/download/
2. Spusťte instalační balíček a nainstalujte databázový server. V případě instalace na unix like OS doporučuji navštívit patřičná fóra pro získání rad, jak server snadno a rychle server nastavit a zprovoznit.
3. Vytvořte si patřičného uživatele na DB serveru a databázi, pod kterou budete chtít mít uložená data aplikace.
4. Spusťte inicializační SQL DDL skripty pod vámi vytvořenou databází v pořadí spot.sql a poté spot-upgrade.sql. Ty se nachází v dodaném balíčku v adresáři ./sql. V budoucnu bude nahrazeno jedním skriptem.
5. Nyní by jste měli mít inicializované tabulky základními daty.

V případě problémů zkuste najít řešení na URL: http://www.postgresql.org/docs/8.1/interactive/index.html

Jetty

Lehký servletový kontejner, na kterém rozběháte aplikaci bez nutnosti instalace kontejneru. Aplikace by měla bez problému běžet na verzi 6.1.x. Testováno jen pro verze 6.1.8 – 6.1.12rc3.

Instalace

1. Stáhněte si archiv servletového kontejneru z URL: http://dist.codehaus.org/jetty/
2. Rozbalte do adresáře, ze kterého budete chtít servletový kontejner spouštět. Servletový kontejner není třeba nijak instalovat a nastavovat. Základy jeho použití naleznete níže. V případě problému se servletovým kontejnerem navštivte http://docs.codehaus.org/display/JETTY/Jetty+Wiki

Konfigurace property souborů

Zde jsou popsány konfigurační soubory aplikace, přes které se dá do jisté míry upravit chování aplikace. Všechny konfigurační soubory se nachází na tomto umístění:./src/main/webapp/WEB-INF/properties/

• jdbc.properties - přístup k postgresql(heslo a jméno databáze a uživatele, který k ní má práva). Tento soubor je nutné editovat, jinak se aplikace nepřipojí k DB a je více méně k ničemu.
• log4j.properties - nastavení cesty, kam se budou zapisovat logy, jméno logovacího souboru, zakázání výpisu logu do příkazové řádky nebo do souboru, případně jiné atributy logování.
• mail.properties – nastaveni smtp serveru, e-mailového účtu a hesla pro pro odesílaní potvrzovacích e-mailů pro dvoufázovou registraci. Nutno přenastavit, jinak nepůjdou vytvořit nové účty!
• paging.properties – nastavení globálního počtu položek na stránkované stránce.
• separator.properties - nastavení oddělovačů při parsování importovaných souborů. Tento soubor není doporučeno měnit bez bližší znalosti dané problematiky!
• temp-directory.properties - nastavení souboru, kam se nahrají provizorní data při hromadném importu. Taktéž je třeba přenastavit, případně zvolenému adresáři přidělit potřebná práva.
• weight-votes.properties - nastavení váhy práv jednotlivých rolí uživatelů. Tento soubor není doporučeno měnit bez bližší znalosti dané problematiky!

Deploy aplikace

Vlastní deploy aplikace se provede následovně:

1. Před vlastní přípravou balíčku je třeba nastavit property soubory.
2. Dalším krokem je překompilování zdrojových souborů v příkazové řádce příkazem mvn compile. Tento a další příkazy se volají z kořenového adresáře projektu.
3. Vytvoření archivu se provede z příkazové řádky příkazem mvn war:war, který se volá z kořenového adresáře projektu. Tedy toho adresáře, ve kterém se nachází soubor pom.xml.
4. Po provedení příkazu se vytvořil v kořenovém adresáři projektu adresář target, který obsahuje mimo jiné požadovaný war archiv aplikace. Tento archiv nahrajte do adresáře webapps, který se nachází v kořenovém adresáři servletového kontejneru jetty.
5. Spuštění servletového kontejneru se provede například příkazem 'java -jar start.jar' z kořenového adresáře kontejneru. Aplikace by měla nyní běžet na url: http://localhost:8080/spot-2.0 A nebo je tu možnost, že se přeskočí kroky 2-5 a uživatel v kořenovém adresáři s aplikací zadá v příkazové řádce příkaz mvn jetty:run. Tímto příkazem se spouští servletový kontejner, který je pluginem do mavenu a v něm aplikace. Toto ovšem není ideální řešení pro produkční nasazení aplikace. Jde jen o testovací spouštění aplikace. Přihlašovací údaje pro administrátorský účet aplikace jsou: username: admin password:admin

spot-2.0-rc7

1. nainstalovat program enca (standartne v repozitarich debianu) na server - spustit instalacni bash skript /scripts/install.sh
2. aktualizovat databazi - spustit SQL skript /scripts/spot_update.sql