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.

Required "data" directory:

Inside the directory you desired for installation, please create a new sub-directory called "data". It's used to hold the content of "data" 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
		data/*	data (basic data files); 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 using "admin" as login together 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/ag	Absolute path to the location of AccessGuardian on your server.
"data" directory Example: /usr/www/cgi-bin/ag/data	Absolute path to the location that holds databases and related files.

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, the 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/ag	URL to the location of AccessGuardian on your server.
URL of checkout script (should be secure) Ex.: https://www.sunnyscript.com/cgi-bin/ag/checkout.cgi	URL pointing to the checkout part of AccessGuardian. In order to enable SSL encryption, change the transfer protocol to HTTPS.
URL of user's help document (optional) Example: http://www.sunnyscript.com/myhelp.htm	URL to an optional help document (not included); may also consist of an e-mail link (e.g. "mailto:support@sunnyscript.com"). Usage note: Should contain a link to your company's terms of business, customer service details or any other related document.

Various parameters:
 

Name of parameter to set...	Description...
Authentication time (in seconds) Example: 10800	Time frame keeping user authentications active (after expiration, people must log in again); recommended range: 1 to 12 hours.

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.
 

How to access the member lounge (registered user area, online subscriptions):
 

Helpful hint: For more information about this feature, please refer to the chapter "Member lounge and template management".
 

The top menu line provides additional selections (depending on the current system status):
 

The software is able to handle multiple subscriptions, which may be either free of charge or fee based (refer to the following parts of this chapter for more information).

You can protect confidential business data, provide private areas to your employees (e.g. sales staff), sell paid memberships of your website or (web-)services, distribute all kinds of downloadable goods like software, e-books and much more.

Seen on the technical side, two security methods are provided:

Proxy script (normal security, Unix and other OS):

All data stored in the protected directory(ies) is delivered through AccessGuardian after the user has provided its authentication. This method works well with most websites and is recommended, if .htaccess/.htpasswd is not supported by your server.

Technical notes: Server-side scripting, server-generated directory listings and SSI is not supported; embedded multimedia objects (e.g. Flash animations, Quicktime movies or PDF) should work. CGI software must be called by using full URLs.

.htaccess and .htpasswd files (strong security, Unix only):

AccessGuardian uses the server's .htaccess and .htpasswd files to protect content with the highest level of security.

It's the recommended method suited for all kinds of deliverable data, e.g. binary content, multimedia files, embedded objects and executable software like CGI scripts as well as other server-based applications - fully compatible to your existing website.

Technical note: This method may not work on most Windows systems; please use "proxy script" instead of.

Subscriptions - the way AccessGuardian works:

If users are interested to access protected content, they must become a member first. By doing so, they have normally not access to any provided subscriptions (at least unless you specify a particular subscription to be available for new members).

As soon as the users are registered (now called "members"), they can proceed to order the desired subscriptions (which can be free or fee based depending upon your settings and desired application).

After approvement (either automatically or by the admin), members are able to access the subscriptions they have registered for. In this way, it is possible to host multiple subscriptions only accessible by certain users.
 

General settings:
 

Security settings:
 

"Welcome new member" e-mail message:
 

Currency settings:
 

Admin's notification:
 

Order logging settings:
 

Order restrictions:
 

Payment methods: See next part of this chapter.

AccessGuardian member lounge layout:
 

This payment option applies, when you handle payment processing outside (orders are only taken, no invoices generated).
 

Send invoice:

This payment option will create a customizable invoice for each order.
 

Credit card real-time processing:

This payment option requires a "merchant account" registered at a payment processor. In this way, you can handle credit card payments electronically through an online payment system.

Usage note: If you process credit cards by yourself (e.g. via terminal or an electronic cash register), please refer to the payment option "Credit card manual processing" as described later.

Passing back order details from the credit card processor to AccessGuardian:

After a payment has been processed (no matter, if accepted or declined), the payment processor must hand over the results back to AccessGuardian. For this application, the program passback.cgi is intended.

Instruct your credit card processor to transfer all data to passback.cgi of your AccessGuardian installation:
 

And here you can see how to configure AccessGuardian to work together with a payment processor...
 

Credit card manual processing:

This payment option is suited to accept credit cards for manual processing (e.g. via terminal or an electronic cash register).
 

Payment details by phone or fax:

This payment option is suited when using a 3rd-party payment system working with reference IDs or when you desire to get credit card details sent by fax. Following applications may be handled with this payment method:

* 3rd-party payment systems where customer receives (after successful payment) a confirmation ID that needs to be submitted by the customer to you (either by phone or fax). For example, paying by phone bill or credit card acceptance via call center.

* 3rd-party payment systems where customer pays cash and receives a confirmation ID that needs to be submitted by the customer to you for collecting payment. For example, money transfer companies or special banking transfer services.

* High-risk environments (e.g. blacklisted countries with high rates of credit card abuse) requiring you to take credit cards only by fax, perhaps together with a photocopy of the original credit card for verification purposes.
 

Prepaid code:

With this payment option you can allow customers to pay with a special code (e.g. issued by a telephone payment system or by yourself, like gift certificates or as activation code after arrival of cheques).

Technical note: Prepaid codes are kept in the system unless their balances reaches zero. This is done to allow your members buying prepaid codes in advance and then spend them for different subscriptions from time to time.
 

What is a subscription ?

A subscription is like a product your members can subscribe to (after general registration). Such a membership grants access to a protected area of your server for a limited time period and/or number of accesses.

Accessing a subscription can be either free of charge or fee based depending upon your settings for the concerned membership (e.g. when protecting business data, subscriptions are free; when selling memberships, subscriptions are charged).

How to create a new subscription:

Type in the name of the new subscription (e.g. "My online book") and click on the button "Create new".

How to edit / remove a subscription:

Select the subscription from the list, click on "Delete" or "Edit" and follow the provided instructions.

How to change the sorting of subscriptions:

Look for the one you wish to move around and click on either "move up" or "move down" to change its position (this affects the subscription's order within the list appearing on the member lounge).
 

Limitations:
 

Security settings:
 

Subscription expiration:

You can send warning and notification messages to notify members regarding expiration of their subscriptions.
 

AccessGuardian is much more than just an access manager. It also provides various office management tools, like a customer address database, order and invoice handling as well as electronic newsletters.

In the following we explain how to use these features. But before you proceed, you should have been read the previous chapters (some matters are described there we have considered as being known).
 

The "table of registered users" (members) holds all information about customers owning an account on your system, regardless of currently active subscriptions.

Members on this table are able to use the member lounge to login, access protected content and manage their profiles.

Some usage examples:

You can use "View records" in order to search for specific parameters, like age or origin of your customers and so find out what kind of people your business attracts - the ideal basis for creating sales statistics and do targeted marketing.

Add new fields to request further details during registrations to get a clear picture about your customers or ask for information which are required to have for your business.

Inform registered users about upcoming new services, special events and general company news by sending mailings and regular newsletters. And with personalized mails, you may achieve much more attention.

Manual subscription management:

It is possible to manually add, update or delete subscriptions for a particular profile (search for the desired profile and click on "Update" link at the upper right corner). At the system field "Subscriptions" you find a list with all available subscriptions.

Add new subscriptions:

Specify the starting date/time (format: YYYY-MM-DD hh:mm:ss) for the subscription becoming active as well as its quantity (usually "1"). Now move the cursor into a new field to take over the new entry automatically.

Update or remove existing subscriptions:

Change the date/time (format: YYYY-MM-DD hh:mm:ss) or quantity for a desired subscription (set quantity to "0" or leave it empty to delete). Now move the cursor into a new field to take over the entry automatically.

Technical note: This feature requires JavaScript being enabled at your web browser's preferences.

"Table of registered users" settings (accessible from the main admin menu):
 

Restructure table:

On the main admin menu, click on "Restructure" found at "Table of registered users".

Edit fields structure:

Create new fields, edit or remove existing ones and change the sorting of fields.

By the way: When removing a field, concerned table parameters are automatically updated.

Empty table:

Just select the desired options and click on the "Clear data" button in order to clear the concerned table. Please note that once a table (or part of it) is cleared, all related content will get lost and cannot be recovered.

Field properties parameters:

Go to "New field name", type in the desired name, select the data type and click on "Create new field". Otherwise look for the field you wish to modify and click either on "Edit" or the field name. Now the screen "Field properties" appears: