[Greater-commits] r3797 - trunk/packaging/doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Oct 13 16:08:45 CEST 2011
Author: aheinecke
Date: 2011-10-13 16:08:44 +0200 (Thu, 13 Oct 2011)
New Revision: 3797
Modified:
trunk/packaging/doc/Makefile
trunk/packaging/doc/greater-installation.tex
Log:
Expanded draft. todos removed content checked
and reworked
Modified: trunk/packaging/doc/Makefile
===================================================================
--- trunk/packaging/doc/Makefile 2011-10-13 14:08:09 UTC (rev 3796)
+++ trunk/packaging/doc/Makefile 2011-10-13 14:08:44 UTC (rev 3797)
@@ -1,21 +1,21 @@
# just to make document processing a bit easier
-.SUFFIXES: .dvi .tex .jpg .eps .ps .fig .pdf .html
+.SUFFIXES: .dvi .tex .jpg .eps .ps .fig .pdf .html .png
-LATEX = latex
+LATEX = pdflatex
# the following line may look strange, but it works!
#TEXINPUTS = /home/intevation/doc/sty:$(TEXINPU)
-DOCUMENTS = greater-installation.ps
-IMAGES =
+DOCUMENTS = greater-installation.pdf
+IMAGES =
-%.eps: %.jpg
- convert jpg:$*.jpg eps:$*.eps
+%.eps: %.png
+ convert png:$*.png eps:$*.eps
%.eps: %.fig
fig2dev -L ps -p dummy_arg -z A4 $*.fig > $*.ps
-%.dvi: %.tex
+%.pdf: %.tex
$(LATEX) $*.tex && $(LATEX) $*.tex
%.ps: %.dvi
Modified: trunk/packaging/doc/greater-installation.tex
===================================================================
--- trunk/packaging/doc/greater-installation.tex 2011-10-13 14:08:09 UTC (rev 3796)
+++ trunk/packaging/doc/greater-installation.tex 2011-10-13 14:08:44 UTC (rev 3797)
@@ -1,5 +1,5 @@
%vim:set tw=68:
-\documentclass[a4paper,twoside,BCOR19mm]{scrbook}
+\documentclass[a4paper,11pt,oneside,openright,titlepage]{scrbook}
\usepackage{lastpage}
\usepackage[latin1]{inputenc}
\usepackage{color}
@@ -13,7 +13,7 @@
\def\CVS$#1: #2 ${\expandafter\def\csname CVS#1\endcsname{#2}}
-\CVS$Id: 1.0.0$
+\def\CVSId{1.0.0}
%----------------------------------------------
% Document DATE and VERSION
@@ -77,7 +77,7 @@
\parindent0cm
{
- \includegraphics[width=0.3\textwidth]{./intevation-logo.eps}\\[0.1cm]
+ \includegraphics[width=0.3\textwidth]{./intevation-logo.png}\\[0.1cm]
{\tt http://intevation.net}\\[2.0cm]
}
@@ -122,6 +122,7 @@
\item Thuban Manual, \\Intevation GmbH, 2011
\item GREAT-ER Manual, \\Intevation GmbH, 2011
\item GREAT-ER Administration, \\TechniData AG / Intevation GmbH, 2011
+\item GREAT-ER Cat
\end{itemize}
\vfill
@@ -153,12 +154,12 @@
about the Version you are about to install.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/setup1.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/setup1.png}}{
\GREATER\ Installation Welcome screen}
\end{center}
Please follow the instructions on the screen and accept the license
-of GREAT-ER. GREAT-ER is completely free software and licensed under
+of \GREATER\. \GREATER\ is completely free software and licensed under
the GNU General Public License (GPL) version 2.
\section{Installation Types}
@@ -167,7 +168,7 @@
will install everything that is necessary to use \GREATER\ on the system.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/setup2.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/setup2.png}}{
\GREATER\ Installation Components}
\end{center}
@@ -202,7 +203,7 @@
\item Client only Installation \\
Install only the \GREATER\-Desktop client. To
use it for simulations you need to have access to a separate simulation
-Server as well as a Database. This installation type does {\bf\not} provide
+Server as well as a Database. This installation type does {\bf not} provide
a standalone client installation.
\item Server Installation \\
Install the PostgreSQL Database for GREAT-ER, with the default datasets.
@@ -212,7 +213,7 @@
not wish to install by unchecking the checkbox of that component.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/setup3.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/setup3.png}}{
Installation with only the standard desktop client.}
\end{center}
@@ -222,10 +223,26 @@
The installation Dialog will ask you where it should install GREATER and
it's components. The default is:
"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}" all
-Greater Data will be placed into this directory.
+Greater Data will be placed into this directory.\\
+After selecting the Installation location and \GREATER\ Shortcut options
+you can start the installation. Depending on the selection of your components
+this can take some minutes.
+
\newpage
\section{Configuration}
+\subsection{Firewall access}
+Depending on your Firewall setup you might be asked on the first start
+of \GREATER to allow firewall access to \"pythonw.exe\". The settings you set
+there will determine who is able to connect to your simulation Server.
+If you allow it other systems in your network will be able to run
+simulations on your system.
+
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/firewall.png}}{
+ Installation with only the standard desktop client.}
+\end{center}
+
\subsection{Automatic Authentication}
You can use \GREATER\ to automatically authenticate to a database when it
is started. This can be useful for local installations where security
@@ -239,11 +256,11 @@
\begin{center}
username/password@<database\_connect\_string> \\
-Example: "mpowers/Ietoye8e at 192.168.10.50:5423" \\
+Example: "mpowers/Ietoye8e at greater" \\
\end{center}
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/config1.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config1.png}}{
Automatic Authentication settings}
\end{center}
@@ -260,49 +277,68 @@
If you want to run it on a dedicated system you have to configure
the database for remote access.
\begin{center}
-\emph{Setting up PosgreSQL for remote access opens your system
-make sure that you use secure passwords.}
+\emph{Setting up PosgreSQL for remote access allows connections to your
+database and can make your system vulnerable!\\
+Please make sure that you use secure passwords.}
\end{center}
To configure your database it is recommended that you use pgadmin3
which is installed by the \GREATER\ PostgreSQL component.
-You can find this application under \textit{<INSTALLDIR>\\postgres9\\bin\\pgAdmin3.exe}
-or when Shortcuts were installed in your \GREATER\ Start Menu folder.
+You can find this application under:\\
+\textit{c:\textbackslash Program Files\textbackslash GREAT-ER \textbackslash
+postgres9\textbackslash bin\textbackslash pgAdmin3.exe}
When launching pgAdminIII you will see one Server (localhost:5432)
to which you can connect by double-clicking on its Icon.
The default password for the user \emph{greater} is \textit{greater}.
+\begin{center}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config4.png}}{
+ PostgreSQL Connect to Server}
+\end{center}
+
To change the password to something secure. Use the
\"File->Change Password\" menu option.
To modify the connection settings for your database you can edit the
Server configuration by choosing \"Tools->Server Configuration->pg\_hba.conf\"
-and change the field \"IP-Address\" from 127.0.0.1/32 to all.
-There are also options to finely configure access rights for just some users
-or Databases, please refer to the PostgreSQL Documentation\footnote{\tt
-http://www.postgresql.org/docs/9.0/static} for more information.
+and add an entry with the field \"IP-Address\" set to the Network where you
+you want to accept connections from and restart the server afterwards.
+
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/config2.eps}}{
- PostgreSQL connection settings}
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config2.png}}{
+ Configure PostgreSQL to accept logins on 192.168.0.0/24 }
\end{center}
+There are of course multiple options to configure access rights and connections
+with PostgreSQL. Please refer to the PostgreSQL Documentation\footnote{\tt
+http://www.postgresql.org/docs/9.0/static} for more information on how
+to administrate your Database.
+
\subsection{Simulation server setup}
\GREATER\ has the ability to remotely run simulation calculations.
To run a remote simulation you have to launch the client on the server
and connect it to a database. Once it is connected to a database it will
-accept TCP connections on port TODO if your firewall rules
+accept TCP connections on port {\bf 10101} if your firewall rules
allow it.
-On the client system you can select \"Simulation -> Select Simulation Server\"
+On the client system you can select "Simulation -> Select Simulation Server"
from the menu to connect to a simulation server on a another machine.
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/config3.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/config3.png}}{
Simulation server connection settings}
\end{center}
-\newpage
+\subsection{Connect to a remote database}
+In the authentication dialog the format to describe a remote database
+connection is: databasename at ip:port \\
+
+For example:\\
+{\bf greater-sediment at 192.168.0.2:5432}\\
+Would open a connection to the database greater-sediment accepting
+connections on port 5432 with the ip-address 192.168.0.2
+
\chapter{Uninstallation on Microsoft Windows}
To Uninstall \GREATER\ you can either use the Microsoft Windows Software
(Programs and Functions on Windows Vista/7) Menu or run the \"Uninstall.exe\"
@@ -315,28 +351,26 @@
{\bf Warning:} This will remove all you local modified data saved sessions and catchments!
\begin{center}
-\Fig{\includegraphics[scale=\imagescale]{screenshots/uninstall1.eps}}{
+\Fig{\includegraphics[scale=\imagescale]{screenshots/uninstall1.png}}{
Uninstallation Options.}
\end{center}
-\newpage
\section{Database Setup}
The default database setup after installation includes two databases.
\begin{center}
-\begin{tabular}{|c|c|c|c|}
+\begin{tabular}{|c|c|c|}
\hline
-Database Name & Default Username & Default Password & Comment \\
+Database Name & Default Username & Default Password \\
\hline
-greater & greater & greater & The standard database with default catchments\\
+greater & greater & greater \\
\hline
-greater-sediment & greater & greater & Extended Database with parameters for the sediment extension\\
+greater-sediment & greater & greater \\
\hline
\end{tabular}
\end{center}
-\newpage
\renewcommand{\documentID}{gnufdl.tex version 1.2}
\include{gnufdl}
\renewcommand{\documentID}{\CVSId}
More information about the Greater-commits
mailing list