» Administrative Options

Checking environment

System requirements

  • PHP 5 or greater. You have version 5.2.6.
  • cURL enabled. You have cURL functions available.

If you wish to use the caching feature, you will also need additional disk space for storing cached files and permission to carry out file operations.

Setup script requirements

  • PHP must have read and write access to the /includes/settings.php file and this script must be uploaded into your main proxy directory. The configuration file is readable and writable.

You can run this script on your server.

To begin, please click one of the below headings to jump straight to a specific section of the setup wizard. If you are running this script for the first time, you are recommended to work through every section to familiarise yourself with the script's features and options.

Installation options

Site Name

Site layout/skin/theme

Use GZIP compression


Enable Plugins


Encode Index Page


Download Filesize Limit

MB (use 0 for no limit)

License Key (if applicable; see glype.com to buy a license)

(This allows you to remove the copyright. Leave blank if you are not using a licensed version.)

Footer Include

The following options relate to your proxy's URL structure. The ability to use path info based URLs will depend on your server configuration. To test if you can use this format of URL, make a request for setup.php/somepathinfo instead of just setup.php. If the setup script loads, you can use this option on your server.

Use Path Info


Unique URLs


Important! As the proxy owner, you are responsible for all requests coming from your IP address through the proxy service. In cases of abuse, you may be required by law to provide the originating IP address for a particular request. If you enable the unique URLs option, you may be unable to decode your server access log. For this reason we strongly recommend that you enable the logging feature to capture the target URLs.

Stop Hotlinking


If you have the above option enabled to prevent hotlinking, you may also specify domains that will be permitted to hotlink (for example, your own sites if you ever wish to link directly to a proxified page). Please enter the domain names below, one per line.

Hotlink Allowed Domains

User security: the proxy allows users to browse sites that would normally be protected by a secure connection. The proxy fetches pages securely but may then transmit them back to the user over an insecure connection. If you run your proxy on a HTTPS connection, this option will have no effect.

Warn users about insecure connection


Cache Options

This section relates to the caching feature. In order to use the cache, the proxy script must be able to create files within the /cache/ directory.
We have detected the cache directory is writable. You may use the caching feature.

Enable caching


Cache file types

Full path to cache folder

Full URL to cache folder

Caching Method

A full caching sytem involves creating additional overhead that may even counter-act any benefits from the cache. The normal browser caching will still occur - therefore the proxy cache will only be beneficial when more than one user requests the same page at the same time. If you have access to CRON jobs, you can cache all files and use the cache control script to regulate disk space usage. This is the preferred option. Alternatively, you can use a limited list of websites that files should be cached for if this is not possible.

Cache all websites


If the above option is set to "no", only this list of sites will be cached (one domain per line)

Cache Control Script (CRON)

If you have enabled the cache all websites option, you must set up a method for controlling the size of your cache otherwise it will grow indefinitely until you run out of disk space! The proxy comes with a clearcache.php script in the /tools/ directory. It is intended to be run regularly and automatically, for instance via a CRON job. This is usually available through your hosting control panel. You will need to upload the script to a location of your choice (preferrably above your webroot to avoid unauthorised, malicious use) and call it with two parameters:

clearcache.php?path=*hidden*&cachesize=500

Replace 500 with the desired size in MB of your cache. On execution, the script will then trim down your cache folder to the given size. You must decide how often you need the script to run and setup the CRON job as appropriate.

Note: The script calculates total filesize of your cache directory. This will be less than the space used on disk by the cache folder, so you may be using more space than you think.

Restrict Allowed Sites

There are two methods of restricting access to particular websites through your proxy. You can either use a whitelist, in which case only the sites on the list will be accessible, or you can use a blacklist (where all sites except those on the list are accessible).

Usage examples:

  • glype to match any URL with "glype" in it
  • glype.com to match the whole glype.com site
  • glype.com/downloads/ to match every page within the 'downloads' directory
  • sub.glype.com to match only the subdomain "sub"
  • glype.com/downloads/index.php to match only the /downloads/index.php page

Enter one site or page per line.

Whitelist

Blacklist

Restrict Users

Ban individual IP addresses (one per line)

Ban IP address ranges (one per line; use dash (-) to separate range, e.g. 12.34.56.78-90.123.456.78)

Logging

If you need to track your users access (recommended in case of illegal activity undertaken from your IP address), you may enable logging. If you have the unique URLs option enabled, this logging feature records the unproxified URLs of pages visited. If you do not have unique URLs enabled, your server access log can be used and will perform better. Important: if you are logging user activity, you are strongly advised to have a clear privacy policy on the site.

To use the logging feature, enter a path below to record data. If you wish to log all data to a single file, enter the path to the file. If you wish to use a separate file for each day (named YYYY-MM-DD.log), enter the path to a folder with trailing slash. The file or folder specified must exist and must be writable. CHMOD to 0777 may be required.

Your log files should be private. Either set the log destination above the webroot to prevent direct access or place in a password protected directory.

Log destination

(leave blank to disable logging)

Log all requests


Log until...

hours from now (set to 0 for no time limit)

Parser Options

Proxify these attributes (seperate with pipe | symbol)

Remove elements (seperate with pipe | symbol)

Parse unknown content types


Replace badwords (one per line)

Internal Options

These options control the internal operation of your proxy - the name under which cookies are sent, the name given to the session and the timeout values passed to cURL for the transfer. You will most likely not need to modify these.

Session name

Cookie prefix

Connection Timeout

seconds

Transfer Timeout

seconds

User Configurable Options

These are options that are available to the end user on your proxy index page and the included form on each proxified page. You can remove the user's choice by setting the "Force" checkbox. The default value will then always take effect. You can also change the text displayed to describe and explain each option to the user.
Title Default Description Force









(disabled)

Password Protect Setup

For obvious security reasons, once finished with this script you should delete it. If you must keep this script online, you may specify a password above. You are still strongly advised to delete this script and you will be solely responsible for any unauthorized use.
Copyright © 2006 glype.com, all rights reserved
Design by Matthew "Chaos Element" McGee