%
% partimage.tex
% Last Update: $Id$
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Kapitel PartImage %%%%%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{Das PartImage-Paket}

\section{Die Einleitung}

    Dieser Paket erm"oglicht es, mittels des nicht enthaltenen Client-Programms mit
    Namen `PartImage', Partitionen "uber das Netzwerk auf einem \eisfair-Server zu
    sichern bzw. wieder von diesem zu restaurieren. Hierdurch entf"allt der m"uhsame
    Weg ein externes Sicherungsmedium, wie z.B. eine USB-Festplatte, verwenden zu
    m"ussen.


\section{Die Funktionen}

    Das PartImage-Paket besteht aus folgenden Komponenten:

    \begin{itemize}
        \item PartImage - Stellt die Software-Komponenten des Backup-Paketes
              zur Verf"ugung.\\
              (\url{http://www.partimage.org/})
    \end{itemize}


\section{Die Voraussetzungen}

    Dieses Paket ben"otigt zur korrekten Funktion ein installiertes Certs-Paket
    wenn eine SSL-Verbindung zum Server aufgebaut werden soll.


\section{Die Installation}

    Das PartImage-Paket wird "uber das Setup-Men"u installiert. Wird eine
    "altere Paketversion vorgefunden, so wird diese deinstalliert bevor die
    neuen Programmdateien installiert werden. Nach dem Installieren der
    Programmdateien wird direkt der Konfigurations-Editor gestartet um die
    Konfiguration anzupassen. Nach Beendigung dieses Schrittes werden die
    Konfigurationsdateien generiert und alle ben"otigten Programme gestartet.


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

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

    \begin{itemize}
        \item PartImage-Configuration
        \begin{itemize}
            \item View documentation: Anzeigen der Dokumentation
            \item Edit configuration: Bearbeiten der Konfiguration
            \item Advanced configuration file handling: Konfigurationen verwalten
            \item Show status: Status des PartImage-Servers anzeigen
            \item Start service: Starten des PartImage-Servers
            \item Stop service: Stoppen PartImage-Servers
            \item Restart service: Neustarten des PartImage-Servers
            \item Recommend client connect string: PartImage-Client-Aufruf zeigen
            \item View Logfile: Logdatei anzeigen
            \item Return: Untermen"u verlassen
        \end{itemize}
    \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 "Anderung der Konfiguration}

    Die Konfiguration kann "uber den Men"upunkt `Edit configuration'
    ge"andert werden. Standardm"a"sig wird der Editor aufgerufen, der in
    der Environment-Konfiguration "uber die Variable `EDITOR' festgelegt
    wurde. Nachdem der Editor beendet wurde wird abgefragt, ob die
    Konfiguration aktiviert werden soll. Wird dies best"atigt, werden "uber
    ein Skript die Anpassungen umgehend wirksam gemacht.


\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/partimg.


\section{Die Parameter}

\begin{description}
    \config{START\_PARTIMG}{START\_PARTIMG}{STARTPARTIMG}
        Zur Aktivierung des PartImage-Programms muss dieser Parameter
        lediglich auf den Wert `yes' gestellt werden. Die Einstellung
        `no' deaktiviert das Programm.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{START\_PARTIMG='no'}

    \config{PARTIMG\_WORK\_PATH}{PARTIMG\_WORK\_PATH}{PARTIMGWORKPATH}
        "Uber diesen Parameter wird das Verzeichnis angegeben in
        welchem die Image-Dateien gespeichert werden sollen.

        G"ultige Werte: Absoluter Verzeichnispfad

        Standardeinstellung: \texttt{PARTIMG\_WORK\_PATH='/public'}

    \config{PARTIMG\_USER\_AUTH}{PARTIMG\_USER\_AUTH}{PARTIMGUSERAUTH}
        Wird der Wert dieses Parameters auf `yes' gesetzt, so ist eine
        Authentifizierung f"ur den Serverzugriff erforderlich. Der
        Wert `no' deaktiviert die Serverauthentifizierung.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{PARTIMG\_USER\_AUTH='yes'}

    \config{PARTIMG\_USER\_N}{PARTIMG\_USER\_N}{PARTIMGUSERN}
        "Uber diesen Parameter wird die Anzahl der Accounts angegeben,
        die f"ur den PartImage Serverzugriff eingerichtet werden sollen.

        G"ultige Werte: Zahl

        Standardeinstellung: \texttt{PARTIMG\_USER\_N='1'}

    \config{PARTIMG\_USER\_x\_ACTIVE}{PARTIMG\_USER\_x\_ACTIVE}{PARTIMGUSERxACTIVE}
        Wird dieser Parameter auf den Wert `yes' gesetzt, so wird der
        zugeh"orige Datensatz aktiviert, `no' deaktiviert ihn.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{PARTIMG\_USER\_1\_ACTIVE='no'}

    \index{PARTIMG\_USER\_x\_PASS}
    \config{PARTIMG\_USER\_x\_NAME / PARTIMG\_USER\_x\_PASS}{PARTIMG\_USER\_x\_NAME}{PARTIMGUSERxNAME}
        "Uber diese Parameter wird ein Loginname und ein Kennwort
        f"ur den Serverzugriff festgelegt.\\
        \achtung{Unbedingt Klein- / Gro"sschreibung beachten!}

        G"ultige Werte: Username bzw.  Kennwort

        Beispiel:

        \texttt{PARTIMG\_USER\_1\_NAME='username'} \\
        \texttt{PARTIMG\_USER\_1\_PASS='geheim'}

    \config{PARTIMG\_SSL\_TRANSPORT}{PARTIMG\_SSL\_TRANSPORT}{PARTIMGSSLTRANSPORT}
        "Uber diesen Parameter wird festgelegt, ob ein Serverzugriff
        nur "uber SSL-verschl"usselte Verbindung erm"oglicht werden
        soll oder nicht.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{PARTIMG\_SSL\_TRANSPORT='no'}

    \config{PARTIMG\_SSL\_CERT\_FILE}{PARTIMG\_SSL\_CERT\_FILE}{PARTIMGSSLCERTFILE}
        "Uber diesen Parameter wird der Name der Zertifikatsdatei
        angegeben, welche f"ur die Serveridentifikation genutzt werden
        soll. Falls noch kein Zertifikat angelegt wurde, so sollte man
        dies "uber das Certs-Paket nachholen.

        G"ultige Werte: Zertifikatsdatei

        Standardeinstellung: \texttt{PARTIMG\_SSL\_CERT\_FILE=$''$}

    \config{PARTIMG\_SSL\_KEY\_FILE}{PARTIMG\_SSL\_KEY\_FILE}{PARTIMGSSLKEYFILE}
        "Uber diesen Parameter wird der Name des Zertifikatsschl"ussels
        angegeben, welche f"ur die Serveridentifikation genutzt werden
        soll. Falls noch kein Zertifkatsschl"ussel angelegt wurde, so
        sollte man dies "uber das Certs-Paket nachholen.

        G"ultige Werte: Zertifikatsschl"ussel

        Standardeinstellung: \texttt{PARTIMG\_SSL\_KEY\_FILE=$''$}
\end{description}
