%
% apcupsd-cgi.tex
% Last update: $Id$
%
%%%%%%%%%%%%%%%%%%%%%%%%%%% Kapitel Apcupsd-CGI %%%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{Apcupsd-CGI - UPS Monitor}
\index{APCUPSD-CGI}
\marklabel{apcupsdcgi}{}

\section{Die Einleitung}

    \glqq{}Apcupsd-CGI\grqq{} stellt eine WebOberfl"ache f"ur Apcupsd
    Monitoring bereit.

    Erforderlich ist daf"ur das \eisfair Paket Apache2.

\section{Der Webzugriff}

    Das \eisfair Apcupsd-CGI Paket l"asst sich auf verschiedene Arten zur
    Benutzung konfigurieren.


    Der Zugriff kann "uber eine Subdomain \

    \texttt{http\{s\}://apcupsd.meine.de} \\


    oder in eine bestehende Domain \

    \texttt{http\{s\}://www.meine.de/apcupsd} \\


    erfolgen. Es ist auch beides gleichzeitig m"oglich, also "uber die
    Subdomain und in der bestehenden Domain.

    Der https Zugriff f"ur die Subdomain wird "uber die \eisfair Apcupsd-CGI
    Konfiguration eingestellt, f"ur den https Zugriff in der bestehenden Domain
    muss das SSL Zertifikat von der Domain bereitgestellt werden.

    In der Konfiguration des Apache WebServers m"ussen keine Parameter
    Einstellungen vorgenommen werden.


\section{Das Men"u im Setup-Programm}

    Das Men"u im Setup-Programm ist wie folgt aufgebaut:

    \mbox{}

    \begin{tabular}{lll}
    & x. & Service administration \\
    \end{tabular}
\eline
    \begin{tabular}{p{1cm}lll}
    & x. & Apcupsd \\
    \end{tabular}
\eline
    \begin{tabular}{p{2cm}lll}
    & x. & Apcupsd web monitoring \\
    \end{tabular}
\eline
    \begin{tabular}{p{3cm}lll}
    & 1. & View documentation \\
    & 2. & Edit configuration \\
    & 3. & Advanced configuration file handling \\
    & 4. & Logfile view (hat nur Inhalt bei Subdomain) \\
    & 5. & \jump{APCUPSDCGIWEBACCESS}{User handling for web access} \\
    \end{tabular}

    \mbox{}


\section{Die "Anderung der Konfiguration}

    Die Konfiguration wird "uber den Men"upunkt \glqq{}Edit
    configuration\grqq{} ge"andert.

\section{Die Konfigurationsdatei}

    In der Konfigurationsdatei, die "uber das Men"u zug"anglich ist, sind
    folgende Parameter vorhanden; wer sie von Hand editieren will, findet
    sie unter \\
    \texttt{/etc/config.d/apcupsd-cgi}.



\subsection{Allgemeine Einstellungen}


\begin{description}

\config{START\_APCUPSD\_CGI}
{START\_APCUPSD\_CGI}
{STARTAPCUPSDCGI}
{
    F"ur die Aktivierung des Apcupsd-CGI muss diese Variable
    lediglich auf den Wert \glqq{}yes\grqq{} gestellt werden. Die Einstellung
    \glqq{}no\grqq{} schaltet Apcupsd-CGI ab.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{START\_APCUPSD\_CGI='no'}
}

\end{description}


\subsection{Einstellungen f"ur eine Subdomain}


\begin{description}

\config{APCUPSD\_CGI\_SUBDOMAIN}
{APCUPSD\_CGI\_SUBDOMAIN}
{APCUPSDCGISUBDOMAIN}
{
    Hier wird angegeben, ob Apcupsd-CGI in einer Subdomain
    ausgef"uhrt werden soll. (apcupsd.meine.de)

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN='no'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_NAME}
{APCUPSD\_CGI\_SUBDOMAIN\_NAME}
{APCUPSDCGISUBDOMAINNAME}
{
    Hier wird der Komplette Name der Domain eingegeben

    Beispiel: \pfeil  \{http\{s\}://\}apcupsd.meine.de

    G"ultige Werte: Qualifizierter Domain Name

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_NAME='{}'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_PORT}
{APCUPSD\_CGI\_SUBDOMAIN\_PORT}
{APCUPSDCGISUBDOMAINPORT}
{
    Hier wird der Port f"ur die HTTP Verbindung eingegeben.

    G"ultige Werte: Port

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_PORT='80'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_ADMIN}
{APCUPSD\_CGI\_SUBDOMAIN\_ADMIN}
{APCUPSDCGISUBDOMAINADMIN}
{
    Hier wir die Mail Adresse des Server Admin angegeben

    G"ultige Werte: Mail Adresse

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_ADMIN='{}'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_FORCE\_SSL}
{APCUPSD\_CGI\_SUBDOMAIN\_FORCE\_SSL}
{APCUPSDCGISUBDOMAINFORCESSL}
{
    Soll der Zugriff immer mit https erfolgen.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_FORCE\_SSL='no'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_PORT}
{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_PORT}
{APCUPSDCGISUBDOMAINSSLPORT}
{
    Hier wird der Port f"ur die HTTPS Verbindung eingegeben.

    G"ultige Werte: Port

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_PORT='443'}
}


\config{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_CERT}
{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_CERT}
{APCUPSDCGISUBDOMAINSSLCERT}
{
    Hier wird das Server Zertifikat f"ur die SSL Verbindung angegeben.

    In der Konfiguration des Certs und Certs\_dehydrated Pakets m"ussen
    keine Parameter Einstellungen vorgenommen werden.

    G"ultige Werte: Zertifikat

    Standardeinstellung: \texttt{APCUPSD\_CGI\_SUBDOMAIN\_SSL\_CERT='{}'}
}

\end{description}


\subsection{Einstellungen f"ur einen Host}


\begin{description}

\config{APCUPSD\_CGI\_HOST}
{APCUPSD\_CGI\_HOST}
{APCUPSDCGIHOST}
{
    Hier wird angegeben, ob Apcupsd-CGI in einem Host ausgef"uhrt
    werden soll. \\
    (www.meine.de/apsupsd)

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST='yes'}
}


\config{APCUPSD\_CGI\_HOST\_NAME}
{APCUPSD\_CGI\_HOST\_NAME}
{APCUPSDCGIHOSTNAME}
{
    Hier wird der Host(Servername) angegeben, in dem Apsupsd-CGI
    ausgef"uhrt werden soll. Im Normalfall ist dies der APACHE2\_SERVER\_NAME.

    G"ultige Werte: Servername

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_NAME='APACHE2\_SERVER\_NAME'}
}


\config{APCUPSD\_CGI\_HOST\_ALIAS}
{APCUPSD\_CGI\_HOST\_ALIAS}
{APCUPSDCGIHOSTALIAS}
{
    Hier wird der Alias angegeben, "uber den Apcupsd-CGI angesprochen
    werden soll.

    Beispiel: \pfeil  \{http\{s\}://\}www.meine.de/apcupsd

    G"ultige Werte: jeder g"ultige Name

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_ALIAS='apcupsd'}
}


\config{APCUPSD\_CGI\_HOST\_FORCE\_SSL}
{APCUPSD\_CGI\_HOST\_FORCE\_SSL}
{APCUPSDCGIHOSTFORCESSL}
{
    Soll der Zugriff immer mit https erfolgen.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_FORCE\_SSL='no'}
}

\end{description}


\subsection{Einstellungen f"ur die Anmeldung}


\begin{description}

\marklabel{APCUPSDCGIWEBACCESS}{}
\config{APCUPSD\_CGI\_ACCESS\_ALL}
{APCUPSD\_CGI\_ACCESS\_ALL}
{APCUPSDCGIACCESSALL}
{
    Hier ist der Zugriff f"ur alle erlaubt, Weltweit.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_ALL='no'}
}


\config{APCUPSD\_CGI\_ACCESS\_AUTH}
{APCUPSD\_CGI\_ACCESS\_AUTH}
{APCUPSDCGIACCESSAUTH}
{
    Hier ist der Zugriff mit Benutzername und Passwort erlaubt.
    Benutzer m"ussen daf"ur "uber den Men"upunkt
    \glqq{}User handling for web access\grqq{} in der Apcupsd-CGI
    administration ein Passwort erhalten.

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_AUTH='no'}
}


\config{APCUPSD\_CGI\_ACCESS\_AUTH\_SEND\_MAIL\_FROM}
{APCUPSD\_CGI\_ACCESS\_AUTH\_SEND\_MAIL\_FROM}
{APCUPSDCGIACCESSAUTHSENDMAILFROM}
{
    Bei der Einstellung \texttt{APCUPSD\_CGI\_ACCESS\_AUTH} muss
    hier eine Mail Adresse angeben werden, die als Absender benutzt
    werden soll. Bleibt sie leer wird keine Mail versandt

    G"ultige Werte: leer, Mail Adresse

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_AUTH\_SEND\_MAIL\_FROM='{}'}
}


\config{APCUPSD\_CGI\_ACCESS\_HOST}
{APCUPSD\_CGI\_ACCESS\_HOST}
{APCUPSDCGIACCESSHOST}
{
    Hier ist der Zugriff mit Hostname erlaubt.
    Es d"urfen mehrere durch ein Leerzeichen getrennt angegeben
    werden.

    G"ultige Werte: Hostname, Domain

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_HOST='{}'}
}


\config{APCUPSD\_CGI\_ACCESS\_IP}
{APCUPSD\_CGI\_ACCESS\_IP}
{APCUPSDCGIACCESSIP}
{
    Hier ist der Zugriff von der IP Adresse erlaubt.
    Es d"urfen mehrere durch ein Leerzeichen getrennt angegeben
    werden.

    Beispiel: 10 192.168.6 192.168.6.1 192.168.6.0/24

    G"ultige Werte: IP Adresse

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_IP='{}'}
}


\config{APCUPSD\_CGI\_ACCESS\_LOCAL}
{APCUPSD\_CGI\_ACCESS\_LOCAL}
{APCUPSDCGIACCESSLOCAL}
{
    Hier ist der Zugriff nur local erlaubt.

    \hinweis{Diese Einstellung l"asst sich nicht mit anderen Methoden kombinieren.}

    G"ultige Werte: yes, no

    Standardeinstellung: \texttt{APCUPSD\_CGI\_ACCESS\_LOCAL='yes'}
}

\end{description}


\subsection{Die Einstellungen f"ur den "uberwachten Host}


\begin{description}

\config{APCUPSD\_CGI\_HOST\_N}
{APCUPSD\_CGI\_HOST\_N}
{APCUPSDCGIHOSTN}
{
    Hier wird die Anzahl der per Apcupsd-CGI zu bedienenden Server
    eingestellt.

    G"ultige Werte: Zahl

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_N='1'}
}


\config{APCUPSD\_CGI\_HOST\_x\_ADDRESS}
{APCUPSD\_CGI\_HOST\_x\_ADDRESS}
{APCUPSDCGIHOSTxADDRESS}
{
    IP-Adresse oder Hostname des zu "uberwachenden Apcupsd Rechners.

    G"ultige Werte: keine Einschr"ankung

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_x\_ADDRESS='127.0.0.1'}
}


\config{APCUPSD\_CGI\_HOST\_x\_DESCRIPTION}
{APCUPSD\_CGI\_HOST\_x\_DESCRIPTION}
{APCUPSDCGIHOSTSERVERxDESCRIPTION}
{
    Eine Beschreibung f"ur den Auswahl Dialog.

    G"ultige Werte: keine Einschr"ankung

    Standardeinstellung: \texttt{APCUPSD\_CGI\_HOST\_x\_DESCRIPTION='localhost'}
}

\end{description}
