Smart tip: This handbook is also designed to be printed... set your printer's page orientation to landscape format, so there is enough space to place hand-written notes on the left and right margin easily.
 

In a common environment, we recommend to create a new sub-directory within the existing "cgi-bin" folder to separate the software from other already installed products.

Required "template.en" directory:

Inside the directory you desired for installation, please create a new sub-directory called "template.en". It's used to hold the content of "template.en" directory delivered with your software package.

Adjust path to Perl:

Open all program files (*.pl and *.cgi) in a text editor and change the first line "#!/usr/bin/perl" that it reflects the correct path to Perl 5 (or higher version) on your system. This is required to let your server know where the Perl interpreter is located.

Usage note: On most systems, /usr/bin/perl is already the default path to Perl and so no modifications are required.
 

Detailed file table: Scheme: [filename | suggested place to upload (short description); file permission]:
 

Filename...	Description...	Filename...	Description...
*	cgi-bin (program & data files); 755	template.en/*	template.en (templates); 666

Important notes: Please double-check file permissions and transfer mode, otherwise the software may not work as intended. Depending upon the server configuration, different file permissions than the ones stated above may be necessary.

Smart tip: Our installation helper install.cgi makes it easier... just call it from your web browsing software (requires correct installation of this script) and it automatically checks your entire installation, adjusts permissions and fixes typical errors.
 

Before you proceed, it is highly recommended to set an administration password. After this is done, access to the admin panel is granted only by authenticating yourself with the chosen password.

Now click on the button "Edit system parameters" and configure the shown parameters according your needs.

Usage note: Since all parameters are automatically filled with correct values, modifications on your side may not be required.

Directories and files:
 

Name of parameter to set...	Description...
CGI files directory Example: /usr/www/cgi-bin/sc	Absolute path to the location of ServerCheck on your server.
Static HTML file for saving consolidated public testing results Example: /usr/www/htdocs/sc/stats.htm	Absolute path and filename to the desired location of consolidated public testing results. See chapter "Administration panel" for details.
Directory for saving HTML files with per-resource public testing results Example: /usr/www/htdocs/sc/individual	Absolute path to the desired location of testing results created individually per resource. See chapter "Administration panel" for details.

Platform specific settings:
 

Name of parameter to set...	Description...
Mailing program (for Unix only) Example: /usr/bin/sendmail	Absolute path to Sendmail (or compatible) application on your server.
SMTP server Example: smtp.sunnyscript.com	SMTP server for handling mails; when left blank, default mail application is used. This setting is required for non-Unix systems, otherwise optional.
Don't use flock Example: Unchecked	"flock" is normally supported directly by the operating system; should it be unavailable for any reason (e.g. on Win9x, WinMe), mark this checkbox.
Admin e-mail address Example: admin@sunnycript.com	E-mail address of the system administrator (e.g. webmaster).

URLs:
 

Name of parameter to set...	Description...
URL of CGI files directory Example: http://www.sunnyscript.com/cgi-bin/sc	URL to the location of ServerCheck on your server.

Notification parameters:
 

Name of parameter to set...	Description...
From e-mail Example: info@sunnyscript.com	E-mail address used in the headers of outgoing system messages.
Admin's alert subject Example: An error was reported !	Subject used in the headers of outgoing "resource alert" messages.
Admin's status subject Example: Status message from Server Check	Subject used in the headers of outgoing "resource status" messages.
Admin's alert message See next chapter for an example	Message template used for outgoing "resource alert" messages.
Admin's status message See next chapter for an example	Message template used for outgoing "resource status" messages.
Send status e-mail(s) Example: Checked button	Enable or disable sending of status messages to the administrator.
Admin's status e-mail address(es) * Example: john@sunnyscript.com	E-mail address(es) to which status messages are sent. Separate multiple addresses by comma.
Send alert e-mail(s) Example: Checked button	Enable or disable sending of alert messages to the administrator.
Admin's alert e-mail address(es) * Example: john@sunnyscript.com	E-mail address(es) to which alert messages are sent. Separate multiple addresses by comma. Helpful hint: Add e-mail addresses connected with a pager or mobile phone to get notified about errors wherever you are.
* You can determine additional e-mail address(es) to be notified for each unique resource. For more detailed information, please refer to the next chapter.

After you have verified all settings carefully, click on the button "Save parameters" to take over modifications to the system. It is also possible to bring back previous values with the "Let the script restore defaults" button.
 

Usage note: The top menu line provides links to all menu entries regardless on which screen you are currently. This will help you to navigate more convenient through the software.
 

A list with all resources will appear. Each resource listing includes links for running live tests as well as updating and removing it (see column headlined with "Run action").

Live test of a resource:

Click on "Test" to perform a live test of the concerned resource.

Usage note: When running live tests, also e-mail notifications are sent out and test results become logged.

Update a resource:

Click on "Update" to modify the concerned resource (see part "Add resource to check" for details).

Remove a resource:

Click on "Delete" to remove the concerned resource from the database.

Important note: Please be careful. Once a resource is removed, it cannot be recovered.
 

Fill out the shown form and click on "Add resource" in order to take over a new record to the resource database.
 

Helpful hint: You can update an existing resource at any time by using the "Browse" link in the top menu line.
 

Click on this button to perform a live test of all resources currently listed in the resource database. After the test has been finished, you see the statistics for all tested resources.

Important note: Depending upon the number of resources to check and other factors, this process may take several minutes. Please be patient, don't press a button on your browser software or try to start the process again.

Helpful hint: In order to test just selected resources, please go to "Browse database" and click on the appropriate link.

Usage note: When running live tests, also e-mail notifications are sent out and test results become logged.
 

Fill out the form and click on "View statistics" in order to let ServerCheck generate the reports.
 

The statistics are generated based upon the current log file (see "Logfile maintenance").
 

In some cases it is desired to make testing results available to the public by including them into a website (e.g. an Internet presence provider may proof the reliability of its servers in this way).

By default, ServerCheck creates two reports...

A consolidated report containing all resources (as defined at "Static HTML file for saving consolidated public testing results" setting at "System parameters" screen).

And a unique report per resource (as defined at "Directory for saving HTML files with per-resource public testing results" setting at "System parameters" screen). Format of created files: <ID>.htm (<ID> is the resource ID)

Usage note: In order to disable per-resource reports, ensure that the path "Directory for saving HTML files with per-resource public testing results" is left empty.

Manage public results:

In order to enable report creation, please set the matching parameters when creating or modifying a resource (see part "Add resource to check"). If you wish to not show any statistics for a particular resource, just keep these parameters unchecked.

Each time resources are tested (either scheduled or by running a live test from admin panel), the public statistic pages become updated. If a per-resource statistic file does not exist or was removed recently, it will be created automatically.

Important note: When you clean (alter) the log file, all collected statistics will disappear (change) next update cycle.

Helpful hint: By using password protection tools of your server or 3rd-party software, you can limit access of the per-resource statistics, e.g. to provide them only to your supprt staff or customers.

Maintaining the layout templates:

The entire layout of the public statistics can be modified to match your website's design. You may alter existing templates or create new ones with a text or HTML editor of your choice.

However a more convenient way is to use the integrated templates editor accessible via admin panel. There you also find further information about existing templates delivered with the software package.

For each template you create, an informational header can be added containing internal comments and notes not appearing at the template itself. Furthermore it is also possible to copy&paste source code from an outside editor.
 

The following chapter will describe how to use Cron (Unix platforms) to schedule ServerCheck.

Important note: The scheduling tool of your server (depending upon the used operating system) can be different. In this case, please contact your webhoster's support department for more details.
 

The file to schedule is cron_run.pl of ServerCheck (this works also with other scheduling tools).

Usage note: For detailed information about Cron and how to manage scheduling on your server, please refer to available literature or contact your webhoster's support department.

Direct editing of Cron file:

Some possible Cron entries may look like the following:
 

Technical note: <perl> must be replaced with your Perl interpreter; <path> means the path to the ServerCheck installation (location of cron_run.pl). Multiple entries are possible (e.g. to run it at different times).

Command line Cron scheduler:

If you're new at Cron scheduling, you can use our command line scheduler to add a new entry to your Cron file. The scheduler will be called from the command line...
 

Technical note: <perl> must be replaced with your Perl interpreter; ensure that you're in the ServerCheck directory.

Now follow the provided instructions. After configuration, the matching entry will be added to your Cron file automatically.
 

Select "http://" as protocol and type in the URL to the software you wish to check. If it works properly, the program will reply with a "200 - OK" response each time it is tested.

... watch domain name registrations:

You may wish to watch domain names in registration process for becoming alive. Select "http://" as protocol and type in the domain name to check. As soon as the concerned domain is connected, you should get a "200 - OK" response.

... watch IP addresses:

Select "http://" as protocol and type in the IP address you wish to check (handled equal to domain names).

... watch resources requiring authentication:

Use "username:password@" string before the original URL, like "http://iam:mypwd123@www.sunnyscript.com/content" or "ftp://you:abc123@ftp.sunnyscript.com/private". In this way, ServerCheck is able to access most password protected areas.
 

Usage note: Depending upon accessed server, there may be additional response codes or shown ones have different meaning.
 

Before you contact our customer service department, please read this manual first. In most cases you find the answer here. However if you still experience problems, we will be more than happy to help you...

For all support inquiries, please contact support@sunnyscript.com and provide the following information:

* The license number of the concerned product.
* A close description of the problem or question you have (no file attachments, please).
* For technical inquiries: Used server environment, URL of admin panel & admin password.