HyperGate URLs

Individual documents, scripts, or other HTTP resources can be made HyperGate accessible simply by changing their links.  The advantage to using HyperGate URLs is that clients can quickly download and run HGclient, usually without any configuration or setup, to have instant access to your HGserver.  The disadvantage is that you must create a HyperGate URL for each individual document that you wish to be accessible via HyperGate.

For a simple installation, a HyperGate URL is constructed from an existing URL by adding “127.0.0.1:8088/” before the server name, and replacing the slash “/” after the server name with a semi-colon “ ;”.  For example,

http://server/document-path

becomes

http://127.0.0.1:8088/server;document-path

This simple example assumes that the HGclient will be running at port 8088 on the same workstation as the web browser, and that the HGserver is running at port 8083 on the same CPU as the web server.  For more sophisticated uses consider the following rewrite rule.

Original URL:

http://server_n[:server_p]/pathname

HyperGate URL:

http://hgc_n:hgc_p/hgs_n[:hgs_p];[server_n[:server_p];]pathname

The various components are defined by your particular setup as follows:

hgc_nDNS name or IP address of the HGclient CPU.  If HGclient will be running on the same workstation as the web browser, then set this to 127.0.0.1.
hgc_pPort number of the HGclient application.  By default, this should be 8088.  But a different port may be used by specifying the “-p” option or “Port” variable when HGclient is installed or run.
hgs_nDNS name or IP address of the HGserver CPU.  If HGserver is running on the same CPU as the web server, then this is just the web server’s address.
hgs_pPort number of the HGserver application.  By default HGserver runs on port 8083, but this may be changed by using the “-p” option when installing or running HGserver.  You can leave out hgs_p, and HGclient will assume 8083.
server_nDNS name or IP address of the web server that HGserver should connect to for the document.  This can be used if HGserver is running on a different CPU than the web server, or there are multiple web servers being served by a single HGserver.  You can leave this value out of the URL by setting it in the HGServer using the “-h” option or “Host” variable.  By default, 127.0.0.1 is used, for the case where HGserver is on the same CPU as the web server.
server_p Port number of the web server that HGserver should connect to for the document.  If this is not specified in the URL, the HGserver will use the value given in its “-h” option or “Host” variable.  If no such option was given, it will use port 80.
pathnameThe pathname component of the document’s direct URL.

For example, if the original or direct URL were:

http://www.abccompany.com/documents/bigfile.dat

the HyperGate URL (assuming default on-CPU installation) would be:

http://127.0.0.1:8088/www.abccompany.com;documents/bigfile.dat

The regular links for each document will continue to work along side the HyperGate links, allowing you to server both HyperGate and regular clients.