|
|
The optional Configuration File
| |
Most of the Guidescope software's behavior is controlled by its optional Configuration File.
Proxy Chaining and Debug options can also be set from the browser's
"location" bar or "address" bar, as described below.
Basic installations don't have a Configuration File and use default settings instead.
A Configuration File can be added to any installation of the Guidescope
software simply by placing a text file named "guide.txt" (or "guide.ini") in
the Guidescope install directory. Entries in the Configuration file
override the default settings.
|
|
Configuration Options
| |
The Configuration File contains one or more commands, each on a separate line.
Configuration options are listed in the table below.
|
|
Listen Address
|
The Guidescope software listens by default to "localhost", which is address
127.0.0.0
on port 8000 .
You can tell the software to listen to a different address using the
"listen-address" directive:
|
listen-address address:port
|
For example, if your computer's network address is
192.168.1.1:8000, you would enter the following line into your Configuration File:
| listen-address 192.168.1.1:8000 |
This feature allows you to connect multiple computers to a single copy of our software by
setting the HTTP proxy address:port settings in their browsers to match the
listen-address settings.
|
Proxy Chaining
|
The Guidescope software can forward to another proxy, supporting proxy chaining. This
enables sophisticated network setups, as described in System Administration.
Specify a forwarding proxy name by sending your browser to the special URL
"http://set.proxy/address:port", where
"address" and "port" are the
address and port of the proxy that you want to forward (connect) to.
You can type this URL into Netscape's "location" bar or IE's "address" bar.
To cancel the proxy chaining, enter the special URL: "http://set.proxy/none".
To disable this browser-bar feature for your users, add the line to your Configuration File:
|
disable-user-proxy-config
|
Even if this browser-bar feature is disabled, any forward.ini file
that exists in the directory in which the Guidescope
software is installed will remain active.
| |
"Referer"
|
The Guidescope software is capable of automatically clearing the "referer" from your
browser's header.
(More information on optional handling of referers is here.)
You can specify the behavior for referers in your Configuration File. This is
useful for determining which style of referer is required by a particular site:
| Entry | Behavior
|
referer &
referrer &
|
The referer is always always filtered by replacing it with the URL of the current request.
(This style makes many weather sites happy, but confuses others.)
|
referer !
referrer !
|
The referer is always cleared. (This style will not satisy sites that require referers.)
|
referer .
referrer .
|
The referer is not filtered, but is passed untouched.
For testing purposes, this should satisfy all sites that require referers. Turning
Ad Blocking off also causes referers to be passed untouched.
|
(Either spelling of "referer" works the same.)
| |
Debug Options
|
The Guidescope software will print status and debugging information to the
console when you enable the
"debug" option in the Configuration File:
where "option" is one of:
| Option | Debug Behavior
| | gpc | prints one line for each HTTP GET POST or CONNECT
| | con | provides information about the progress of each connection
| | io | provides information about I/O errors
| | hdr | displays HTTP header processing
| | rf | reports on the interaction with the Remote Filter server
| | cred | reports on the interaction with the Guidescope server that affects proxy credentials
| | log
| displays the headers and content of all I/O
between the Guidescope software, the browser, and the Web servers. This is very verbose
and will likely contain a great deal of non-printable ASCII.
This is usually used only in combination with the Configuration File
"logfile" option described below.
|
You can also specify debug options by sending your browser to the special URL
" http://set.debug/option[ /option]", where
option is one or more from the above list.
You can type this URL into Netscape's "location" bar or IE's "address" bar.
To cancel all debugging options, send your browser to the special URL
" http://set.debug/none".
To disable this browser-bar feature for your users,
add the line to your Configuration File:
|
disable-user-debug-config
|
| |
Logfile
|
Instead of directing debug output to the
console it is possible to have it directed to a file.
The "logfile" option lets you specify the file name:
For example, if you wanted to redirect the console output to a file named
"logfile.txt",
you would enter the line:
| |
User Agent
|
Your browser reports the type of browser you are using to Web sites through the "user-agent"
that it sends in its header. Our software replaces it only if you specifically set the
"user-agent" option in your Configuration File.
We recommend that you not set the user agent because many
Web sites now present content that is formatted differently depending on your user agent. They do
this to work around browser bugs and differences in browser behavior. Of course, if you want to
hide your user-agent, you can do so. The command is:
|
Outgoing Address
|
The "outgoing-address" option can be used to specify the outgoing
binding address for multi-homed hosts:
For example, if you
wanted to report your outgoing address to Web servers as "www.new_name.com" you would add a line
to your Configuration File:
|
outgoing-address www.new_name.com
|
| |
Login Key Hashing
|
The Guidescope software uses an MD5-hashed version of each user's IP
address to uniquely identify each user sharing your Guidescope proxy.
To hide your internal IP addresses from Guidescope.com, add the line to
your Configuration File:
The "keystring" that you specify
is concatenated with each user's IP address before applying the MD5 hash, thereby preventing leakage
of your internal IP addresses to Guidescope.com.
| |
Default File Names
|
The Guidescope software uses other files to store information and control
its behavior. These files have built-in default names which can be reassigned
using Configuration File options:
| Option | Default File Name
| | blockfile | block.txt
| | forwardfile | forward.txt
| | aclfile | acl.ini
| | cookiefile | cookie.ini
| | trustfile | trust.ini
|
For more information on the blockfile, see
A Local Block File.
For more information on the forwardfile, see
System Administration.
The last three files listed above, aclfile, cookiefile, and trustfile, are provided for
backwards compatibility with the
Internet Junkbuster, and are not generally used.
If one of these files is specified in your Configuration File but the specified file does not exist,
then the Guidescope software silently ignores the missing file.
|
|
