%
% mini_httpd_wolsol.tex
% Last Update: $Id: apache2_webalizer.tex 48100 2017-12-22 08:26:10Z hbfl $
%
%%%%%%%%%%%%%%%%%%%%%%% Kapitel Mini_httpd_wolsol %%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{Das Mini\_HTTPD\_WoLSoL-Paket}

    Das Mini\_HTTPD\_WoLSoL-Paket erzeugt eine simple Web-Oberfl"ache,
    die es innerhalb des Mini\_HTTPD-Service erm"oglicht Rechner "uber
    das Netzwerk einzuschalten (WOL - Wake on LAN), ausschalten (SOL -
    Stop on LAN) sowie Statusmittlung abzufragen.


\section{Die Installation}

    Das Mini\_HTTPD\_WoLSoL-Paket wird "uber das Setup-Men"u installiert.
    Wird eine "altere Paketversion vorgefunden, so wird diese deinstalliert
    bevor die neuen Programmdateien installiert werden.


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

    Das Mini\_HTTPD\_WoLSoL-Modulmen"u im Setup-Programm ist wie folgt
    aufgebaut:

    \begin{itemize}
        \item ...
        \item Goto modules: Zum Modulmen"u verzweigen
        \begin{itemize}
            \item ...
            \item WoLSoL - Wake and Shutdown on LAN
            \begin{itemize}
                \item View documentation: Anzeigen der Dokumentation
                \item Edit configuration: Bearbeiten der Konfiguration
                \item Advanced configuration file handling: Konfigurationen verwalten
                \item Exit: Untermen"u verlassen
            \end{itemize}
        \end{itemize}
        \item ...
        \item Exit: Untermen"u verlassen
    \end{itemize}

    Die Men"upunkte d"urften selbsterkl"arend sein, da sie keinerlei weitere
    Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter
    eingegangen.


\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 /etc/config.d/mini\_httpd\_wolsol.


\section{Die Parameter}

\begin{description}
    \config{START\_WOLSOL}{START\_WOLSOL}{STARTWOLSOL}
        "Uber diesen Parameter wird das WoLSoL-Paket durch Setzen des
        Wertes `yes' aktiviert, der Wert `no' deaktiviert es.

        G"ultige Werte: yes, no

        Standardwert: \texttt{START\_WOLSOL='no'}

    \config{WOLSOL\_N}{WOLSOL\_N}{WOLSOLN}
        "Uber diesen Parameter wird die Anzahl der Rechner angegeben, die
        WoLSoL ber"ucksichtigen soll.

        G"ultige Werte: Zahl

        Standardwert: \texttt{WOLSOL\_N='1'}

    \config{WOLSOL\_x\_ACTIVE}{WOLSOL\_x\_ACTIVE}{WOLSOLxACTIVE}
        "Uber diesen Parameter wird durch Setzen des Wertes `yes' eine
        Rechnerkonfiguration aktiviert, der Wert `no' deaktiviert sie.

        G"ultige Werte: yes, no

        Standardwert: \texttt{WOLSOL\_1\_ACTIVE='no'}

    \config{WOLSOL\_x\_NAME}{WOLSOL\_x\_NAME}{WOLSOLxNAME}
        "Uber diesen Parameter legt man einen eindeutiger Namen f"ur
        die Rechnerkonfiguration fest.

        G"ultige Werte: Text

        Beispiel: \texttt{WOLSOL\_1\_NAME='LinVDR'}

    \config{WOLSOL\_x\_DEVICE}{WOLSOL\_x\_DEVICE}{WOLSOLxDEVICE}
        "Uber diesen Parameter legt man auf Wunsch einen vom Standard
        abweichenden Netzwerkger"atenamen fest. Wird dieser Parameter
        nicht gesetzt, so wird standardm"a"sig `eth0' verwendet.

        G"ultige Werte: Netzwerkger"atenamen

        Standardwert: \texttt{WOLSOL\_1\_DEVICE=''}

    \config{WOLSOL\_x\_IPADDR}{WOLSOL\_x\_IPADDR}{WOLSOLxIPADDR}
        "Uber diesen Parameter gibt man die IP-Adresse des Rechners an,
        "uber welche er per Ping-Befehl antwortet.

        G"ultige Werte: IP-Adresse

        Beispiel: \texttt{WOLSOL\_1\_IPADDR='192.168.2.100'}

    \config{WOLSOL\_x\_WOL\_MAC}{WOLSOL\_x\_WOL\_MAC}{WOLSOLxWOLMAC}
        "Uber diesen Parameter legt man die MAC-Adresse des aufzuweckenden
        Rechners an. Die MAC-Adresse kann mit Hilfe des arping-Befehls
        ermittelt werden.

        G"ultige Werte: MAC-Adresse

        Beispiel: \texttt{WOLSOL\_1\_WOL\_MAC='00:04:75:D3:00:B8'}

    \config{WOLSOL\_x\_SOL\_CMD}{WOLSOL\_x\_SOL\_CMD}{WOLSOLxWOLSOLCMD}
        "Uber diesen Parameter kann man einen Shutdown-Befehl festlegen.
        Optional lassen sich folgende Parameter in die Befehlsfolge
        einf"ugen und durch die entsprechenden Werte ersetzen:

        \begin{itemize}
            \item \{name\}    - Der "uber WOLSOL\_x\_NAME definierten Name.
            \item \{ipaddr\}  - Die "uber WOLSOL\_x\_IPADDR definierte IP-Adresse.
            \item \{wolmac\}  - Die "uber WOLSOL\_x\_WOL\_MAC definierte MAC-Adresse.
            \item \{solpass\} - Das vor der Befehlsausf"uhrung abzufragende Kennwort.
        \end{itemize}

        Beispiel:\\
        \texttt{WOLSOL\_1\_SOL\_CMD='/bin/ssh root@\{ipaddr\} /sbin/poweroff'\\
                WOLSOL\_2\_SOL\_CMD='net rpc shutdown -I my-pc.privat.lan\\
                \hspace*{10eM} -U "MY-DOM/my-login\%\{solpass\}'}
\end{description}


    "Uber die Parameter WOLSOL\_LINK\_x\_.. k"onnen HTML-Verweise f"ur die
    Mini\_HTTPD-Webseite generiert werden, "uber welche ein schneller Zugriff
    auf die Rechnerkonfigurationen erm"oglicht wird.

\begin{description}
    \config{WOLSOL\_LINK\_N}{WOLSOL\_LINK\_N}{WOLSOLLINKN}
        "Uber diesen Parameter legt man den Anzahl der anzulegenden
        Verweise auf der Mini\_HTTPD-Webseite fest.

        G"ultige Werte: Zahl

        Standardwert: \texttt{WOLSOL\_LINK\_N='1'}

    \config{WOLSOL\_LINK\_x\_ACTIVE}{WOLSOL\_LINK\_x\_ACTIVE}{WOLSOLLINKxACTIVE}
        "Uber diesen Parameter wird der Verweis durch Setzen des Wertes
        `yes' aktiviert, der Wert `no' deaktiviert ihn.

        G"ultige Werte: yes, no

        Standardwert: \texttt{WOLSOL\_LINK\_1\_ACTIVE='no'}

    \config{WOLSOL\_LINK\_x\_NAME}{WOLSOL\_LINK\_x\_NAME}{WOLSOLLINKxNAME}
        "Uber diesen Parameter legt man den eindeutigen Verweisnamen fest
        welcher auf der Mini\_HTTPD-Webseite angezeigt werden soll.

        G"ultige Werte: Text

        Beispiel: \texttt{WOLSOL\_LINK\_1\_NAME='Homepage des WoLSoL-Paketes'}

    \config{WOLSOL\_LINK\_x\_TARGET}{WOLSOL\_LINK\_x\_TARGET}{WOLSOLLINKxTARGET}
        "Uber diesen Parameter wird das Zielfenster f"ur den Verweis
        festgelegt. Folgende Schl"usselw"orter haben hierbei eine
        gesonderte Bedeutung:

        \begin{itemize}
            \item \_blank  - Der Verweis wird in einem neuen Fenster ge"offnet.
            \item \_self   - Der Verweis wird im aktuellen Fenster ge"offnet.
            \item \_parent - Der Verweis sprengt bei verschachtelten Framesets das
                             aktuelle Frameset.
            \item \_top    - Der Verweis sprengt bei verschachtelten Framesets alle
                             Framesets.
        \end{itemize}

        Standardwert: \texttt{WOLSOL\_LINK\_1\_TARGET='\_blank'}

    \config{WOLSOL\_LINK\_x\_HREF}{WOLSOL\_LINK\_x\_HREF}{WOLSOLLINKxHREF}
        "Uber diesen Parameter wird die Referenz-URL angegeben.

        G"ultige Werte: URL

        Beispiel: \texttt{WOLSOL\_LINK\_1\_HREF='https://www.pack-eis.de/?p=mini\_httpd\_wolsol'}
\end{description}


\section{"Ubersicht der Verweise auf der Webseite}

    \begin{itemize}
        \item VIEW   - Der View-Verweis erlaubt die Anzeige der
                       WoLSoL-Einstellungen f"ur diesen Rechner.
        \item ON     - Der On-Verweis f"uhrt das Kommando `ether-wake
                       00:...' aus und schaltet den Rechner ein.
        \item OFF    - Der Off-Verweis f"uhrt das "uber den Parameter
                       WOLSOL\_x\_SOL\_CMD definierte Kommando aus und
                       schaltet den Rechner ab.
        \item STATUS - Setzt das Kommando \begin{verbatim}"/sbin/arping -f -c 1 -w 5 <ip-adresse>" \end{verbatim}
                       ab und zeigt das Resultat an. Arping gibt auch
                       die MAC-Adresse des Rechners aus, dem die
                       IP-Adresse zugewiesen wurde.
    \end{itemize}
