home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / ijlog_10.zip / ReadMe.txt < prev    next >
Text File  |  1999-02-13  |  8KB  |  204 lines
  1. ReadMe.TXT
  2. 13. februar 1999
  3. In-Joy firewall Logreader v1.0
  4.  
  5.  
  6.  
  7.  
  8.  
  9. Contents:
  10.      I.   Introduction
  11.      II.  Installation
  12.      III. Usage
  13.      IV.  Trouble shooting
  14.      V.   Contact information
  15.      VI.  Greets
  16.      VII. Disclaimer
  17.  
  18.  
  19.  
  20.  
  21.  
  22. I.   Introduction
  23.  
  24.      This is CardWare. If you use it, send me a postcard.
  25. SnailMail address is to be found near the bottom of this file.
  26.  
  27.      This piece of software (actually pieces of software) is a
  28. collection of scripts and HTML files for use with In-Joy 2.0
  29. with the firewall plug-in and a HTTP-server. The purpose of
  30. this program is:
  31.      - Maintain a user database
  32.      - Read/interpret the log files from In-Joy's firewall
  33.      - Present information in HTML format through the HTTP-
  34.      server
  35.  
  36. This doesn't say much about the intended use of the program,
  37. so here's an example scenario:
  38.  
  39.      Let's say you have a computer running In-Joy, using NAT
  40. (masquerading) to share your internet connection with other
  41. computers on a LAN. If you live in Norway or another country
  42. where the telecom company charges you for the time you spend
  43. on-line, you might wish to share the costs of the Internet
  44. usage among all the computers (users).
  45.      In-Joy with it's firewall plug-in features some kind of
  46. logging, but their contents are not formatted in a way that
  47. make them suitable for providing this kind of information.
  48.      That's where this product comes into the picture: It uses
  49. a userfile that contains the IP-address, name, address, amount
  50. of money paid by the user, and the amount of time units spent
  51. on the internet. It then reads the log files from In-Joy at
  52. any interval (you need some kind of scheduler program to do
  53. this - rsched is included in the archive), and updates the
  54. userfile with the information it gets here.
  55.      The information in the userfile can be viewed via
  56. Netscape or any other browser by running the included HTTP-
  57. server (web/2 by dink - http://dink.cx). Here you will find a
  58. list of the users that have been on-line during the last time
  59. interval, and you will find a list of users where you can
  60. select to view information on this one user. This information
  61. includes IP-address, name, address, amount of money paid, time
  62. spent on-line, and the current balance for the particular
  63. user.
  64.      In addition, the userfile can be administered via this
  65. HTTP server too. The admin pages contains the following
  66. functionality:
  67.      - View statistics for the system
  68.      - View list of "unauthorized" IP-addresses (not in the
  69.      userfile)
  70.      - Add, remove and edit users in the userfile
  71.      - Adjust the usage or balance of all users at once, in
  72.      percent or exact values
  73.      - Set or reset the values for all users
  74.  
  75.  
  76.  
  77. II.  Installation
  78.  
  79. Prior to installation, there's some steps you have to carry
  80. out:
  81.      - Install a registered version of In-Joy 2.0. This is
  82.      necessary since the firewall isn't enabled/included with
  83.      non-registered versions.
  84.      - Install the web server included in this package, if you
  85.      haven't already. If you have another web server
  86.      installed, please read further down, where this is
  87.      discussed in detail. IMPORTANT: Make sure the web server
  88.      you use points to the directory where you choose to put
  89.      the main script and the HTML files (see below) as the
  90.      root directory! With WEB/2 this is done by running the
  91.      SETUP program that comes with it. With Apache or any
  92.      other web server, refer to its documentation.
  93.      - Install the scheduler program included in this package,
  94.      or use any other scheduler that supports running programs
  95.      at specific intervals.
  96.  
  97. In addition, you must create all the directories needed by
  98. this package. They include:
  99.      - Directory for the main script and the HTML files
  100.      (suggested: \in-joy\logread).
  101.      - Directory for the data files
  102.      (suggested: \in-joy\logread\data).
  103.      - Directory for the scripts to be used by the web-server,
  104.      normally this will be the cgi-bin directory.
  105.  
  106.      As soon as you have these things done, run SETUP.CMD with
  107. the INSTALL parameter, like this: "SETUP INSTALL". This will
  108. ask you where you want to place the different files, and where
  109. the cgi-bin directory of your web-server is placed. Make sure
  110. you get all of these directories right.
  111.      It will later ask if you want to install a sample
  112. userfile. Note: This will OVERWRITE ANY EXISTING USERFILE! So
  113. if this isn't the first time you install the package, please
  114. make sure you don't overwrite your existing userfile with the
  115. sample one.
  116.      You will then be asked how much you wish to charge per
  117. time unit. One time unit is the time between each time the
  118. script is run, e.g. 15 minutes. Since you at no point tell
  119. this package how long time intervals you wish to use, you have
  120. to decide this before installing it, and make sure your
  121. scheduler program runs the main script at these intervals. The
  122. value is to be entered with . as decimal separator, e.g. if
  123. you want to charge $0.10 per time unit, enter 0.10 here.
  124.  
  125.  
  126. Use with other web servers
  127.      What if you have another web server installed than the
  128. one included here? Well, first you have to figure out the
  129. WORKING DIRECTORY of the web server when it's running the
  130. scripts. The reason for this is that the scripts used by the
  131. web server looks for a configuration file in the CURRENT
  132. DIRECTORY.
  133.      WEB/2, the server included here, has it's working
  134. directory set to it's MAIN directory, no matter what files
  135. it's sending to the browser. That means that the install
  136. script copies the config file both to the cgi-bin directory
  137. AND to its parent directory. If the working directory of your
  138. web server is anything else than the cgi-bin directory OR its
  139. parent directory (cgi-bin\..\), copy the configfile,
  140. logread.cfg, there manually.
  141.  
  142.  
  143. III. Usage
  144.  
  145.      Use any browser (Netscape, Gecko, Opera, WebEx, Lynx,
  146. Arena, whatever) to access the main page of the server. The
  147. pages you see here is the pages that all your users should be
  148. able to see. They include the information about who is using
  149. the internet connection right now, and per-user statistics.
  150.      The administration pages can be accessed by specifying
  151. "/admin.html" in the address field, after the host name. This
  152. isn't password protected yet; this will come in a future
  153. version. So just make sure your users don't know of this
  154. file...
  155.      The pages should be self-explanatory.
  156.  
  157.  
  158. IV.  Trouble shooting
  159.  
  160.      Problems? Try to figure it out yourself! The sourcecode
  161. is there, read it. If you still have trouble, mail me, but
  162. don't count on a reply... :)
  163.  
  164.  
  165. V.   Contact information
  166.  
  167. SnailMail:
  168.      Eirik Overby
  169.      Mekvn. 15D2
  170.      N-6400 Molde
  171.      Norway
  172.  
  173. EMail:    ltning@mo.himolde.no
  174. Web:      http://www.mo.himolde.no/~ltning
  175. IRC:      Ltning / EFNet
  176. ICQ:      24042847
  177.  
  178.  
  179. VI.  GreetZ
  180.  
  181. gemini    - thanx for install.cmd ;)
  182. SalvaMea  - for needing this thing in the 1st place
  183. AlterEgo  - for sitting here, bored, while I was writing this
  184. #kvamnett - for abusing this thing
  185. #os2warez - for doing nothing to encourage me, except
  186. MrWizard  - umm.. finnish?
  187. evtwin    - he actually tried this thing..
  188.  
  189.  
  190. VII. Disclaimer
  191.  
  192. Usual stuff. Use this at your own risk. I have no
  193. responsibility whatsoever for any bad things this will do to
  194. you, your family, your wife/husband, your lover, your
  195. computer, your data, your... anything.. Seriously. But
  196. ofcourse, if you earn millions of bucks from this, let me know
  197. and take part in that.. ;)
  198.  
  199. Now get lost.
  200. Thanks for reading.
  201.  
  202. GreetZ,
  203. -Ltning
  204.