WHAT IS THIS?
=============
SiPort is a basic layout for a 'portal' type web site written in PHP.  It 
is intended to be used in conjunction with Apache Webserver configured to 
use user authentication with .htaccess files.  

The target is for small, password protected sites - I use this for my home
server at the end of an ADSL link for use by my friends for media exchange, 
fun, etc.  I also run another copy for my own personalised Start page with 
home.php programmed to give disk space usage, uptime, logins etc from my 
Linux box.

Features include:
	* News items
        * Bookmarks
        * View IMAP mail inbox using webserver-authenticated user & passwd
        * 'Skins' (Collections of colour settings)
        * Search box to search various engines
        * Two layout options (Left orintated/Middle panel orintated)
        * 'in site' editing of Menu, News, Bookmarks, Skin, Layout
        * Easy to add extra content and pages using HTML/PHP etc


NOTE
====
This is the first release of this software and has only been tested on ONE 
system - mine!  (Mandrake Linux 8.2)

This software comes with absolutely no warranties - if it works for you at 
all, be happy :)   If you fix some bugs or my terrible programming, please
let me know so that I, in turn, can let the whole world know.  And we'll
all live happily ever after.



PREREQUISUITES
==============
* Apache running PHP and using authentication for .htaccess files or similar.
* Ability for your webserver to write files to your local file system.


INSTALLATION
============

Ensure your webserver is configured to use authentication via .htaccess 
files.  If it is not, you will not be able to access the admin page.

1) Select a suitable directory under your Apache Root and cd into it, 
eg /var/www/html

	cd /var/www/html

2) Unpack the archive

	tar xvzf siport-0.2.tgz 

3) Check permisions

	chown -R apache:apache newsdata/ linkdata/ include/menudata.inc include/layout.inc logindata/

4) read/edit config file to your needs

	vi ./include/config.inc

   Make special care to edit the admin user and the root directory!
   
   Make sure only the admin user can access the ./admin directory using a .htaccess file or editing your httpd.conf

5) Use your browser to open the location you installed SiPort in and use!
Use the Admin menu to edit news, links, menu and look n feel.  **You must 
be authenticated with your webserver as the admin user you set in 
config.inc to see this menu**


DETAILS
=======
News stories are stored as text files under ./newsdata/* .  The filename 
is the news headline, the content is the story and the file date/time 
are the story date/time.

Links(/Destinations/Bookmarks) are stored in a similar way to news 
stories.  They are under ./linksdata/* .  The filename is the link name 
and the content the link itself.

Search engines can be edited/removed/added by editing 
./include/searches.inc

To add your own pages(HTML/PHP/etc), drop them in the SiPort directory 
then use the Admin page to add the link to your menu.


./index.php			Main script 
./news.php			Displays news items in full (in panel 
                                frame)
./mail.php			Displays imap mail inbox using auth'd 
                                username & password (in panel frame)

./include/config.inc            Main settings file - EDIT THIS!!
./include/title.inc             Title block
./include/left.inc              Left Block
./include/right.inc             Right Block
./include/menu.inc              Menu Box
./include/menudata.inc          Data for menu - Edit in SiPort Admin!
./include/news.inc              Display News (in panel frame)
./include/newsheads.inc		News headlines Box 
./include/search.inc            Search box
./include/userstat.inc          User stats Box
./include/links.inc             Links("Destinations") Box

./admin/index.php		Main Administration page
./admin/editnews.php		performs admin functions for editing 
                                news (called by admin/index.php)
./admin/editlinks.php           performs admin functions on links 
                                (called by admin/index.php)

./newsdata/...			Directory contains news stories - each 
                                file is one story - filename is title, 
                                file contents is news story, file 
                                date/time is story date/time

./linksdata/...			Directory contains data for links - 
                                each file is a link - filename is link 
                                name, contents is link data 

TO DO
=====
* I would like to include user authentication within the program...

* More modules?


ACKNOWLEDGEMENTS
================
* Javascript for search box from http://web.singnet.com.sg/~kongeuta/prgmming/jsinnov.htm


(c) Simon Hall 2002 siport@phoar.com
Last update: 3rd July 2002