Thank you for downloading PHPStatus Server Status, In this readme it will show you how to install and use the Status script.

  1. Install PHPStatus
  2. Using PHPStatus
    1. Adding/Editing Templates
    2. Adding/Editing Language Files
  3. Getting help with phpstatus
    1. Userguide
    2. Community Forums
    3. Email Us
  4. Reporting Bugs
    1. Security Related Bugs
  5. Copyright and Diclaimer

1. Installing PHPStatus

This is the section for installation or upgrade of phpstatus. Please follow them exactly or the installation might not work.

Step 1: Unzip the .zip archive to you computer.
Step 2: Upload all the files via ftp to your webspace.
Step 3: Chmod the config.php file to 0777 it has to be writable by everyone.
Step 4: Point your browser to www.domain.com/install/ replaceing domain.com width your website address.
Step 5: Follow the online instructions and hit install. Step 6: Chmod the config.php file back to 0644 for security. Step 7: Delete the install directory off you webspace.

Upgrading

When upgrading to a newer version follow these instructions.

Step 1: Upload the files that came in the .zip file overwriting the current files on your webspace.
Step 2: point your browser to www.domain.com/install/upgrade.php and follow the instructions.

That's it for installing or upgrading if you follwed the instructions properly your status script should be up and running now. Have fun.

2. Using phpstatus

I. Adding/Editing Templates

To edit the default template to fit your site just edit the html code in the .tpl files in the templates/default directory and put the {} tags and the tags where you want the guestbook infomation to show up on your site. the {} are the basic variables in the script and the starts a loop so anything inbetween and will be looped however many times according to what's in the database.
To Add your own theme just copy the templates/default directory to a new folder within the templates directory and edit the .tpl files to suit your needs. Upload it to your webspace and go to your admin area at www.domain.com/admin/ replaceing www.domain.com to were you installed the script. Login and go to Add/Edit Themes and add your theme. Now you can change the default theme in the board settings in the admin panel.

II. Adding/Editing Language Files.

If you ever want to edit the text that shows up in the headers and what not in the guestbook script just open up language/lang_english.php and edit the $lang[''] = ''; variables only edit the part inbetweens the second ''.
To add your own language you have to copy the language/lang_english.php file and translate the text inbetween the second '' don't tuch the $lang[''] variables those have to stay the same in every language file. Then just name the new language file lang_language.php replacing language with the name of the language you translated to and upload it to the language directory. The go to the add/Edit Languages section and fill in the info in the form to add your new language. When typing in the language name don't put the lang_ in just do the name of the language you translated in ex. english.

3. Getting Help with PHPStatus

I. Userguide

Acomperhensive userguide is comming soon and will be accessed from the following link.

http://www.hintondesign.org/guides/phpstatus

II. Community Forums

Hinton Design Maintains a thriving community where a number of people have generously decided to donate thier time to help support users. This site can be found at:

http://www.hintondesign.org/forums/

If you seek help via our forums please be sure to do a search before posting. This may well save both you and us time and allow the developer, moderator and support groups to spend more time responding to people with uknown issues and porblems. Please also remember that Hinton Design in an entirely volunteer effort, no one recieves any compensation for the time they give, this includes moderators as well as developers. So please be respectful and mindful when awaiting responses.

III. Email Us

Another way to get help with problems is to email us at support@hintondesign.org And we will try to answer your questions as fast as possible.

4. Reporting Bugs

Hinton design uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please DO NOT post bug reports to our forums, they will be locked. In addition please DO NOT use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).

http://bugs.hintondesign.org

While we very much appreciate receiving bug reports (the more reports the more stable phphg will be) we ask that you carry out a few steps before adding new entries:

  • Firstly determine if your bug is reporductive, how to determine this depends on the bug in question. Only if the bug is reproductive is it likely to be a problem with phphg (or in some way connected). If something cannot be reproduced it may turn out to have been your hosting provider working on something, a user doing something silly, etc. Bug reports for non-reprodiceable events can slow down our attempts to fix real, reproduceable issues.
  • Next please read or search through the existing bug reports (remember to check open AND closed reports!) to see if your bug (or one very similar to it) is already listed. If it is please add to that existing bug rather than creating a new duplicate entry (all this does is slow us down).
  • Check the forums (use search) to see if people have discussed anything that sounds similar to what you are seeing. However, as noted above please DO NOT post your particular bug to the forum unless it's non-reproduceable or you sure it's related to something you have done rather phphg.
  • If no existing bug exists then please feel free to add it.

If you do post a new bug (i.e. one that isn't already listed in the bug tracker) then please include the following details:

  • Your server type/version, eg. Apache 1.2.22, IIS 4, Sambar, etc.
  • PHP version and mode of operation, eg. PHP 4.1.1 as a module, PHP 4.0.1 running as CGI, etc.
  • DB type/version, eg. MySQL 3.23.32, PostgreSQL 7.1.2, MSSQL Server 2000 SP1, etc.

Please also be as detailed as you can in your report, if possible list the steps required to duplicate the problem. If you have a fix which you are VERY SURE works (and is consistent with our coding guidelines) and does not introduce further problems or incompatibilities please let us know. However only include it in the bug report if you really must, if we need it we'll ask you for it.

Once a bug has been submitted you will be emailed any follow up comments added to it. Please if you are requested to supply additional information, do so! It is extremely frustrating for us to receive bug reports, ask for additional information but get nothing. In these cases we have a policy of closing the bug, which may leave a very real problem in place. Obviously we would rather not have this situation arise.

I. Secutity Related Bugs

If you find a potential security related vulnerability in phphg please DO NOT post it to the bug tracker, public forums, mailing lists, etc.! Doing so may allow unscrupulous users to take advantage of it before we have time to put a fix in place. All security related bugs should be sent directly to one or more of the developers.

This can be done in one of three ways; email security@hintondesign.org this is forwarded to all developers, PM one of the developers (see Developer usergroup list for usernames of all developers) or email them directly (either use their listed email address if available or username@hintondesign.org where username is their board username). If emailing or PM'ing developers individually please send the message to several and not just one. If you obtain no response in a reasonable timeframe (a day or two) try the other listed developers.

5. Copyright and Disclaimer

This application is opensource software released under the GPL. Please see source code and the docs directory for more details. This package and it's contents are Copyright © 2003 Hinton Design, All Rights Reserverd.