/===============================\
        |     _____    ___    ____      |
        |    | ____|  |_ _|  |  _ \     |
        |    |  _|     | |   | |_) |    |
        |    | |___    | |   |  __/     |
        |    |_____|  |___|  |_|        |
        |                               |
        \===============================/

Full Name     : EIP -- Easy IRC Proxy
Author        : Pascal Gloor <pascal.gloor@spale.com>
Version       : 1.0
Last revision : 13.11.2004



  1. CONFIGURATION

    1.1 CONFIGURING eip.conf

      This configuration file can contain a few dire-
      ctives described below. Its format is:

      DIRECTIVE:VALUE


      1.1.1 IP_ADDR

        Local ip address to bind for incoming connec-
        tions.

      1.1.2 PORT

        Local port to bind for incoming connections.

      1.1.3 USER_CONF

        Relative path to the user configuration file 
        (See 1.2).

      1.1.4 LOGFILE

        Relative path to the EIP log file.


    1.2 CONFIGURING users.conf

      This file allows users to use the IRC Proxy.  
      Each user must be defined with the following
      syntax:

        user:<username>:<password>

      NOTE: The password MUST be clear text!

    1.3 RELOADING users.conf

      You may reload the users.conf configuration fi-
      le 'on-the-fly'. Simply: 

        unixprompt% touch users.conf.reload

      SIP will then reload the users.conf and delete
      the users.conf.reload file.

      NOTE: if you remove a user which is currectly 
            connected, the user will NOT be disconec-
            ted!!


  2. REQUIREMENTS

    You MUST have perl 5.6.1 or above to run EIP.


  3. HOW IT WORKS

    The user connects to the ip address and port def-
    ined in the eip.conf configuration file with his 
    favourite IRC client. Once connected he gets pro-
    mpted to send his username and password using the
    irc command:

      /QUOTE AUTH <username> <password>

    If the authentication fails, the user will be di-
    sconnected.

    Once the authentication is done the user will be
    prompted to enter the irc server hostname, port 
    and an optional password to be able to connect 
    to his favourite IRC network using the following
    command:

      /QUOTE IRC <hostname> <port> [optional password]

    NOTE: The authentication phase will timeout after
          30 seconds and the user will be disconnect-
          ed.

    When the user ends his chat session EIP will ALSO
    disconnect from the IRC Server.


End-of-File