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)
===============================================================================

"online log" requires Web space with PHP starting from version 4.3 and 
MySQL starting from version 3.23.  (Free web space for testing)


Extract the ZIP file "onlinelogxxx.zip" into a working-directory of 
your choice on the local hard-disk.The directory "onlinelog" will be created.

It is helpful, if a FTP program for the transfer of the files to the provider 
is furnished already. 

FTP-Client:
http://sourceforge.net/projects/filezilla/ ("FileZilla")

In the further text the expression "my_internet_address" is equivalent to 
the concrete internet address of your installation.   


Step 1 - Create a database
-------------------------------------------------------------------------------
Log in into the Web administration with the Web hosting provider.
Go to database management and create a new database. It is usually realized 
by push of a button.  
Often are database name, user name and also password already given. 
If not, use your own identifiers.


Step 2 - Take over data for the database access in configuration script
-------------------------------------------------------------------------------
Change to the directory "onlinelog/inc" at your local hard-disk.
Open the configuration file "olconfig.inc.php" with a text-editing program.
Take over the names from Step 1 for the database access.
The database host name is to find in the documents you got from your provider.
It is usually the internet address of the database server. 
Often also the synonym "localhost".

$dbhost = "xxx" ;		// database host
$dbname = "xxx" ;		// database name
$dbuser = "xxx" ;		// database username
$dbpwd  = "xxx" ;		// database password

Save your changes.


Step 3 - File transfer to the Web space
-------------------------------------------------------------------------------
Use the FTP-Client program with the FTP access data you got from your provider.
After login select the directory "onlinelog" at the local disk and the document
directory at the Web space. Usually the document directory contains already 
the file "index.html". Rename this file as "index.html.save".
Now you can copy step by step all directories and files from the local side 
to the Web space.
The directory "online log" self will not be copied.

At this position you should see already your "online log" at the browser. 
Admittedly without content from the database.
Put the URL  http://my_internet_address/index.php  into the browsers address 
input line. 

If "online log" is to be integrated into an already existing site, 
the installation in a subdomain is possible.
Since version 1.1.2 is the installation as a subdirectory possible. 

   Aberrant of the standard installation into the root directory of a maindomain 
   or subdomain it is possible since version 1.1.2 to install "online log" into 
   a subdirectory of an existing website. 
   Simple manner, copy the complete directory "onlinelog" into the document root 
   of the existing site.
   
   Note the resulting changes at the URLs.
   Front End: 
   http://my_internet_address/my_sub_directory/
   http://my_internet_address/my_sub_directory/index.php
   Admin:
   http://my_internet_address/my_sub_directory/logadmin/
   http://my_internet_address/my_sub_directory/logadmin/index.htm
   
   Installation-Step 4 (generating tables):
   http://my_internet_address/my_sub_directory/logadmin/create_tables.php



Step 4 - Generate MySQL database tables
-------------------------------------------------------------------------------
All necessary database tables will be created by executing the script 
"create_tables.php".
Type the following URL into the browsers address input line.

URL:  http://my_internet_address/logadmin/create_tables.php

- done.



Step 5 - "online log" Settings
-------------------------------------------------------------------------------
Go to the "online log" administration.
URL:  http://my_internet_address/logadmin/

The first login is a superuser access. 
Access data for "User" and "Password" is superuser for both.


1. Manage User
The first task is the exchange of user name and password.
Select menu item "Manage User". Click the editing button at the right side.
A safe password should consist of not less than 8 digits from numbers and 
letters in large and lower case. 
The access data are to be kept carefully.

2. Settings
First the main call sign is to be registered and stored. All further settings 
can take place later.
Note: For the field "E-Mail" you need to establish a POP3 mailbox at your Web.
Log in into the Web administration with the Web hosting provider and look for
mail management.


Use the help page in admin area
-------------------------------------------------------------------------------
The help page is related to the just opened menu item. 
Click the "Help" item for some informations about the respective subject.
Important: 
Please read about the necessary permissions for ADIF import and image upload.


Updates
-------------------------------------------------------------------------------
For updates use always the complete upgrade package to override all older 
files on your web space.

Follow the steps 2 through 4 analogous of the initial installation.


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


For installation problems:
Check first the keyboard entries for typing errors. 
Examine further whether all data in the correct place were registered.
Proceed gradually.


1. Is the database established ?
2. Is the file "inc/olconfig.inc.php" with the correct data 
   copied into the directory "inc" at the Web space of the provider ?
3. Are all necessary tables created ? 
   (http://my_internet_address/logadmin/create_tables.php)
   
If the database inclusive of tables is available, the online log is to see 
in blue colors.
At head area is the place holder "MyCall online log" for the actual callsign.

If the online log is to see in red and yellow colors and without place holder
for the callsign, the database isn't available. (Check the points 1 to 3)

-------------------------------------------------------------------------------
For checking and data maintenance use also the tools of your Web administration
like "phpMyAdmin". (Administration of MySQL-Databases)


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


Optional basic settings
-------------------------------------------------------------------------------
The configuration file "olconfig.inc.php" includes the 
Database access data (step 2) and additionally following options:

1. Event-selection in annual archives or as simple list

   Use the parameter "$yearsplitting" to control this function.
   Write the value of 0 for the select-list ($yearsplitting = 0 ;) or 
   the value of 1 for annual archives ($yearsplitting = 1 ;).
      
   Note: In mode "annual archives" all entries of the select boxes "Year" and 
   "Event" are only visible if QSOs are imported and linked to an event!


2. Showing of the search result table in band/mode view

   Limited data output on band and mode.
   Example of activation:
   $bandmode_view = 1 ;	       (band/mode view active)


3. Suppression of the display from QSO-data in the public Web

   In the detail view of the search result table it is possible to hide 
   certain columns.
   These settings are also effective on the qso listing page.

   The values of 1 or 0 of the parameters control the Suppression.
   For example: 
   The Parameter "$hfs_utc" is set to 1.   ($hfs_utc = 1 ;) 
   So is the Suppression activated - the column UTC is not displayed.


4  Permit Requests by mail form or the printable request form 

   After a successful search displayed QSO data can be copied into an
   email request form or into a printable request sheet.
   Example of activation:
   $requests_enabled = 1 ;     (Requests allowed, checkbox available)


5 . Activation of check boxes for QSL-request in mailform

   Contest stations or club stations that do not collect QSL cards and 
   sending QSL on request can make available here a "QSL on demand service". 
   The following check boxes for the QSL request are possible:
   1. "QSL via Buro"
   2. "Direct QSL" (Reimbursement of expenses thru PayPal)
   Example for activation:
   $qsl_request_buro = 1 ;     (Checkbox  "QSL via Buro" active)
   $qsl_request_paypal = 0 ;   (Checkbox  "Direct QSL"   inactive)


6. Direct link for ADIF data import

   One click access for quick ADIF data import without backend menu.
   Export of current data from the logbook to the online log as complete log.
   Already existing data in online log for the particular event will be replaced.
   For Example:
   $importdirectlink = 1 ;     (Direct access allowed)


7. Conformity mode for the e-mail standard RFC 2822

   Some mail transfer agents (Software at the Web Hoster) 
   interpret code sequences for line breaks in e-mail headers different 
   from the e-mail standard RFC 2822 .
   In this case, the inquiry-mail from the webform is not displayed 
   in HTML format.
   To see is the source of the message, a mixture of HTML instructions 
   and content.
   Remedy is only possible if the RFC 2822 compliance is abandoned.
   Online log then uses the expected (not compliant) code sequences.
   
   The value of the parameter $RFC2822conform is now to set from 1 to 0.
   ($RFC2822conform = 0 ;)


8. Several online logs on a database use

   Several online logs on a database are distinguishable thru a name prefix 
   for the table-names.
   Each installation uses a unique name prefix in the own "olconfig.inc.php".
   
   For example:
   The parameter "$tpx" has a value of "log1" as name prefix ($tpx = "log1" ;)
   in the first installation. 
   The name prefix for the next installation could be "log2" or another 
   unique string. And so on.
   
   The values for the database access are the same for all installations.
   (Database Host, Database Name, User Name, Password)
   
   The various online log installations are based on subdomains.
   Since version 1.1.2 also based on separate subdirectories.
   
   The Subdomains are established with the tools of the webspace administration.
   Register the desired subdomain name and confirm.
   Now a directory structure analogous to the main domain is created.
   
   Install online log in each document directory of each 
   subdomain from step 2 to step 5. 
   
   Step 1 - setup of the database - is to do only once. 

   The internet address of a subdomain is: "subdomain.maindomain"
   For example: http://call1.my_internet_address/logadmin/

   Note:
   Just created subdomains are mostly delayed accessible with the browser.
   (Refresh cycle of the server configuration at the provider.)
    

===============================================================================
 
 * There are some hoster with free and suitable web space for testing.
   At -  php-friends.de  - this is also free of advertising.