LinkMaster Lite v3.0 Help

The most current version of this file can be viewed online here

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

########

#######

###### Installation & usage instructions for LinkMaster Lite v3.0

##### Adam Barkow

#### abarkow@e-web.net

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

# Overview:

# This is an extremely convenient web based link management system to add, modify, suspend

# and receive link requests with the greatest of ease.

# The program is feature rich and gives the Webmaster total control.

# Perhaps its single most useful feature is the ability to check for reciprocal links.

# We think this feature alone is worth the price of admission :-) Pro Version

# Installation is very easy, especially if you have experience installing other scripts.

# You don't need to modify any of the CGI scripts except for the location of Perl

# and the master configuration file.

# Configuration parameters and customizations are set right from your web browser!

# You may use this software package to manage links on one domain.

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

# MINIMUM SERVER REQUIREMENTS:

# Runs on a Unix Operating System with PERL 5

# MINIMUM SKILL SET REQUIREMENTS FOR INSTALLATION:

# Familiarity with FTP and Telnet protocols.

# Knowledge of Unix file permissions.

# Knowledge of cron.

# If you do not have, or are unsure of your ability to perform these minimum requirements, we strongly

# recommend that you purchase our installation option.

# *******************************************************************************

# THIS SOFTWARE IS NOT REFUNDABLE IF PROBLEM IS NOT ON OUR SOFTWARE.

# *******************************************************************************

# Without our written permission, it is illegal to duplicate, decompile, install, resell or

# distribute this software in its entirety, or any portion of this package to other

# persons, companies or organizations.

# EWC, Inc. is represented by full time legal counsel. We do not take lightly

# copyright infringements of intellectual property rights, and will aggressively

# seek damages if the terms of this license has been violated.

# DISCLAIMER:

# These scripts are provided on an "As Is" basis. EWC, Inc.

# will not be liable (nor responsible) whatsoever for any direct

# or indirect damages caused by the use of this software.

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

Please read the entire following documentation carefully.

This is absolutely essential if you want to have a smooth and successful installation.

** If you are currently running any version in the 2.xx series,

please make sure you have performed the required upgrade procedure before continuing!

------------------

1) Components

2) Script Installation

3) Administration Functions

4) Usage and Implementation

5) Tips and Tricks

** If you purchased installation, you can skip #2 **

---------------------------

#1: C0MPONENTS

---------------------------

The zip file contains the following two (2) directories:

main

images

The main directory contains six (6) files...

upgrade.cgi	(only required if you are already running an older version)
linkmaster.cgi	(the main script which displays your links)
linkmaster.cfg	(the main configuration file. this is the only file that needs editing)
lmadmin.cgi	(administration script)
addlink.cgi	(script used to receive link requests)
help-pro30.html	(this file)

The images directory contains three (3) files...

- hot.gif

- new.gif

- linklogo.gif

-----------------------------------------

#2: SCRIPT INSTALLATION

-----------------------------------------

Edit the linkmaster.cfg file according to it's own instructions located in the file.

Be sure to use a plain text editor such as Notepad.

*** Do not use an HTML editor!! ***

Make sure that the first line of each of the cgi scripts points to the proper location

of Perl 5 on your server.

Typically this line should read either #!/usr/bin/perl or #!/usr/local/bin/perl

If you are unsure as to the location, simply type at the command line: which perl5

Make sure the second line of the cgi scripts point to the linkmaster.cfg file.

This is an absolute server path and NOT a URL!!

FTP all files (except images) to the $cgi_path directory that you defined in the linkmaster.cfg file

TIP:: (For added security, the linkmaster.cfg file can be put in non-public directory.)

*** BE SURE TO FTP IN ASCII TEXT MODE AND NOT BINARY!! ***

Change the permissions of each cgi file to 755

FTP all of the image files from the images directory to the directory defined in the linkmaster.cfg file

THAT'S IT!!!

---------------------------------------

#3: ADMIN FUNCTIONS

---------------------------------------

Before going "live" with the scripts, you will want to customize the program to your own needs.

To access the administration area of the program, you will need to call the script via a web browser

using this URL...

http://www.yourdomain.com/cgi-bin/linkmaster/lmadmin.cgi

Make sure that java script is enabled as the online help makes good use of this!

You will of course use the password defined in the linkmaster.cfg file :-)

Upon successful entry into the admin area, the control panel will appear.

The admin functions are as follows...

1) EDIT VARIABLES:

All script customizations are set here. There are also pop-up java windows to help you along.

2) CHECK FOR NEW LINK REQUESTS:

All new link requests that have come in are displayed here. If you are using the auto-trade option,

there will not be any link requests displayed, as all links will automatically be added.

3) EDIT TEMPLATES:

The templates are the heart of the customization! Each template option is well documented online.

See the tips and tricks section below for more information.

4) SEND BULK MAIL:

Allows you to send a broadcast message to all active link partners. Pro Version

5) ADD A LINK:

The admin can manually add a link from here. The LinkBot will NOT check these manually added links!

6) QUICK STATS:

Provides a quick rundown of your links database.

7) BACKUP DATABASE:

This will backup your database.

The backup file is named master.bak and is maintained in the data directory

8) CHECK LINK BOT RESULTS:

Displays the results from the LinkBot activity. Pro Version

9) VIEW SUSPENDED LINKS:

Any links that have been suspended can be viewed and/or restored from here.

10) BAN IP/DOMAIN:

You can ban an IP address or domain name from submitting link requests.

Very useful to get rid of obnoxious spammers.

11) EDIT CATEGORIES:

Add and delete your link page categories.

12) HELP:

Opens up this file.

13) SEARCH:

A simple search engine of your links database using keywords.

-----------------------------------------------------

#4: USEAGE & IMPLEMENTATION

-----------------------------------------------------

Once the script and templates are customized to your liking, you are ready to trade and display links.

To receive a link request simply link to the addlink.cgi script.

To display your links, you will link to the linkmaster.cgi script.

There are two ways to display links...

1) Without categories.

2) With categories.

If you want to display all your links on one page, just call the script like this...

http://www.yourdomain.com/cgi-bin/linkmaster.cgi

If you want to use categories, you can call the script with either a GET or POST command!

The simple approach is the GET command. In this manner the script will be called with a query string...

http://www.yourdomain.com/cgi-bin/linkmaster.cgi?category=business

The above example assumes you have created a category called business :-)

** If your category names are to contain multiple words (ie: American Heroes), make sure you use

the plus sign (+) to separate multiple words such as American+Heroes.

The POST method gives you more creative options. You can use drop down lists, radio buttons and images.

An example of each is as follows...

Drop down list: Embed the following code in your HTML.

<option value="business">business</option>

<option value="education">education</option>

<option value="American Heros">American Heroes</option>

</select>

</form>

Radio Buttons: Embed the following code in your HTML.

<input type=radio name="category" value="business">business

<input type=radio name="category" value="education">education

<input type=radio name="category" value="American Heros">American Heroes

</form>

Image Call: Embed the following code in your HTML.

</form>

-----------------------------

#6: TIPS & TRICKS

-----------------------------

While we have endeavored to make these scripts as easy as possible to install and use, there are several

areas to be aware of and hopefully this section will clarify some of these points.

1) All of the templates utilize special tag or place markers that replace what you

have input in the variables section with live output. These place markers are...

<site_title> è Your site's title.

<domain> è The domain that is defined in the linkmaster.cfg file. LinkBot uses this domain to validate links.

<site_url> è Your site's URL.

<reciprocal_url> è The other site's URL where your link can be found.

2) When creating the HTML design of your links page, make sure you utilize this tag...

è This is where your link will be placed on the page!

There are three optional tags that can be used in your links page....

è Displays a numeric count of the links on the page.

è Displays the category name.

è This tag is new in version 3.0

It will generate a nav bar based on how many links per page you define in the admin.

3) In order to provide the greatest control over the actual format of the links, LinkMaster utilizes a table format.

Each link <b>must</b> be placed inside of table row tags - <tr> </tr>

Within this structure, you can fully customize the output of your links!

There are three system tags that you can place anywhere within the table row....

è Generates bold html if the admin decides a link is deserving.

è Generates a icon if the admin decides a link is deserving.

è Generates a icon for however many days the admin sets the new duration for.

4) You really should not use the nav bar if generating random links.

The reason for this is that the random seeding is generated on each page.

You could however get away with this if your database is somewhat large.

5) To generate all your links on one page, simply set the number of links per page very high.

6) If you mark a link as preferred, it will show at the top of your list regardless of the display method.

*****************************************************************************************

While we are confident this help file should answer any questions regarding the installation and usage

of the LinkMaster script, feel free to contact us at anytime should you need any further clarification.

EWC, Inc.

2520 Welsh Road, #121

Philadelphia, PA 19152

abarkow@e-web.net

CONTENTS