Die Dokumentation zum webconf-Paket




Version 0.4.0




Christian Würdig
eisfair@chriswue.de




Inhalt

Einleitung

Webconf soll einmal die Administration von eisfair per Browser ermöglichen und die komplette Funktionalität des derzeitigen Setup-Menüs bieten.

Funktionen

Was funktioniert:

Was fehlt noch:

Voraussetzungen

Folgende Pakete müssen installiert sein:

Installation

Nach der Installation ist auf jeden Fall der Menüpunkt `Change basic authentification for webconf' auszuführen. Damit wird die Datei .htpasswd neu geschrieben, so daß man sich einloggen kann (falls jemand das voreingestellte Passwort errät braucht er das natürlich nicht zu ändern :). Danach ist der Service mit dem Browser unter https://server:$WEBCONF_PORT erreichbar (das `s' bei https ist wichtig!). Desweiteren ist zu beachten, daß die Variable START_WEBNCONF='yes' ist.

Das Menü im Setup-Programm

View documentation
Öffnet die Dokumentation.

View developer documentation
Öffnet die Entwickler-Dokumentation.

Show status
Zeigt den aktuellen Status[*] des Dienstes an.

Stop webconf
Stoppt den Dienst[*].

Start webconf
Startet den Dienst[*].

Edit and apply config
Hiermit kann man die Konfigurationsdatei editieren und die Einstellungen übernehmen lassen.

Change basic authentification for webconf
Der Zugang zur Administrationsoberfläche wird über .htpasswd-Dateien geregelt. Mit diesem Menüpunkt kann man Login und Passwort neu einstellen.

Create new certificate for webconf
Das SSL-Zertifikat wird bei der Installation aus Standardwerten erzeugt. Hier hat man die Möglichkeit sich ein neues zu erzeugen mit eigenen Angaben.

Änderungen der Konfiguration

Die Konfiguration kann über den Menüpunkt `Edit and apply config' geändert werden. Standardmäßig wird der Editor `joe' aufgerufen, falls kein anderer in der Umgebungsvariable `EDITOR' auf dem System eingestellt ist. Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestätigt, werden über ein Skript die Änderungen umgehend wirksam gemacht.

Die Konfigurationsdatei

START_WEBCONF
Falls hier `yes' eingetragen wird, dann wird der Server (mini_httpd) beim Booten mit gestartet. Bei `no' ist die Konfiguration über Browser dementsprechend nicht möglich.

Gültige Werte: yes, no

WEBCONF_PORT
Legt fest, auf welchem Port der Dienst erreichbar sein soll (Standard: 3001).

Gültige: Zahl von 1-65535

WEBCONF_CSS
Gibt den Namen des Stylesheets an, das zur Gestaltung verwendet werden soll. Es wird relativ zu /usr/local/webconf/CSS gesucht. Der Name muß ohne die Endung .css angegeben werden. Falls zu dem Stylesheet noch mehr Dateien gehören, dann befinden sich alle Daten in einem Verzeichnis und es muß der Name dieses Verzeichnisses angegeben werden. Es wird ebenfalls relativ zu /usr/local/webconf/CSS gesucht. Falls nichts gefunden wird, dann wird das Standard CSS verwendet.

Gültige Werte: releativer Dateiname

Die Weboberfläche

Package administration

Noch nicht implementiert.

Service administration

Nach dem Klick auf den Punkt `Service administration' wird eine Liste der Dienste, angezeigt, die eine Unterstützung für webconf implementiert haben. Jetzt wählt man durch Klick auf den entsprechenden Link einen Dienst aus und es wird ein Menü für die Einstellmöglichkeiten ähnlich wie im `setup' aufgebaut.

Anzeigen der Dokumentation

Die Dokumentation kann man sich in der Regel über den Punkt `View documentation' anzeigen lassen. Es gibt hier nichts Besonderes zu beachten. Am Ende der Dokumentation finden sich zwei Links: `return to Servicemenu', damit kann man in die Übersicht der Dienste zurückkehren und `return to Mainmenu', damit kann man in das Hauptmenü zurückkehren.

Editieren der Konfigurationsdatei

Unter dem Link `Edit configuration' kann man das Formular zum Editieren der Konfigurationsdatei erreichen. Nachdem man die gewünschten Werte eingetragen/geändert hat, dann muß man auf den Button `update' klicken, der sich am Ende des Formulars befindet. Dann erscheint entweder im unteren Frame bzw. in einem neuen Fenster[*] die Frage `Reload or Apply'. `Reload' ist für Variablen wie `ETH_DRV_N' gedacht. Wenn man dort eine größere Zahl eingibt, dann erscheinen die neuen Eingabefelder nicht automatisch, sondern man muß das Formular neu erzeugen, damit diese Felder erreichbar werden. Dies geschieht mit `Reload'. Wenn alle Felder im Formular wie gewünscht ausgefüllt sind, dann kann man per Klick auf `Apply' die Werte übernehmen lassen. Dabei wird eine Syntaxüberprüfung der Eingaben durchgeführt. Falls es dabei zu einem Fehler kommt, wird er angezeigt und die Werte werden nicht übernommen.



Achtung:
Wenn man neue Eingaben im Formular vorgenommen hat, dann sind diese erst per Klick auf `update' zu aktualisieren und erst dann ist `Reload' oder `Apply' zu wählen. Sonst kommt es zu einem Fehler.

Am Ende des Formulars finden sich zwei Links: `return to Servicemenu', damit kann man in die Übersicht der Dienste zurückkehren und `return to Mainmenu', damit kann man in das Hauptmenü zurückkehren.

Administrieren des Dienstes

Die Funktionen des Dienstes lassen sich über die entsprechend beschrifteten Links des Menüs erreichen. Dabei wird wieder ein Formular erzeugt, in dem die gewünschten Eingaben vorzunehmen sind und das Formular anschließend per Button abzuschicken ist. Die konkrete Beschreibung zu den einzelnen Funktionen ist der Dokumentation des entsprechenden Paketes zu entnehmen. Die Funktionen sind in der Regel die gleichen wie im `setup'. Am Ende des Formulars finden sich zwei Links: `return to Servicemenu', damit kann man in die Übersicht der Dienste zurückkehren und `return to Mainmenu', damit kann man in das Hauptmenü zurückkehren.

User administration

Noch nicht implementiert.

About

Die Originalsourcen des Webservers sind hier zu finden: http://www.acme.com/software/mini_httpd/

Kommentare zum Paket bitte an eisfair@chriswue.de oder nach spline.eisfair.dev.



Fußnoten

... Abspeichern[*]
ACHTUNG: Zur Zeit wird dabei die Formatierung der Konfigurationsdateien zerstört, d.h. Kommentare und Leerzeilen werden entfernt und die Reihenfolge der Variablen wird u.U. verändert.
... Übernehmen
... Status[*]
erreichbar bzw. nicht erreichbar
... Dienst[*]
Danach ist die Konfiguration über den Browser nicht mehr möglich
... Dienst[*]
Danach ist ist die Konfiguration über wen Browser möglich
... Fenster[*]
je nach Browsereinstellung
Christian Wuerdig 2003-06-15