EX1SMPLEonline log
Amateur Radio online log  Copyright (c) 2006, Sven-Hendrik Steinweg, DL5AZA  
http://www.onlinelog.hosting24.de
===============================================================================
"online log" Installation (Version 1.1.6.2)
===============================================================================

Voraussetzung für den Betrieb von "online log" ist Web Space mit PHP 
ab Version 4.3 und MySQL ab Version 3.23. (Kostenloser Webspace zum Testen)


Zur Konfiguration vor dem Dateiupload wird das ZIP-File 
"onlinelogxxx.zip" 
in ein Arbeitsverzeichnis auf der lokalen Festplatte entpackt. 
Dabei entsteht im gewählten Arbeitsverzeichnis das Verzeichnis "onlinelog". 

Es ist hilfreich, wenn bereits ein FTP-Client für den Transfer der 
Dateien zum Provider eingerichtet ist.
(FileZilla  http://www.chip.de/downloads/c1_downloads_13011076.html)
  

Schritt 1 - Datenbank beim Provider anlegen
-------------------------------------------------------------------------------
Login in die Web Administration beim Provider.
Im Bereich Datenbankverwaltung eine neue Datenbank erstellen.
Wenn Datenbankname und Benutzername nicht bereits vorgegeben sind,
können diese nun selbst vergeben werden.
Automatisch vorgeschlagene Passworte erfüllen die Anforderungen an sichere 
Passworte und können daher durchaus übernommen werden.


Schritt 2 - Datenbank-Zugangsdaten in Konfigurationsskript übernehmen
-------------------------------------------------------------------------------
Am lokalen Rechner in das Unterverzeichnis "onlinelog/inc" wechseln. 
Mit einem einfachen Texteditor (Windows Zubehor/Editor) die
Datei "olconfig.inc.php" öffnen, editieren und speichern.
Einzutragen sind die unter Schritt 1 vergebenen Namen.

$dbhost = "xxx" ;         // Datenbank Host
$dbname = "xxx" ;         // Datenbankname
$dbuser = "xxx" ;         // Benutzername
$dbpwd = "xxx" ;          // Passwort

Der Hostname für den Datenbank Server sollte sich in den vom Provider 
bereitgestellten Unterlagen befinden. 
Es ist in der Regel die Internetadresse des Datenbank Servers.
Oft auch das Synonym "localhost".


Bei den folgenden Verweisangaben steht der Ausdruck "meine_internet_adresse" 
für die jeweilige konkrete Internetadresse, unter welcher "online log" 
installiert wird.


Schritt 3 - Dateien zum Provider übertragen
-------------------------------------------------------------------------------
FTP-Client mit den vom Provider erhaltenen FTP-Zugangsdaten einrichten/starten.
(Adresse, Benutzername, Passwort) 
Nach Login providerseitig in das Dokumentenverzeichnis wechseln.
Dieses enthält in der Regel bereits die Datei "index.html" oder "index.htm", 
welche entfernt oder besser zur Sicherung umbenannt wird. (index.html.save)
Lokal in das Verzeichnis "onlinelog" wechseln und schrittweise alle Dateien und
Verzeichnisse inklusive der Unterverzeichnisse in das Dokumentenverzeichnis beim 
Provider kopieren. 
Das Verzeichnis "onlinelog" selbst wird nicht mit übertragen.

Jetzt sollte der Browser die "online log" Startseite nach Eingabe des aktuellen 
URL bereits anzeigen, wenn auch ohne Content aus der Datenbank. 
Die qualifizierte Angabe in der Adresszeile des Browsers ist:  
"http://meine_internet_adresse/index.php"

Soll "online log" in eine bereits bestehende Website integriert werden, 
bietet sich die Installation in einer Subdomain an.
Seit Version 1.1.2 ist auch die Installation in einem Unterverzeichnis
des Dokumentenverzeichnis möglich.

   Neben der Standardinstallation im Rootverzeichnis einer Haupt- oder 
   Subdomain kann online log seit Version 1.1.2 auch in einem Unterverzeichnis 
   installiert werden. 
   Eine Integration in eine bestehende Website ist dadurch sehr einfach und 
   nicht zwingend auf die Einrichtung einer Subdomain beschränkt.
   Einfacherweise wird in diesem Fall das komplette Verzeichnis "onlinelog" 
   ins Dokumentenverzeichnis der bestehenden Website mit dem FTP-Programm kopiert.
   
   Bei den URLs sind die entsprechenden Änderungen zu berücksichtigen.
   Front End: 
   http://meine_internet_adresse/mein_unterverzeichnis/
   http://meine_internet_adresse/mein_unterverzeichnis/index.php
   Admin:
   http://meine_internet_adresse/mein_unterverzeichnis/logadmin/
   http://meine_internet_adresse/mein_unterverzeichnis/logadmin/index.htm
   
   Installation-Schritt 4 (Tabellen generieren):
   http://meine_internet_adresse/mein_unterverzeichnis/logadmin/create_tables.php



Schritt 4 - MySQL-Datenbank-Tabellen generieren
-------------------------------------------------------------------------------
Alle erforderlichen Datenbank-Tabellen werden bei der Ausführung des 
Skriptes "create_tables.php" erzeugt.
Dazu wird in der Adresszeile des Browsers das Skript in folgender Weise 
aufgerufen: http://meine_internet_adresse/logadmin/create_tables.php


Schritt 5 - "online log" Einstellungen
-------------------------------------------------------------------------------
Die "online log" Web Administration ist unter der Adresse 
http://meine_internet_adresse/logadmin/  erreichbar.

Der Erstlogin erfolgt als SuperUser. 
Als Zugangsdaten für "User" und "Password" ist jeweils   superuser   einzugeben.

1. Benutzer verwalten
Die erste Aktion unter dem Menüpunkt "Benutzer verwalten" ist der Austausch der 
Zugangsdaten.
Die Schaltfläche für den Bearbeiten-Modus befindet sich am rechten Tabellenrand 
der Übersichtsliste. 
Ein sicheres Passwort sollte nicht weniger als 8 Zeichen aus Ziffern und 
Buchstaben in Groß- und Kleinschreibung enhalten. 
Es geht um die Sicherherheit des Datenbestandes. 
Da nur der SuperUser Zugriff auf die Benutzerverwaltung hat, ist das Passwort 
sorgfältig aufzubewahren.

2. Einstellungen
Unter dem Menüpunkt "Einstellungen" ist zunächst im Feld "Master Callsign" das 
Hauptrufzeichen einzutragen und abzuspeichern.
Alle weiteren Einstellungen können später erfolgen.
Zum Feld "E-Mail" noch folgender Hinweis:
Hier ist ausschlieslich eine Mailadresse zu verwenden, die zuvor in der 
Mailverwaltung der Web Administration beim Provider eingerichtet wurde. 
Es handelt sich also um ein Mailkonto der eigenen Domain, wie etwa 
"webanfrage@meine_internet_adresse", welches ohne Authentifizierung den SMTP-
Server des Providers für den Mailvesandt aus Web-Formular-Anfragen nutzen darf.


Hilfe-Seite im Adminbereich verwenden
-------------------------------------------------------------------------------
Über die Hilfe-Schaltfläche können im Adminbereich kontextsensitiv 
Informationen abgerufen werden.
Wichtig: 
Lesen Sie bitte wie Sie die erforderlichen Zugriffsrechte für den ADIF-Import 
und den Bildupload einstellen.


Updates
-------------------------------------------------------------------------------
Bei Updates immer das komplette Update-Paket verwenden und alle älteren Dateien 
auf dem Server beim Provider überschreiben.

Beim Update werden die Schritte 2 bis 4 sinngemäß der Erstinstallation 
abgearbeitet.


===============================================================================


Bei Installationsproblemen zuerst die Tastatur-Eingaben auf Tippfehler
kontrollieren. Weiterhin überprüfen, ob alle Daten an der richtigen 
Stelle eingetragen wurden. Schrittweise vorgehen.


1. Ist die Datenbank beim Provider eingerichtet ?
2. Wurde die Datei inc/olconfig.inc.php mit den gültigen Zugangsdaten zum 
   Provider Webspace, in das Verzeichnis inc kopiert ?
3. Sind alle notwendigen Tabellen angelegt ? 
   (http://meine_internet_adresse/logadmin/create_tables.php)
   bzw.
   http://meine_internet_adresse/mein_unterverzeichnis/logadmin/create_tables.php

Wenn die Datenbank inklusive Tabellen verfügbar ist, erscheint die Ausgabeseite
mit der Stilvorlage "Blau". 
Im Kopfbereich steht als Platzhalter für das Call "MyCall online log".

Erscheint die Seite in der Stilvorlage "Rot/Gelb" ohne Call-Platzhalter,
ist die Datenbank nicht verfügbar. (Punkte 1-3 überprüfen)

-------------------------------------------------------------------------------
Zur Kontrolle und Datenpflege können auch die Admin-Tools des Providers 
wie etwa "phpMyAdmin" genutzt werden. (Administration von MySQL-Datenbanken)



###############################################################################


Optionale Basiseinstellungen
-------------------------------------------------------------------------------
Die Konfigurationsdatei "olconfig.inc.php" enthält neben den
Datenbank-Zugangsdaten (Schritt 2) noch folgende Einstelloptionen:

1. Gruppierung der Events in Jahresarchive

   Die Aufteilung der Events auf Jahresarchive dient der besseren Übersicht und 
   ist sinnvoll, wenn die Auffindbarkeit durch die Menge der Einträge erschwert
   wird.
   Der Wert 1 für den Steuerparameter "$yearsplitting" schaltet diese Funktion 
   ein. ($yearsplitting = 1 ;)
   
   Bei aktivierter Funktion werden die Einträge in den Selektboxen "Year" und
   "Event" vom QSO-Datenbestand abgeleitet. D.h., im Modus "Jahresarchive" 
   sind die Einträge in den Selektboxen erst sichtbar nach dem Import der 
   QSO-Daten und deren Verknüpfung mit einem Event! 


2. Ausgabe der Suchergebnis-Tabelle in Band/Mode Ansicht

   Eingeschränkte Datenausgabe auf Band und Betriebsart.
   Beispiel für die Aktivierung:
   $bandmode_view = 1 ;	       (Band/Mode Ansicht aktiv)


3. Anzeige von QSO-Daten im öffentlichen Web unterdrücken

   Auch in der Detailansicht der Suchergebnis-Tabelle lässt sich die Daten-
   ausgabe über die Anzeigeunterdrückung ganzer Tabellenspalten einschränken.
   Mit den Werten 1 oder 0 für die Steuerparameter kann die Anzeigeunterdrückung
   für die zugeordneten QSO-Daten aktiviert / deaktiviert werden.
   Ist der Parameter $hfs_utc beispielsweise auf 1 gesetzt ($hfs_utc = 1 ;), so 
   wird die Tabellenspalte "UTC" nicht ausgegeben. (Unterdrückung aktiviert)


4  Requests per Mailformular oder druckbaren Anforderungsblatt ermöglichen

   In der Suchergebnis-Tabelle angezeigte QSO Daten können per Checkbox
   ausgewählt und in das Mailformular oder ausdruckbare Anforderungsblatt 
   übernommen werden.
   Beispiel für die Aktivierung:
   $requests_enabled = 1 ;         (Requests erlauben, Checkbox verfügbar)


5. Checkbox für QSL-Anforderung im Mailformular aktivieren
   
   Nur relevant, wenn Requests erlaubt sind.
   Contest- oder Klubstationen, die keine QSL-Karten sammeln aber auf 
   Anforderung QSL versenden, können einen benutzerfreundlichen 
   "QSL on demand service" zur Verfügung stellen.
   Folgende Checkboxen für den QSL-Request sind möglich:
   - "QSL via Buro"
   - "Direct QSL" (Reimbursement of expenses thru PayPal)

   Beispiel für die Aktivierung:
   $qsl_request_buro = 1 ;           (Checkbox  "QSL via Buro" aktiv)
   $qsl_request_paypal = 0 ;         (Checkbox  "Direct QSL"   inaktiv)

   Eine QSL Info - Seite mit entsprechenden Detailinformationen, speziell bei
   der Nutzung der Checkbox "Direct QSL", kann im Adminbereich Menü Extrapages
   angelegt werden. 


6. Direkt-Link für ADIF Datenimport

   Ein-Klick-Zugriff auf den ADIF Datenimport für die eilige 
   online log Aktualisierung.
   Aktuellen Stand im ADIF1-Format aus dem Logbuch als Komplettlog exportieren 
   und vorhandene Daten im online log ersetzen.
   Beispiel:
   $importdirectlink = 1 ;	   (Direktzugriff aktiviert)


7. Konformitätsmodus für den E-Mail Standard RFC 2822

   Einige Mail Transfer Agents (Software beim Web Hoster) interpretieren 
   Steuerzeichen für Zeilenumbrüche in E-Mail Headern abweichend 
   vom E-Mail-Standard RFC 2822. 
   In diesem Fall werden die Anfrage-Mails vom Webformular nicht im HTML-Format 
   dargestellt. Ausgegeben wird der Quelltext der Nachricht, eine Mischung aus 
   HTML-Anweisungen und Inhalt.
   
   Abhilfe ist nur möglich, indem die RFC 2822 Konformität aufgegeben wird.
   Online log verwendet dann die erwarteten (nicht konformen) Steuersequenzen.

	Dazu wird der Wert des Parameters $RFC2822conform von 1 auf 0 gesetzt. 
	($RFC2822conform = 0 ;)
   

8. Mehrere online logs auf einer Datenbank betreiben

   Mehrere online logs auf der gleichen Datenbank werden durch den Name-Präfix
   der Datenbanktabellen unterschieden. Jede Installation benutzt in der 
   jeweiligen "olconfig.inc.php" einen verschiedenen Name-Präfix.
   
   Der Parameter $tpx erhält beispielsweise in der Datei "olconfig.inc.php" der 
   ersten Installation den Wert "log1" ($tpx = "log1" ;) und in einer weiteren
   online log Installation den Wert "log2" ($tpx = "log2" ;).
   
   Die Werte für den Datenbankzugang sind für alle Installationen gleich. 
   (Datenbank Host, Datenbankname, Benutzername, Passwort)   
   
   Die verschiedenen online log Installationen werden auf der Basis von Subdomains
   oder seit Version 1.1.2 auch auf Basis separater Unterverzeichnisse realisiert.
   
   Subdomains werden innerhalb der Webspace-Verwaltung selbst eingerichtet.
   Die Anzahl der möglichen Subdomains hängt vom gewählten Hosting-Paket ab.
   Wunschname der Subdomain eintragen und bestätigen. Es wird automatisch eine 
   Verzeichnisstruktur analog zur Hauptdomain erstellt.
   
   Für jede Subdomain erfolgt die online log Installation wie oben beschrieben in 
   das jeweilige Dokumentenverzeichnis Schritt für Schritt.
   
   Die Datenbank - Schritt 1 - wird natürlich nur einmalig angelegt.
   
   Die Internetadresse einer Subdomain ist: "Subdomain.Hauptdomain".
   (z.B: http://callsign1.meine_internet_adresse/logadmin/)
   
   Frisch eingerichtete Subdomains sind oft erst verzögert per Browser verfügbar.
   (Aktualisierungszyklus der Serverkonfiguration beim Provider)
   
   
===============================================================================
 
 * Freehoster stellen kostenlos geeigneten Webspace zum Testen bereit.
   Bei -  php-friends.de  - ist dieser zudem  werbefrei.