User manual - Steven's guestbook - configuration & installation

Configuration & Installation
Overview | 01.) download the required system software
|  | 02.) configure & install the required system software
|  | 03.) download the script
|  | 04.) decompress the packed script
|  | 05.) adjust the shebang-line
|  | 06.) adjust the configuration file
|  | 07.) eventually rename & relocate directories and files
|  | 08.) adjust the HTML templates
|  | 09.) upload the script
|  | 10.) set the permissions
|  | 11.) create the configuration
|  | 12.) finishment (& bugtracking)
Steps |  | 01.) download the required system software (overview)
|  |  | See the requirements page therefore.
|  | 02.) configure & install the required system software (overview)
|  |  | This may include installments or upgrades of required software.
|  | 03.) download the script (overview)
|  |  | Sources:
|  |  | - Guestbook v. 0.3b
|  | 04.) decompress the packed script (overview)
|  | 05.) adjust the shebang-line (overview)
|  |  | Open the guestbook script and adjust the first line (the so-called shebang line) to match the location of your perl interpreter (usually /usr/bin/perl). The #! at the beginning is not to be omitted.
|  |  | The same procedure applys to the "create_config.pl" file which you may find within the create_config directory.
|  | 06.) adjust the configuration file (overview)
|  |  | The configuration file `<guestbook.dat>` has been divided in sections & subsections with the main intention to dramatically simplify the process of adjusting the configuration & it's setting to equal your needs. Lines beginning with a # are expressly important & should not be modified since they operate as kind of a placeholder, so don't touch them. Changes may be made to the lines in the following format: `data = data` While here the left side of the assignment is of interest to the perl parser (which you shouldn't touch expressly either), the right side should catch your attention though; all section and their belonging subs come along with a short description which you should read in case you intend to change anything within this file. Be aware that if you, for example, apply a change to a filename/directory/path setting you will most likely have to rename it on your harddisk/webspace too. The process of creating a new configuration file is due again (s. pt. 11- "create the configuration" therefore). P.S: The spaces between the value/key and the assignment operator are necessary. So if you will intentionally omit them, you will run a most likely buggy-acting script.
|  | 07.) eventually rename & relocate directories and files (overview)
|  |  | For subsequent evolving configuration changes, see the explanation above.
|  | 08.) adjust the HTML templates (overview)
|  |  | The HTML-templates (directory: `templates`) which come along with the guestbook script may also be adjusted to match your needs; but be careful to don't unintentionally remove and/or modify the name of a placeholder, for example: `$GUESTBOOK_HTML_MODE` On the other hand, you're allowed to reformat the placeholders, as you wish, but ensure that the placeholder will not vanish out of your source. You may even change their position within the code. Placeholders with a `_INVISIBLE` as suffix, aren't to be altered their position, or the script will most likely lose some of its essential functionality; leave them untouched. Form elements aren't to be altered their names either. You may change the remaining HTML bits & parts as you like, as long as you keep the copyright & author notice intact at the bottom.
|  | 09.) upload the script (overview)
|  |  | Open your desired FTP-client & access your webspace account; then upload all files & directories within the "distribution" directory to a path on the server which a) has the allowance to execute cgi scripts (most often the "cgi-bin") b) is read- & writable for the server belonging HTTP webserver Ensure first that the files are transferred in ASCII-mode.
|  | 10.) set the permissions (overview)
|  |  | Open the create_config directory & change the permissions (short: "chmod") of the "create_config.pl" 755.
|  |  | Open the main directory & chmod the "guestbook.cgi" 755.
|  |  | Open the data directory & chmod all files 666.
|  | 11.) create the configuration (overview)
|  |  | Access the create config script as shown below.
|  |  | If everything went right & no errors were determined, you will have such output printed to your browser declining the count of lines that were parsed.
|  |  | The guestbook script should be set now. If you encounter any problems, 1.) reread the instructions carefully again 2.) follow the recommended steps 3.) recheck the configuration file carefully - if no necessary changes were omitted. 4.) recheck the correctness of the shebang line 5.) recheck the applied permissions 6.) have you transferred the script & its files in ASCII-mode? 7.) consult the troubleshooting section & its FAQ's.