HeXHub 5.01j - The fucking manual

HeXHub

HeXHub is an IOCP-based file-sharing hub and web server with anti-flood protection, built-in firewall designed to filter DDoS and to prevent most common forms of DoS currently used against hubs, anti-spam protection, content filtering and more. HeXHub is licensed under the open source license.

You can download HeXHub from nemesis.te-home.net/HeXHub or from source forge.

The contents of this manual was written by Albu Christian (the HeXHub developer), for your convenience i've 'ported' RTFM_en.txt to a format doxygen understands.

Index:

GUI Options


Hub page

HeXHub GUI - Hub section

DC commands

HeXHub GUI

All commands listed here have 3 parameter groups:

<Connect / reconnect>

HeXHub GUI

$Key

HeXHub GUI

$Supports

HeXHub GUI

$Version

HeXHub GUI

$ValidateNick

HeXHub GUI

$MyPass

HeXHub GUI

$GetNickList

HeXHub GUI

$MyINFO

HeXHub GUI

$GetINFO

No information is available on this subject.

$BotINFO

HeXHub GUI

$ConnectToMe

HeXHub GUI

$RevConnectToMe

No information is available on this subject.

$MultiConnectToMe

No information is available on this subject.

$Search

HeXHub GUI

$SR

HeXHub GUI

$MultiSearch

No information is available on this subject.

$UserIP

No information is available on this subject.

$Kick

HeXHub GUI

$OpForceMove

HeXHub GUI

$To:

HeXHub GUI

Mainchat message

HeXHub GUI

Unknown commands

HeXHub GUI

Unknown data

HeXHub GUI

Appearance

HeXHub GUI

ISPs / Countries

HeXHub GUI

Some hubs may require users to join with a specific prefix other than country or an existing ISP. To do this, you have to declare an ISP with that prefix and IP range 0.0.0.0-255.255.255.255. (example: [TEST]=*) and enable "Prefix required for ISP" option.

Hublist

HeXHub GUI

Troubleshoot

HeXHub GUI

On Hub

HeXHub GUI

Profiles

HeXHub GUI

Profiles page allows you to manage user accounts and banlist. Root items are profile names, accounts / users that belong to same profile you will find as its child nodes. Selecting a profile name or an account allows you to edit its properties. To register a new user select his profile and click "New user". By default, an accont for Owner profile is created for the IP 127.0.0.1.

example:
	Default		access range: 2000-3000		min. share: 1073741824	adm0
	Reg#1		access range: 2010-3999		min. share: 5368709120	adm0
	Reg			access range: 2010-3999		min. share: 5368709120	adm0
	Vip			access range: 4000-4999		min. share: 10737418240	adm0
	KVip		access range: 5000-9999		min. share: 0			adm0
	
In this case if a user joins as Default with a share of 38459235367 bytes, he has enough share to be Reg and Reg#1,
the choice between Reg and Reg#1 would be Reg. From Default to Reg the range is completed and both have share
requirements and adm0 right. Next access range that can complete a higher range has the Vip profile, 
also restricted by share with adm0 and the user has enough share for it. Next would be KVip, it has adm0 but it's not
restricted by share so profile matching stops at Vip with minimum access level for Vip.
If possible, the user is automatically registered or his registration is changed.

HeXHub GUI

Restrictions

HeXHub GUI

In this page you can set some requirements a user needs to join this hub (excepting sharing requirements with the option "users can join but can't download" enabled).

Chat

HeXHub GUI

Extra

HeXHub GUI

Plugins

HeXHub GUI

Forbid

HeXHub GUI

On this page can be configured lists with forbidden words for searches, search results, mainchat messages, user descriptions, command parameters and private messages. Each line from list has a definition. Valid definitions are <word|expression>=action.

Expression can have the following escape sequences:

Valid actions:

Actions may contain _ban_[time] to specify a ban for more information see Operator commands section.

User Menus

HeXHub GUI

On this page can be configured the commands hub sends to users and/or operators. Menu structure can be seen as a treeview.

Web

HeXHub GUI

On this page you can define your web shares. To be able to share something, you need to declare at least one host.

Raw commands, welcome message file and MOTD


Raw commands, welcome message file and MOTD

These are the accepted variables that can be used in raw commands, welcome message file and MOTD:

For example:

Hi %[nick] welcome to my hub, your IP is %[ip]

Hub commands (triggers and commandline parameters)


Hub information commands

Example:
<Bluebear> !seen Hublink
<Bluebear> [command] !seen Hublink
*** Showing information on user Hublink:
	x.x.x.x, connected: 2008-05-24 06:24:36 still online
*** The following users were found at www.qsdchublist.com
	DCHublink	vanersborg.nobodys-network.se:411
	Hublink	sky-net.te-home.net:411
	DCHublink	MegaStar.no-ip.info:411
	DCHublink	typiskt.no-ip.info:411
	[-TE-]-Hublink	wwbhangra.te-home.net:411
	DCHublink	troligen.no-ip.info:411
	Hublink	Roma.Rome-Empire.Org:666
	Hublink	megahex.te-home.net:411
	[-TE-]-Hublink	nemesis.te-home.net:411

Commands for messages

The !say and !write commands can't be used with the nickname of an already connected user (except the robot).

Example:
<Bluebear> !rename nick1 nick2
<Bluebear> [command] !rename nick1 nick2
*** Bluebear is renaming nick1 to nick2

Operator commands

The !say and !write commands can't be used with the nickname of an already connected user (except the robot).

You can add _ban[level]_[count][unit] keyword in !kick and !ban reason to specify a temporary ban or a permanent ban. Default is ban level 2. A nick prefix end with "*".

Example:

<Bluebear> !kick test _ban1_3d

Profile management commands

For commands that have an output limited by maximum results you can append the starting index to command name (eg.: !reg10 vip). <Target> can be nick / IP / IP range / ISP / registration ID.

Command line parameters

Command line parameters are given at start up. e.g. c:\> hexhub.exe /NOSEH

Updating the GeoIP database


Updating the GeoIP database

To update the GoeIP database you must do the following steps.
  1. Download GeoIPCountryCSV.zip from http://www.maxmind.com/download/geoip/database/GeoIPCountryCSV.zip
  2. Extract GeoIPCountryWhois.CSV from GeoIPCountryCSV.zip in the IPTest directory
  3. If you want to edit the IP ranges from GeoIPCountryWhois.CSV be sure all ranges remain sorted.
  4. Execute csv2dat.exe and it will do the following:
  5. Stop HeXHub and close the program
  6. Overwrite GeoIP.dat located in HeXHub's directory with the new ones from IPTest
  7. If you have HeXHub 3.22 or later, no changes are needed to hexhub's sourcecode.
    If you have HeXHub older than 3.22 you need to do the following:
  8. Delete ips.dat from HeXHub's directory
  9. Restart HeXHub
  10. All country-related settings may be changed so you need to update them (!set isp)

Generated on Thu Aug 21 09:21:43 2008 for HeXHub/HexScript by  doxygen 1.5.4
Site hosted by SourceForge.net Logo