Location: PHPKode > projects > HyperBook Guestbook > readme.txt
Thank you for downloading the HyperBook Guestbook software.  HyperBook is a full-featured, easy to use guestbook which is free for use provided you agree to the License Agreement at http://diamond-back.com/software/guestbook/license.html.

IMPORTANT: You should only use copies of HyperBook which have been downloaded from:
http://diamond-back.com/software/guestbook/hyperbook.zip
This will insure you have the most up-to-date version in an unaltered form.

The following files should be included in your zip file:

admin.php - Program that allows you to administrate your guestbook.
background.jpg - Sample background, may be replaced with one of your own.
bannedwords.txt - Short list of words you may wish to screen from your guestbook posts.
colorchart.html - Small chart of 216 "browser safe" colors to assist with color selection.
database_functions.php - Core database functions used by admin.php and index.php.
display_template.php - Template used to display guestbook entries.
documentation.html - HyperBook Administrator's instructions.
guestbook.jpg - Sample guestbook banner, may be replaced by one of your own.
index.php - Program used by your guests to view and sign the guestbook.
input_template.php - Template used to submit and edit guestbook entries.
language.conf - List of words and phrases displayed to guestbook visitors.
logo.jpg - The HyperBook logo.
phpinfo.php - Program used to display the PHP configuration on your host.
readme.txt - Brief HyperBook overview and set-up instructions, the file you are reading.
signdown.jpg - Sample "Sign the Guestbook" button in the mouseover state.
signup.jpg - Sample "Sign the Guestbook" button in the normal mouse off state.

For complete information, please read the documentation.html file.

Before installing HyperBook, you should be certain that your host supports PHP programs. If you're uncertain, upload the "phpinfo.php" file to your web directory and then display it in your browser. Hopefully you'll be greeted with a screen full of PHP configuration information, if instead you only see "<? phpinfo() ?>" then you may need to contact your system administrator and find out if PHP is available for your account. Alternately, you may also contact me about finding a host that supports PHP.

Security Note: The "phpinfo.php" file can reveal a great deal of information regarding your host server's configuration. While it can be an invaluable tool for obtaining system information, it can potentially be used by hackers to profile your system. For this reason it is recommended that you remove this file after installing the guestbook. However, if you contact the Hyperbook developer with questions or problems, please make this file available as it can aid with troubleshooting.

Once you know PHP runs on your account, it's time to fire-up your favorite FTP or Telnet program and upload the HyperBook files.


*** Upgrade Notice ***

If you have previously installed a version of HyperBook Guestbook lower than 1.20, only the following files need to be replaced:
admin.php
database_functions.php
display_template.php
documentation.html
index.php
input_template.php
language.conf (needs to be chmod'ed to 777)
Your data files will remain compatible with the current version so no messages will be lost. However, this might be a good time to back-up your data directory.


Step 1
Create a new directory in your web file space (ie. where you keep your website files... this directory must be accessible from the web). You may give it any name you wish, I recommend calling it "guestbook" since it will be part of the URL used to visit your guestbook.

Step 2
Set the permissions on the new directory to allow everyone to read, write and execute the files contained in it... ie. CHMOD to 777 (rwxrwxrwx).

Step 3
Open the new directory and create a subdirectory called "data" and CHMOD it to 777. The name of this directory is not optional, it must be called "data" (all lower case), be inside the directory you created for your guestbook and have full permissions set.

Step 4
Next upload the HyperBook files to the first directory you created (eg. "guestbook" - not the "data" directory). Files with a ".jpg" or ".gif" extension should be uploaded as binary files, all others should be uploaded as text. It's not necessary to upload the "readme.txt" file. Depending on your server's configuration, you may need to CHMOD the PHP files to be executable and the "language.conf" to be readable (CHMOD 777 will work). Note: the "phpinfo.php" file is optional, see Security Note above.

Step 5
Now that you have your files online, it's time to access the Admin program with your browser and complete the set-up procedure. Enter the URL to the admin.php program (eg. http://www.yourdomain.com/guestbook/admin.php) and you'll be presented with a short form to fill out with the necessary information to get your guestbook up and running. Each field has a short description of the information required, some fields even have the info filled-in if PHP was able to determine where your files are located. Make certain the information is correct and that all fields have been filled-in, then click the "Set-up Guestbook" button. You'll be able to update all information on this page if you change you mind later (eg. if you want to give your Guestbook a different name).

Congratulations, if all went well you should see the Administrator's Main Menu and your guestbook is ready for visitors. If you see an "Enter Password" screen it probably means your browser isn't accepting cookies (which is where your password is stored so you don't have to keep entering it while navigating the admin program). If you see the Set-up screen again, then PHP was probably unable to write files to the data directory, make certain this directory is in your "guestbook" directory and the permissions have been properly set (see Step 3).

You may now begin to customize the look and function of your guestbook. To link to your guestbook, use the URL to your guestbook directory (eg. http://www.yourdomain.com/guestbook/ ). If your host server doesn't recognize "index.php" as the default file, you may need to add it to the link URL (eg. http://www.yourdomain.com/guestbook/index.php ). Using this URL will display the most recent posts to your guestbook, along with a link to sign the guestbook. If you would like to have a link directly to the Sign the Guestbook form, use this URL:
http://www.yourdomain.com/guestbook/index.php?action=sign

We hope you enjoy using your new HyperBook Guestbook. Please use the Register Program function in the Administration section to register your guestbook, this will keep you informed of critical updates as soon as they become available.


HyperBook Guestbook Copyright © 2001 by Thomas R. Pasawicz. All rights reserved.
Return current item: HyperBook Guestbook