Main Manual Download Links Contact
Manual


Contents

Part 1. User's manual

Part 2. Admin's manual

Appendixes




Appendix B. Plugins

The description of all plugins from the program package contains names and lists of elements with designations for program configuration files:

Plugin: hyperpool.stream
Service: Speed
Monitoring and limitation of the traffic speed. 
Name: hyperpool.stream.speed
Attributes:

  • client - maximum value in Kb/sec for output traffic
    • 

  • server - maximum value in Kb/sec for input traffic
Service: Dial
Dial-up to provider if connection with a server is lost. 
Name: hyperpool.stream.dial
Attributes:

  • command - command for connection
Service: Terminator
The end of line. 
Name: hyperpool.stream.terminator
Service: Record
Data stream recording into file. 
Name: hyperpool.stream.record
Attributes:

  • dir - folder for saving
    • 

  • size - maximum volume of disk space in MB
Selector: Hours
Select the services line, proceeding from the current hour of day. The default is the first line. 
Name: hyperpool.stream.hours
Elements:

  • list - values list
Attributes:

    • index - line number (start with 0)
    
Elements:

    • value - hour value (0-23)
Selector: Days of week
Select the services line, proceeding from the current day of week. The default is the first line. 
Name: hyperpool.stream.daysweek
Elements:

  • list - values list
Attributes:

    • index - line number (start with 0)
    
Elements:

    • value - day value (0-6, start with Sunday)
Selector: Random route
Select the random services line. 
Name: hyperpool.stream.random
Selector: Try routes
Using search method selects such a line of services, connection to which does not lead to an error. 
Name: hyperpool.stream.try
Plugin: hyperpool.stream.net
Service: In
Waiting of the connection on the specified TCP port, organization of the data exchange between a client and other services. 
Name: hyperpool.stream.net.in
Attributes:

  • port - port for connections
Port and address are specified in options of the client application (browser, mail client etc.).
Service: Out
TCP connection with the specified server for data exchange. 
Name: hyperpool.stream.net.out
Attributes:

  • host - remote server
    • 

  • port - port for connection
Service: In UDP
Waiting of the connection on the specified UDP port, organization of the data exchange between a client and other services. 
Name: hyperpool.stream.net.udpin
Attributes:

  • port - port for connections
Service: Out UDP
UDP connection with the specified server for data exchange. 
Name: hyperpool.stream.net.udpout
Attributes:

  • host - remote server
    • 

  • port - port for connection
Service: Stat
Statistics conducting of the clients traffic volume in each hour. 
Name: hyperpool.stream.net.stat
Attributes:

  • dir - folder for saving
    • 

  • date - number of days for storage
    • 

  • delimiter - fields delimiter
Service: Connections
Monitoring and limitation of the client connections. 
Name: hyperpool.stream.net.connections
Attributes:

  • threads - maximum number of active connections that a single host can make
    • 

  • max - maximum number of simultaneous connections that a single host can make
Selector: Clients
Select the services line, proceeding from client name and value of incoming traffic. 
Name: hyperpool.stream.net.clients
Attributes:

  • def - line number for the not specified names (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic
    • 

  • file - statistics file name
    • 

  • size - value of incoming traffic for the not specified names in MB
    • 

  • baseindex - primary line number

Elements:

  • list - clients list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
    
Elements:

    • name - client name
Параметры:

      • size - value of incoming traffic in MB
Plugin: hyperpool.stream.net.http
Service: Monitor
Monitoring of active connections with web-servers. 
Name: hyperpool.stream.net.http.monitor
Service: Explorer
Preservation of downloaded documents in the specified directory with files structure on a web-server. In XML files values of the http-headers transmitted by web-servers at sending of the required document are kept. Can contain type of the document (the text, the graphics...), its size, time of last change, etc. 
Name: hyperpool.stream.net.http.explorer
Attributes:

  • dir - folder for saving
    • 

  • size - maximum volume of disk space in MB
    • 

  • max - files maximum size in MB
Service: Cache
Use the files directory as cache (see Explorer). 
Name: hyperpool.stream.net.http.cache
Attributes:

  • dir - folder with files
Service: Reconnect
Restoration of connection at breakage, and also in case of a delay at reception of the data in the event that a server supports sending the document in parts. 
Name: hyperpool.stream.net.http.reconnect
Attributes:

  • retry - retries number
    • 

  • timeout - waiting time in sec
Service: Trans
Transformation of inquiry from the client in https-inquiry for connection with the removed server through an external proxy. 
Name: hyperpool.stream.net.http.trans
Attributes:

  • host - remote server
    • 

  • port - port for connection
Service: Document
Replacement of the address in all http requests. 
Name: hyperpool.stream.net.http.document
Attributes:

  • url - address for replace
Service: Log
Log conducting of the http-connections. Print of reports, export in PDF. 
Name: hyperpool.stream.net.http.log
Attributes:

  • dir - folder for saving
    • 

  • date - number of days for storage
    • 

  • delimiter - fields delimiter
Service: Set route
Transformation of inquiry from the client in https-inquiry with the address for "Router" selector. 
Name: hyperpool.stream.net.http.setroute
Attributes:

  • address - route
Service: Reset route
Transformation of inquiry in initial by removal of https-headers. 
Name: hyperpool.stream.net.http.resetroute
Service: Server
Sending of documents to clients, using the http-protocol. 
Name: hyperpool.stream.net.http.server
Attributes:

  • root - root folder
Service: Host
Replacement of the host name in all http requests. 
Name: hyperpool.stream.net.http.host
Attributes:

  • name - name for replace
Service: Replace
Search and replace string in the address of the requested document. 
Name: hyperpool.stream.net.http.replace
Attributes:

  • regex - the regular expression to which this string is to be matched
    • 

  • replacement - the string to be substituted for each match
Service: Unpack
Blocks sending "Accept-Encoding" http header. 
Name: hyperpool.stream.net.http.unpack
Service: Redirect
Send redirect to specified host. 
Name: hyperpool.stream.net.http.redirect
Attributes:

  • name - host name for redirect
Selector: Servers
Select the services line, proceeding from server name. 
Name: hyperpool.stream.net.http.servers
Attributes:

  • def - line number for the not specified servers (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic

Elements:

  • list - servers list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
    
Elements:

    • name - server name
Selector: Ports
Select the services line, proceeding from port value. 
Name: hyperpool.stream.net.http.ports
Attributes:

  • def - line number for the not specified ports (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic

Elements:

  • list - ports list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
    
Elements:

    • value - port value
Selector: Content
Select the services line, proceeding from content type which has arrived from a server. 
Name: hyperpool.stream.net.http.content
Attributes:

  • def - line number for the not specified types (start with 0)
    • 

  • speed - maximum value in Kb/sec for input traffic
    • 

  • baseindex - primary line number

Elements:

  • list - types list
Attributes:

    • index - line number (start with 0)
      • 

    • priority - priority value (0-9, 0-no limit)
    
Elements:

    • type - content type:

      • text
        • 

      • image
        • 

      • audio
        • 

      • video
        • 

      • application
Selector: Agents
Select the services line, proceeding from user agent name. 
Name: hyperpool.stream.net.http.agents
Attributes:

  • def - line number for the not specified agents (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic

Elements:

  • list - agents list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
    
Elements:

    • name - agent name
Selector: Router
Select the services line, proceeding from address in inquiry. 
Name: hyperpool.stream.net.http.router
Attributes:

  • def - line number for the not specified routes (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic

Elements:

  • list - priorities list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
Selector: Hosts
Select the services line, proceeding from requested host. 
Name: hyperpool.stream.net.http.hosts
Attributes:

  • def - line number for the not specified hosts (start with 0)
    • 

  • clientspeed - maximum value in Kb/sec for output traffic
    • 

  • serverspeed - maximum value in Kb/sec for input traffic

Elements:

  • list - hosts list
Attributes:

    • index - line number (start with 0)
      • 

    • clientpriority - client's priority (0-9, 0-no limit)
      • 

    • serverpriority - server's priority (0-9, 0-no limit)
    
Elements:

    • name - host name
Plugin: hyperpool.stream.net.http.html
Service: Switch
TCP connection with a required server, reception from it the data and transfer of them back on a chain of services. 
Name: hyperpool.stream.net.http.html.switch
Service: Tasks
Creation of tasks for downloading documents and sites. 
Name: hyperpool.stream.net.http.html.tasks
Elements:

  • task - task for downloading
Attributes:

    • address - start address
      • 

    • level - level for downloading
      • 

    • start - addresses of references should begin on this value
      • 

    • threads - number of threads for simultaneous downloading
      • 

    • dir - folder for saving
      • 

    • autorun - autorun status:

      • true - enable
        • 

      • false - disable
Service: Message
Sending the message to the client. 
Name: hyperpool.stream.net.http.html.message
Attributes:

  • text - the sent text
    • 

  • theme - page presentation
Service: Antivirus
Scan of incoming files by ClamAV antivirus. 
Name: hyperpool.stream.net.http.html.antivirus
Attributes:

  • host - ClamAV server
    • 

  • port - ClamAV port
    • 

  • buffer - buffer size
    • 

  • theme - message page presentation
    • 

  • dir - folder for reports saving
    • 

  • date - number of days for storage
    • 

  • delimiter - fields delimiter
Service: Banners
Blocking of pictures with the specified sizes. 
Name: hyperpool.stream.net.http.html.banners
Elements:

  • banner - image
Attributes:

    • width - width of banner
      • 

    • height - height of banner
Service: Analyzer
Checking internal and external links of site. 
Name: hyperpool.stream.net.http.html.analyzer
Attributes:

  • dir - folder for saving
    • 

  • level - level for downloading
    • 

  • threads - number of threads for simultaneous downloading
Plugin: hyperpool.stream.net.socks
Service: Switch Socks
Connection with a required server for data exchange. 
Name: hyperpool.stream.net.socks.switch
Service: In Socks
Waiting of the socks connection on the specified TCP port, organization of the data exchange between a client and other services. 
Name: hyperpool.stream.net.socks.in
Attributes:

  • port - port for connections
Port and address are specified in options of the client application.
Plugin: hyperpool.stream.net.smtp
Service: Recipients
Filtration of mail addresses when receiving emails to smtp-server. 
Name: hyperpool.stream.net.smtp.recipients
Attributes:

  • def - status for unspecified addresses:

    • true - on
      • 

    • false - off

Elements:

  • address - mail address
Service: Antivirus SMTP
Scan of incoming messages by ClamAV antivirus when receiving emails to smtp-server. 
Name: hyperpool.stream.net.smtp.antivirus
Attributes:

  • host - ClamAV server
    • 

  • port - ClamAV port
    • 

  • dir - folder for reports and infected messages saving
    • 

  • date - number of days for storage
    • 

  • delimiter - fields delimiter
    • 

  • rcptdelimiter - recipients delimiter
Service: Server SMTP
Receives messages from a client and stores them in the specified folder. 
Name: hyperpool.stream.net.smtp.server
Attributes:

  • dir - folder for saving
    • 

  • max - messages maximum size in MB
Service: Processor SMTP
Distribution of messages to mailboxes for local users and redirection further along chain of messages, addressed to users from other domains. 
Name: hyperpool.stream.net.smtp.processor
Attributes:

  • dir - folder with messages
    • 

  • dirboxes - folder with mailboxes of local users
    • 

  • interval - period for check new messages in sec
    • 

  • retries - counts of send retries

Elements:

  • domain - local domain name
Service: Switch SMTP
Lookup of a name and set of the TCP connection with the smtp-server, organization of the data exchange. 
Name: hyperpool.stream.net.smtp.switch
Service: Copy recipients
Sending a copy of the message to the specified recipients. 
Name: hyperpool.stream.net.smtp.copy
Elements:

  • address - mail address
Plugin: hyperpool.stream.net.pop3
Service: Antivirus POP3
Scan of incoming messages by ClamAV antivirus when receiving emails from pop3-server. 
Name: hyperpool.stream.net.pop3.antivirus
Attributes:

  • host - ClamAV server
    • 

  • port - ClamAV port
    • 

  • dir - folder for reports and infected messages saving
    • 

  • date - number of days for storage
    • 

  • delimiter - fields delimiter
Service: Server POP3
Sending messages to clients. 
Name: hyperpool.stream.net.pop3.server
Attributes:

  • dir - folder with mailboxes

Elements:

  • name - user name
Attributes:

    • password - user password
Service: Antispam POP3
Scan of incoming messages for spam when receiving emails from pop3-server. 
Name: hyperpool.stream.net.pop3.antispam
Attributes:

  • headername - name of the header that is added to the message when spam is detected
    • 

  • headervalue - value of the header that is added
    • 

  • subjectprefix - prefix that is added to the subject when spam is detected
    • 

  • level - trigger level (0-1, the less level, the more messages will be treated as spam)


Copyright © 2014 Victor Zhigunov

RUS