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
		sample/*	Sample layout files (explained later)

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/fs	Absolute path to the location of FreeSurfer on your server.

URLs:
 

Name of parameter to set...	Description...
URL of CGI files directory Example: http://www.sunnyscript.com/cgi-bin/fs	URL to the location of FreeSurfer on your server.
HTTPS URL of CGI files directory Example: https://www.sunnyscript.com/cgi-bin/fs	URL to the location of FreeSurfer on your server by using the SSL protocol. Should the server not support SSL, then leave this parameter empty.

Usage note: All other parameters managing the system behavior are described more detailed below.

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 page you are currently. This will help you to navigate more convenient through the software.
 

Usage note: Some parameters (required during installation) are skipped here, since they were already described above.

Privacy preferences:

All settings made here takes effect to the anonymity level and behavior of FreeSurfer.
 

Anonymous mail:

FreeSurfer is able to allow sending of anonymous mails (hides your local IP address).
 

HTML insertion:

You can add headers and footers to each website visited anonymously (HTML blocks are not added to frame-based sites in order to avoid destroying their layout).

You may add a form to visit another URL anonymously or some kind of advertisements (e.g. to offer a free anonymizing service).
 

Other special settings:
 

Click on "Start FreeSurfer" button located on the main admin menu screen in order to work with FreeSurfer. A hard-coded layout will be used which allows having FreeSurfer ready-to-run immediately after installation.

Now type in an URL to visit; FreeSurfer supports HTTP, HTTPS (http://... or https://...) and FTP (ftp://...) based sessions.

Alternative way: Call nph-fs.cgi (FreeSurfer main program) directly from your web browser.

2. By using frames and HTML based forms:

We have prepared a set of sample template files (see within sample/* directory), which are very useful to achieve a custom layout and also makes it easier to work with FreeSurfer by providing a frame based environment.
 

In order to start FreeSurfer, please call index.htm from your web browser (ensure that path in go.htm is correct, see below).

Pre-requisite: Adjust path in the sample files:

Before you can use our pre-defined sample files, open go.htm and adjust the URL to FreeSurfer used in the "form action" tag (please keep all other parts of this tag intact).

Enable or disable user settings:

As you see, the user is able to decide about basic system behavior. If you wish to disallow such individual settings, just remove the appropriate checkboxes from the HTML form located at go.htm.

Technical note: If individual settings are available, these have priority compared with the settings made in the admin panel. You may disable ability of having individual user settings, please refer to the screen "System parameters".

Special applications of the footer file:

Because of the frame based environment, the footer.htm file is not just suited to go back to enter a new URL, but also the right place for holding advertising banners or any other kind of information.

When displaying ad banners in the footer, there is the problem that just one banner is shown regardless of the time people are using FreeSurfer on your system. You can force this frame being reloaded (and so showing new banners) from time to time...

Add the following line somewhere between the <head> </head> tags of footer.htm:
 

<meta http-equiv="refresh" content="{interval};{URL}">

Replace {interval} with the waiting time (in seconds, use positive integers only) till reloading the page. Replace{URL} with the URL pointing to footer.htm.

Usage note: Alternatively you can let display ad banners as headers / footers. See screen "System parameters" for details.

Security notes regarding software usage:

If you wish to sell memberships for using FreeSurfer, then disable the parameter "Allow only admin to use the software" and ensure that the installation is protected (we recommend AccessGuardian from SunnyScript).

Otherwise (e.g. should you intend to use the software for your own purposes only), it is strongly recommended to enable this security setting to prevent that everybody has access to your installation.
 

Now you can navigate through the resource: All links you follow (even form submissions) are called by FreeSurfer to keep your anonymity. So you can almost forget that you run FreeSurfer in the background.

In order to enter a new URL, either close the browser window and click on "Start FreeSurfer (from admin panel) or use the appropriate form to type in the location address to go to (frame based environments or links at inserted HTML blocks).
 

In order to do so, click on "Anonymous mail" link in the top menu line or call anonmail.cgi directly.
 

After you have filled the form completely, click on the button "Send message".

Usage note: Depending upon the settings in admin panel, additional fields may appear at this mailing form.
 

SunnyScript is not liable or responsible how FreeSurfer is used. This software is not intended to hurt existing laws that may apply to you. You take over all legal risks and responsibilities, if you bypass rules which are applicable at your location.
 

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.