home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 2 / AUCD2.iso / internet / proxy.spk / !ProxySrvr / docs / Advanced next >
Text File  |  1996-05-09  |  8KB  |  223 lines
  1.          /-----------------------------------------------------\
  2.          |                                                     |
  3.          |   RISC OS Proxy Server © Chris Audley, 1996         |
  4.          |                                                     |
  5.          \-----------------------------------------------------/
  6.  
  7.  
  8.                             Installation
  9. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10. The Server (The machine with the internet connection)
  11. ----------
  12. Installation is very simple... Double click on the !ProxySrvr icon. 
  13. Or make sure that it gets run somewhere in the Boot sequence (preferablly
  14. after the internet stack has been started)
  15.  
  16. *** BUT *** Don't do this until you have read the configuration section.
  17.  
  18. The proxy server is implemented in a module, which provides several commands,
  19. mostly giving information about the current status.
  20.  
  21. The module requires an internet stack and a resolver module to operate
  22. properly. It was developed on a RiscPC using ANT's !InetSuite, I don't know
  23. if it will work with any other machines/stacks, please contact me if it 
  24. doesn't and I'll try to sort out any problems.
  25.  
  26. The config file should be in the !ProxySrvr directory, but if it is missing
  27. the proxy will use default values instead.
  28.  
  29.  
  30. The Clients (All the other networked machines)
  31. -----------
  32.  
  33. You need to tell your WWW browsers and terminal programs how to use the proxy
  34. server.
  35.  
  36. In the case of WWW browsers you need to tell them the hostname of the proxy
  37. server, and the port number that the http 'ear' is running on (see below for
  38. info on configuring the port number). Look in the docs for your particular
  39. browser to find out how to do this.
  40.  
  41. With terminal programs you specify the hostname of the proxy server, and
  42. the telnet 'ear' port number.
  43.  
  44. With FreeTerm, this is specified in a seperately from the hostname.
  45. With AntTerm, you need to follow the hostname with the port number, seperated
  46. with a ','
  47.  
  48. From the * prompt, you can type  *telnet <hostname> <portnum>
  49. to connect to the telnet proxy.
  50.  
  51.  
  52. When you do connect, you will be prompted for the name of the host to connect
  53. to. If the host cannot be resolved, you will be prompted again for a
  54. hostname. Pressing return on a blank line will terminate the telnet session.
  55.  
  56. Should you want to telnet via the proxy to a host on any port other than 23,
  57. you should enter the hostname as follows:
  58.  
  59.      <host name>:<port number>
  60.  
  61.  
  62.  
  63.                             Configuration
  64. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  65.  
  66. The proxy server has been designed to be very configurable, to allow for
  67. different system setups. Consequently the configuration file might look a bit
  68. daunting on first inspection.
  69.  
  70. However, unless you have specific needs, it is unlikely that you will have to
  71. change much.
  72.  
  73. Also note that there are a lot of configuration options which are not
  74. supported in this version (see the release section for more details).
  75. These are included for easier upgrading, but are marked as not being
  76. supported.
  77.  
  78. The rules the proxy server follows for reading configuration data are:
  79.  
  80.     i) Option names should start with a '%' and end with ':'
  81.  
  82.        ii) Data for the option is read when the first alpha-numerical
  83.            character is encountered after a return, newline  or a ':'
  84.            
  85.       iii) Data segments end with newline or return characters.
  86.       
  87.        iv) Lists of data are terminated with a comment char '|' or a '%'
  88.        
  89.        
  90. These are all valid configuration items
  91.  
  92. | Comment
  93. %config.item: Some Data     
  94. |Comment
  95.  
  96. | another comment
  97. %another.item: some       
  98.                data       
  99.                which      
  100.                is_read    
  101.                as_a
  102.                list
  103.                
  104. %more.options: 12         
  105.  
  106.  
  107. This is **not**
  108.  
  109. |Comment
  110. %config.item: Date    |Comment  
  111.  
  112.  
  113.  
  114. Configuration Options
  115. ---------------------
  116.  
  117. Incoming ears: These are the ports that the proxy server listens for
  118.                requests on.
  119.                
  120.                You should set the proxy port number in the proxy setup for 
  121.                your web browser to this number, and the proxy host name
  122.                to the name or IP address of the machine the proxy is
  123.                running on.
  124.                
  125.                For the telnet server you need to telnet to the host on the
  126.                telnet ear e.g *telnet quercus 8023
  127.                
  128.            Theses options have been set to sensible port numbers,
  129.            so you shouldn't need to alter these.
  130.            
  131.                
  132. Enabled Proxy  These set whether a certain a proxy ear is enabled, 0 for off 
  133.               1 for on. Usefull if you only want to run the telet of http
  134.               proxy.
  135.  
  136.               
  137. Machine type   Guess what, the type of machine that the proxy is running on.
  138.            This is for displaying in the 'Unknown Host' page sent back
  139.            to the WWW browser when a page is requested from an unknown
  140.            host.
  141.  
  142.            
  143. Web Admin      Again for display in the unknown host page.
  144.  
  145.  
  146. Max requests   This sets the maximum number of connections that are allowed
  147.            to the proxy server. The higher this is the more load that can
  148.                potential be placed on the serving machine.
  149.  
  150.                Note, the Acorn stack has a max of 96 sockets and the freenet
  151.                stack has a max of 128 socks, so you can't really have more
  152.                than 50 connections active.
  153.  
  154.                
  155. Buffer Size    This is the size of the buffer used for transfering data.
  156.            The larger this is the faster data will be transferred (in
  157.                theory).
  158.                
  159.                Note: Some web browsers appear to have problems when buffers
  160.                      larger than 1K are used. These manifest themselves in 
  161.                      corrupted interlaced GIFs.
  162.  
  163.  
  164. Poll Time      This value is the time between polls in centiseconds. The
  165.                smaller it is, the faster sockets will be polled and the
  166.                faster data will be transferred, but the more load will
  167.                placed on the serving machine. 
  168.                For a small network, wanting low load on a Risc PC 600, 
  169.                25 is recommended.
  170.  
  171.                
  172. Debug Level    Sets the amount of data written to the debug file.
  173.            0 - off
  174.            1 - on (lots of it)
  175.  
  176.  
  177.                
  178. Log Dir        Where the all the logging files are stored
  179.  
  180. Log options    0 - Everything in ProxyLog
  181.                1 - Logging in ProxyLog, debuggin in ProxyDebug
  182.                2 - Each sort of request in its own file ie http, ftp etc.
  183.         
  184.         
  185. External network checking  (%ext.net.check, %ext.net.check.host)
  186.                The proxy server checks for an external network connection
  187.                by sending echo requests to an external host.
  188.                If it gets a reply, obviously the host is reachable and
  189.                a connection exists.
  190.                
  191.                If you want to use this set %ext.net.check to 1, if not set 
  192.                it to 0       
  193.        
  194.                If you are using it you must specify a remote machine to
  195.                send echo requests to.
  196.                
  197.                The address placed in %ext.net.check.host must be in quad 
  198.                notation  (e.g 1.2.3.4)
  199.               
  200.                I recommend you use one of your Internet service providers 
  201.                news or mail servers for this. You can probably find this out 
  202.                from the documentation from your Internet Service Provider, 
  203.                or your login script.
  204.  
  205.  
  206.                         Module Commands
  207. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  208.  
  209. The only commands that should be used are:-
  210.  
  211. ProxyStatus:     Display info about proxy status
  212.  
  213. ProxyLimit:     Changes the value of max requests. 
  214.                  Allows you to limit the number of requests allowed hence
  215.                  reducing load on the machine.                         
  216.  
  217.                  
  218. Other commands may be reported by *help proxyserver, but they are not
  219. implemented.         
  220.  
  221.  
  222.         
  223. Chris Audley, Thu 09th May 1996