doc/REPORTING-BUGS

   1 To report a bug, please fill out the following data and email it to us. I know
   2 it's a little demanding, but without this information, it is nearly impossible
   3 to decipher what is going on:
   4
   5 1. Please describe the problem in a couple sentences:
   6
   7 2. If possible, describe the simplest set of steps necessary to reproduce the
   8    problem. Please also mention whether the problem occurs with both protocols
   9    1 and 2.
  10
  11 3. Prepare to reproduce the problem:
  12     - Compile the server and the client in debug mode: "make debug"
  13     - Ensure you have tcpdump available on your client and server machines
  14     - Clear out htun logfiles on the client and the server so the created
  15       logfiles will be no larger than necessary to show the problem.
  16     - Turn do_routing to off in the client.
  17
  18 4. Please list the following data:
  19     - Real (could be internal) IP address of computer running HTun client
  20     - Proxy server's IP address (i.e., IP address to which the client connects
  21       to access the proxy server
  22     - Real IP address of host running the HTun server
  23     - What type of proxy server are you using? (Please list brand and name of
  24       software if it is a software proxy, or brand and model if it is an
  25       Internet appliance machine)
  26
  27 5. Plesae list the contents of the server's htund.conf:
  28
  29 6. Plesae list the contents of the client's htund.conf:
  30
  31 7. Start the HTun server
  32     - Invoke with the "-d" flag to turn on debug mode
  33     - Ensure that the output is being logged to the logfile
  34
  35 8. Get tcpdump going on the server:
  36     - Find out the name of the external Ethernet interface on your server
  37       machine (likely "eth0"). We will assume eth0 for the example below.
  38     - Find out what ports the HTun server has been configured to listen on
  39       (values in the config are server_port and secondary_server_port). We
  40       will assume 80 and 8080 for the example below.
  41     - Invoke tcpdump with the output redirected to a file:
  42       $ tcpdump -i eth0 -n -s 0 -l -x -X port 80 or port 8080 > /tmp/srv.tcpdump
  43
  44 9. Start tcpdump on the client:
  45     - Find out the name of the external Ethernet interface on your client
  46       machine (likely "eth0"). We will assume eth0 for the example below.
  47     - Find out the port on which the proxy server is accepting the client's
  48       commands (value in the config is proxy_port). We will assume 8080 for
  49       the example below.
  50     - Invoke tcpdump with the output redirected to a file:
  51       $ tcpdump -i eth0 -n -s 0 -l -x -X port 8080 > /tmp/cli.tcpdump
  52
  53 10. Start the HTun client
  54     - Invoke with the "-d -r" flags to turn on debug mode and routing
  55     - Ensure that the output is being logged to the logfile
  56
  57 11. Do the simplest possible action to reproduce the problem (i.e. a ping -c1
  58     from the client to the server VPN IP address is good)
  59
  60 12. Shut down the client with Ctrl+C if it's running in the foreground, or
  61     kill -15 if in the background, and wait for it to exit. If it does not
  62     exit cleanly, kill -9 it.
  63
  64 13. Stop tcpdump on the client
  65
  66 14. Stop tcpdump on the server
  67
  68 15. Shut down the server with Ctrl+C if it's running in the foreground, or
  69     kill -15 if in the background. If it does not exit cleanly, kill -9 it.
  70
  71 16. Email this list of questions filled out, to htun@runslinux.net, with the
  72     following attachments:
  73     - The server's HTun logfile
  74     - The client's HTun logfile
  75     - The server's tcpdump output
  76     - The client's tcpdump output