Welcome to Verlihub-0.9.8d. This manual has been modified for Verlihub-0.9.8d but should degrade well with previous versions.
Please rememeber this is a reference manual specifically aimed at explaining the operations and functions of Verlihub as a whole and is not a distribution specific guide. For help with specific distributions you should visit the verlihub forums locatred here.
Further references and examples can be obtained from the Verlihub wiki which can be found here.
Script | Description |
vh_getcfg | Run this script and see which configuration folder verlihub is most likely to use |
vh_runhub | start, stop, restart verlihub as a daemon; creates log and err files; displays missing files |
vh_getdb | Finds the dbconfig files and parses it, then allows you to do multiple things with that information such as: connect; query; gethost; getdata; getuser; getpass |
vh_regnick | Creates a registered user |
vh_trigger | Creates a file_trigger |
Configured with install script | ||||
Variable | Explanation | |||
listen_port | The port the hub listens on. Other hubs use port 411, but you need to run verlihub as root to do that. Default: 4111. | |||
hub_host | What people will use to connect to your hub. (An example: myhub.no-ip.com) | |||
hub_name | The name of your hub. | |||
Not configured - you may need to configure these | ||||
Variable | Explanation | |||
listen_ip | If you have more than one network card in your PC, enter the IP address to listen on. If you don't have more than one network card, no change is necessary. Default: (empty) | |||
hub_desc | A description of your hub. | |||
hub_category | An upcoming extension to the hublist protocol this variable allows you to specify what type of hub you have i.e. movies | |||
hub_owner | Owner that runs the hub. | |||
min_nick | Minimum nickname length. Default: 3. | |||
max_nick | Maximum nickname length. Default: 32. | |||
max_users | Maximum number of users allowed in your hub. Default: 6000 | |||
min_share | Minimum amount that people must share in your hub in megabytes. People that share less will not be allowed to join. Default: 2 GB (2048). | |||
tban_kick | Length of time people must wait after being kicked to rejoin. In seconds. Default: 300 seconds. (5 minutes) | |||
send_user_info | When people join, the hub will send them information about themselves. Set to 0 (zero) to disable, or 1 to enable. Default: 1. | |||
send_user_ip | When people join, the hub will send them the IP address they are reporting. Set to 0 (zero) to disable, or 1 to enable. Default: 0. | |||
hub_security | This is the name of the Hub Security bot. | |||
hub_security_desc | This is the description of the Hub Security bot. | |||
opchat_name | This is the name of the OpChat bot. | |||
opchat_desc | This is the description of the OpChat bot. |
File | Description |
motd | All users receive this motd. |
motd_reg | Registered users receive this in addition to motd. |
motd_vip | VIP Users receive this in addition to motd_reg and the normal motd. |
motd_op | OPs receive this in addition to motd_vip, motd_reg and the normal motd. |
motd_cheef | Cheef OPs receive this in addition to motd_op, motd_vip, motd_reg and the normal motd. |
motd_admin | Admin OPs receive this in addition to motd_cheef, motd_op, motd_vip, motd_reg and the normal motd. |
motd_master | Master users see all motd messages. |
Class | Tag | Help file |
0 | Regular users | /etc/verlihub/help_usr |
1 | Registered users | /etc/verlihub/help_reg |
2 | VIP users | /etc/verlihub/help_vip |
3 | Operator user | /etc/verlihub/help_op |
4 | Cheef user | /etc/verlihub/help_cheef |
5 | Admin user | /etc/verlihub/help_admin |
10 | Master user | /etc/verlihub/help_master |
Command | Description |
!lsttrigger | Lists available triggers. |
!addtrigger <trigger> [ -d <definition> ] [ -h <description help> ] [ -f <flags (see below> ] [ -n <send as nick> ] [ -c <min_class> ] [ -C <max_class> ] | Adds a trigger. See below this table for more information regarding the parameters. |
!modtrigger <trigger> [ -d <definition> ] [ -h <description help> ] [ -f <flags (see below> ] [ -n <send as nick> ] [ -c <min_class> ] [ -C <max_class> ] | Changes a trigger. See below this table for more information regarding the parameters. |
!deltrigger <trigger> | Removes a trigger. |
Parameter | Explanation | ||||||||||||||||||||||||||||||||
<trigger> | The name you want the trigger to be called. | ||||||||||||||||||||||||||||||||
-d <definition> | The definition of the trigger. This can be pointing to a file, or it can be the actual trigger contents, if the correct flags are specified. If you use this for the actual contents
you will have to enclose it in quotes. An example: -d "This is the trigger contents." NOTE: When using the definition as the actual trigger contents, you can not have quotations in the file! You will need to edit the database directly in this case. You can use %[CFG] and verlihub's current configuration path will be used. These variables need flag bit 32 set:
|
||||||||||||||||||||||||||||||||
-h <description help> | This is not used by Verlihub, it is here in case you need to enter a note with the trigger to remember what it is for. | ||||||||||||||||||||||||||||||||
-f <flags> | This is a flag bitset. These will govern how Verlihub will use the trigger and/or how it displays it to the user. This is a table with the available values:
Some examples of usage:
|
||||||||||||||||||||||||||||||||
-n <send as nick> | When sending to the main chat window, the trigger will appear to send from this nickname. | ||||||||||||||||||||||||||||||||
-c <min_class> | This is the minimum user class allowed to use this trigger. | ||||||||||||||||||||||||||||||||
-C <max_class> | This is the maximum user class allowed to use this trigger. |
!set max_chat_msg 512
!set max_chat_lines 10
!set mainchat_class 1
You can set up to 10 hubs where verlihub will try to redirect every disconnected user. The choice is made randomly among all ten of them although the first slot is likely to be chosen more oftern then the others.
It is IMPORTANT that you set a redirect host for your hub although not imperitive. Please be warned if you have a busy hub and wish to disable redirects by setting the first redirect slot to your own hub address, keep in mind that the users you are trying to redirect have ALREADY BEEN REJECTED by your hub per your minimum requirements for entry. Leaving these users in a connection loop will not help your stability or connection pool. The example below demonstrates how to disable redirects.
!set min_share_reg 2048
!set min_share_vip 1024
!set min_share_ops 0
EXTRA INFORMATION:
In this version there is also the ability to hide a registered users share size from the nicklist. Use the below example to achieve this: (1 = hide users share on next login and 0 = show users share on next login.)
Command | Explanation |
!lstconntype | Shows the current DC tags and their restrictions. |
!addconntype <DC Tag> [-S <tag_max_slots>][-s <tag_min_slots>][-l <tag_min_limit>][-ls <tag_min_ls_ratio>] | Adds the DC tags specified and their restrictions. See the explanation of the parameters in the table below. |
!modconntype <DC Tag> [-S <tag_max_slots>][-s <tag_min_slots>][-l <tag_min_limit>][-ls <tag_min_ls_ratio>] | Adds the DC tags specified and their restrictions. See the explanation of the parameters in the table below. |
!delconntype <DC Tag> | Removes specified DC Tag. |
Parameter | Explanation |
-S <tag_max_slots> | Maximum slots user can define for this connection type |
-s <tag_min_slots> | Minimum slots user can define for this connection type |
-l <tag_min_limit> | Minimum upload limit for user with this connection type. If user upload rate is less than this value, they are not allowed in the hub. |
-ls <tag_min_ls_ratio> | Minimal value for upload limit per slot. If user upload rate per slot is less than this value, they are not allowed in hub. |
General Hub settings | ||||
Variable | Explanation | |||
hub_name | The name of your hub. | |||
hub_desc | A description of your hub. | |||
hub_host | What people will use to connect to your hub. (An example: myhub.no-ip.com) | |||
hub_owner | Owner that runs the hub. | |||
hub_security | This is the name of the Hub Security bot. | |||
hub_security_desc | This is the description of the Hub Security bot. | |||
opchat_name | This is the name of the OpChat bot. | |||
opchat_desc | This is the description of the OpChat bot. | |||
show_tags | Show tags to users? 0=hide from all, 1=show tags, 2=show tags to OPs only. Default=2. | |||
Hub Connection settings | ||||
Variable | Explanation | |||
listen_port | The port the hub listens on. Other hubs use port 411, but you need to run verlihub as root to do that. Default=4111. | |||
extra_listen_ports | Extra ports the hub listens on. | |||
listen_ip | If you have more than one network card in your PC, enter the IP address to listen on. If you don't have more than one network card, no change is necessary. | |||
dns_lookup | Reverse DNS lookup when user joins. Needed to see hostmask of user. If you have a slow DNS server this can slow down the hub. | |||
max_users | Maximum number of users allowed in your hub. | |||
max_upload_kbps | Maximum upload speed hub is allowed to use. This is VERY useful for protecting the hub against lag in larger hubs. Setting the right limit will prevent the hub from being to accept more then it can handle at any given time thus preventing a backlog of actions. | |||
min_frequency | Somewhat automatic antilag system, higher values will allow lower lag; 0 means disabled. Largest usable value is 3. Normal values would be between 0.1 and 1.5. If you want to try to break records, set to 0 (though it's not recommended.) Keep in mind that the lower this value is, the less extra resources the hub has to help deal with any backlog of actions. Recommend you leave this as default. | |||
min_class_use_hub | Setting this variable to a number of class will prevent a user from being able to download if their class is below the set limit. This will over-ride the next variable below if not 0 | |||
min_class_use_hub_passive | The same as above only this one is specifically for passive users. | |||
Nickname Rules | ||||
Variable | Explanation | |||
min_nick | Minimum nickname length. Default of 3. | |||
max_nick | Maximum nickname length. | |||
nick_chars | Allowed characters in username. | |||
nick_prefix | To force a connecting user to have a prefix before their nick, example: [GOD] will tell all connecting users to set their nick as [GOD]nickname | |||
nick_prefix_cc | Explained above but used when cc zones have been defined. | |||
Share Rules | ||||
Variable | Explanation | |||
min_share | Minimum amount that people must share in your hub in megabytes. People that share less will not be allowed to join. | |||
min_share_reg | If you want your registered users to have a different minimum share level, use this. | |||
min_share_vip | If you want your VIP users to have a different minimum share level, use this. | |||
min_share_ops | If you want your OPs to have a different minimum share level, use this. | |||
min_share_factor_passive | Multiplication factor for the minimum share of passive users (a setting of 2.0 means passive have to share twice the min_share setting) | |||
min_share_use_hub | If this is higher then min_share then users that have less then this will not be able to search and download, but will be allowed to join the hub | |||
max_share | If you want to prevent users from sharing too much, enter the max allowed to share in MB. | |||
max_share_reg | If you want to prevent registered users from sharing too much, enter the max allowed to share in MB. | |||
Ban settings | ||||
Variable | Explanation | |||
tban_kick | Length of time people must wait after being kicked to rejoin. In seconds. Default=300 seconds. | |||
tban_max | Maximum length of time an OP can ban someone for. In seconds. | |||
hide_all_kicks | Hides all kick messages from users. | |||
Login settings | ||||
Variable | Explanation | |||
int_login | Number of seconds user has to wait after disconnection before being allowed to reconnect. | |||
send_user_info | When people join, the hub will send them information about themselves. Set to 0 (zero) to disable, or 1 to enable. Default=On. | |||
send_user_ip | When people join, the hub will send them their IP address. Set to 0 (zero) to disable, or 1 to enable. Default=On. | |||
nicklist_on_login | Show nicklist when users log in. | |||
allways_ask_password | Always ask users for a password, whether they are registered or not. | |||
chat_default_on | Enable the chat window by default. 1=yes, 0=no. If no, users need to use !chaton to get messages. | |||
Custom Hub Messages | ||||
Variable | Explanation | |||
msg_chat_onoff | ||||
msg_change_pwd | You can customize your user's change password message by putting a message in this variable. | |||
Custom Error Messages | ||||
Variable | Explanation | |||
msg_banned | You can customize the error message that indicates the user is banned by putting a message in this variable. | |||
msg_hub_full | You can customize the error message that indicates the hub is full by putting a message in this variable. | |||
msg_nick_prefix | ||||
msg_downgrade | You can customize the error message that indicates the client is too new by putting a message in this variable. | |||
msg_upgrade | You can customize the error message that indicates the client is outdated by putting a message in this variable. | |||
msg_replace_ban | ||||
Custom Welcome Messages | ||||
Variable | Explanation | |||
msg_welcome_guest | If you want to welcome your Class 0 members, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_vip | If you want to welcome your registered members, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_vip | If you want to welcome your VIP members, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_op | If you want to welcome your OPs, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_cheef | If you want to welcome your Cheef OPs, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_admin | If you want to welcome your Admin OPs, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
msg_welcome_master | If you want to welcome your Master user, fill in a welcome message here. Use %[nick] to use the person's nickname in the message. | |||
Maximum User Extensions | ||||
Variable | Explanation | |||
max_extra_regs | If the hub is full, allow this many more extra registered users to join. | |||
max_extra_vips | If the hub is full, allow this many more extra vip users to join. | |||
max_extra_ops | If the hub is full, allow this many more OPs to join. | |||
max_extra_admins | If the hub is full, allow this many more Admin OPs to join. | |||
Public Hub List settings | ||||
Variable | Explanation | |||
hublist_host | ||||
hublist_port | ||||
hublist_send_minshare | When set to 1, a minimum share field is added automatically to the hublist registration description. | |||
timer_hublist_period | Number of seconds between two hublists registrations. | |||
Hub redirection | ||||
Variable | Explanation | |||
redir_host_max | Set this to 0 (zero) and redir_host0 to your hub's DNS name to disable redirection. | |||
redir_host0 | Enter hosts to redirect to in case users aren't allowed in your hub, or leave them blank. Dont forget to update redir_host_max if u decide not to leave these blank. | |||
redir_host1 | ||||
redir_host2 | ||||
redir_host3 | ||||
redir_host4 | ||||
redir_host5 | ||||
redir_host6 | ||||
redir_host7 | ||||
redir_host8 | ||||
redir_host9 | ||||
Search settings | ||||
Variable | Explanation | |||
int_search | Minimum number of seconds user has to wait before being allowed to search again. | |||
int_search_reg | Minimum number of seconds registered users have to wait before being allowed to search again. | |||
min_search_chars | Minimum number of characters allowed in a search. (This can be a useful means of controlling wildcard searches such as 'mp3' which for a passive user would return thousands upon thousands of search results back through the hub. | |||
max_passive_sr | Maximum number of search responses a passive user is allowed to recieve. This is useful for lag and bandwidth control since passive users totally rely on the hub to return search results. | |||
DC Tag settings | ||||
Variable | Explanation | |||
tag_allow_none | Allow clients to NOT report a tag? 1=yes, 0=no. Yes by default. | |||
tag_sum_hubs | The count of numbers to sum and use as the HUBS count from the H:X/Y/Z part of tag | |||
tag_min_class_ignore | Which lowest class users are not to be checked for tags | |||
tag_max_hs_ratio | Enter the minimum hub/slot ratio here. Users that are below this are refused connections to the hub. For example, setting to 1 means user needs to have 1 slot open per hub. | |||
tag_max_hubs | Set this to restrict how many hubs your user can be in concurrently. | |||
tag_min_version_plusplus | Use the _min_version_ tags to specify a minimum version for the client allowed in the hub. | |||
tag_min_version_dcgui | ||||
tag_min_version_odc | ||||
tag_min_version_dc | ||||
tag_min_version_dcpro | ||||
tag_min_version_strongdc | ||||
tag_min_version_idc | ||||
tag_min_version_zdc | ||||
tag_max_version_plusplus | Use the _max_version_ tags to specify a maximum version for the client allowed in the hub. | |||
tag_max_version_dcgui | ||||
tag_max_version_odc | ||||
tag_max_version_dc | ||||
tag_max_version_dcpro | ||||
tag_max_version_strongdc | ||||
tag_max_version_idc | ||||
tag_max_version_zdc | ||||
tag_allow_sock5 | We all know what a socks connection is, this can prevent a user connecting to your hub using such a method if set to 0 | |||
Country Code User Definitions | ||||
Variable | Explanation | |||
cc_zone1 | Enter the countries for the first country code zone. The format is `:XX:YY:ZZ:`. It has to start and end with a colon, and all country codes are separated by colons. There can be any number of codes (example codes: CZ; UK; US; SE. NOTE: These need to be capitalized!) | |||
cc_zone2 | Enter the countries for the second country code zone. The format is `:XX:YY:ZZ:`. It has to start and end with a colon, and all country codes are separated by colons. There can be any number of codes (example codes: CZ; UK; US; SE. NOTE: These need to be capitalized!) | |||
cc_zone3 | Enter the countries for the third country code zone. The format is `:XX:YY:ZZ:`. It has to start and end with a colon, and all country codes are separated by colons. There can be any number of codes (example codes: CZ; UK; US; SE. NOTE: These need to be capitalized!) | |||
max_users0 | If a user joins that doesn't belong in the Country Code list specified below, this user limit applies. | |||
max_users1 | User limit that applies to cc_zone1 | |||
max_users2 | User limit that applies to cc_zone2 | |||
max_users3 | User limit that applies to cc_zone3 | |||
IP Address User Definitions | ||||
Variable | Explanation | |||
ip_zone4_min | If you want to restrict users by IP address, enter the minimum IP address for the first IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
ip_zone4_max | If you want to restrict users by IP address, enter the maximum IP address for the first IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
ip_zone5_min | If you want to restrict users by IP address, enter the minimum IP address for the second IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
ip_zone5_max | If you want to restrict users by IP address, enter the maximum IP address for the second IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
ip_zone6_min | If you want to restrict users by IP address, enter the minimum IP address for the third IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
ip_zone6_max | If you want to restrict users by IP address, enter the maximum IP address for the third IP zone here. (Verlihub allows you to define 3 IP zones.) | |||
max_users0 | If a user joins that doesn't belong in the IP range specified below, this user limit applies. | |||
max_users4 | User limit that applies to ip_zone4_* | |||
max_users5 | User limit that applies to ip_zone5_* | |||
max_users6 | User limit that applies to ip_zone6_* | |||
Miscellaneous settings | ||||
Variable | Explanation | |||
cmd_start_user | The prefix for user commands. Default '+'. | |||
cmd_start_op | Prefix for OP commands. Default '!'. | |||
report_dns_lookup | This will report to opchat by default the results of a reverse dns lookup. | |||
max_message_size | This will over-ride the earlier mentioned flood control settings if set correctly. Works in bytes i.e. 1024 bytes of data allowed in a single message default is 10240 allowing a huge message. This applies to ALL classes including master (class 10) | |||
int_chat_ms | This is the time period between each message a user can send to mainchat. A value of 1000 would make a user wait 1 second at least before he can send another message to mainchat. Can be used for flood control. | |||
show_email | Set this to 0 if you wish to optimise your nicklist by removing all email fields. Set to -1 to disable and show all email addresses that user specify in their client settings. | |||
show_speed | See show_email. | |||
show_share | See show_email. | |||
show_desc_len | The same as the show_email variable except with this you can specify a number of characters that are allowed. i.e. 10 would allow a user description length of 10 characters. -1 to disable and show entire description. | |||
int_nicklist | A value of 30 by default meaning a user can only request a nicklist update once every 30 secs, useful for lag and bandwidth control. | |||
desc_insert_mode | Insert 'A', 'P', or '5' into user's description ? (1 = yes/0 = no) A meaning Active P meaning passive and 5 meaning a socks connection type. | |||
use_reglist_cache | Set to default by one Verlihub will cache the entire reglist for query upon entry to the hub. If this is turned on then any external apps used for adding users directly into the database will not be known in the reglist cache until either !reload is typed in the hub or the hub reloads its own config variables, a time setting which can be manipulated. | |||
use_penlist_cache | The exact same as the last variable but this one deals with the banlist and kicklist and temp rights. | |||
save_lang | Set to 1 to enable multi-language. See this guide for more details and rememeber to turn it off after you have saved the lang as described in the guide earlier. | |||
timer_conn_period | It's probably best that you do not mess with this variable as it does not really effect performance in the way people seem to think it does. | |||
timer_serv_period | See previous variable. | |||
timer_reloadcfg_period | This is a time setting in seconds that tells verlihub to reload its settings and reglist and banlist cache from the database. Default is 300 seconds (5 minutes) meaning every 5 minutes verlihub will reload the database. | |||
delayed_search | Set to 1 by default this will impose an initial delay specified by int_search on a connecting user. Useful for search bots that search spam hubs. | |||
delayed_myinfo | The same as above, See int_myinfo for a better description. | |||
step_delay | Do not mess with this setting unless you know what you are doing. | |||
bc_reply | When you set to disable (disable), then the !bc commands don't send you away replies from all back to your PM | |||
log_level | 5 log level settings 0 being disabled 1 being slight 2 3 4 5 etc etc where 5 logs everything it can log. Use with caution and only when debugging as this feature can significantly impact resources. | |||
check_ctm | By default this is set to 1 which will force the hub to varify a connecting active users connection (make sure he is who he claims to be) 0 to disable this check (WARNING: setting to 0 means people can use your hub to generate what is known as a ctm flood, to attack other hubs or even your own). There used to be 3 levels for this, there is no longer, its either on or off theres no inbetween. When on if a user cannot be varified he/she will be disconnected from the hub. | |||
check_rctm | The same as above but for passive users. | |||
check_asearch | Performs the same as check_ctm only this one will kick in when a user searches, meaing if check_ctm is disabled a users ctm will be checked when he attempts a search. See check_ctm for better description. | |||
optimize_userlist | Set this to 1 if you wish to upload the userlist more slowlier to users upon connecting. How slowly is determined by the next variable below. | |||
ul_portion | See optimize_userlist. | |||
int_flood_pm_period | A means of flood control only this one applies to private messages. This is a time setting in seconds and will measure how many private messages you are trying to send a user over a given time period specified here. | |||
int_flood_pm_limit | This setting is a numerical value. Example: value of 2 will disconnect a user if they try to spam another more then twice in quick succession. | |||
timeout_myinfo | Genrally you should leave this at its default setting. Its self explanitory. | |||
hub_version | This is a hard value determined by the source code. If you change it then upon next restart the hub will change it back again. | |||
hub_version_special | You can specify an extra version string here that will be appended to the hard coded version string of the hub. | |||
classdif_reg | This value is somewhat confusing for many. Lets explain it with an example. When set to the value of 2 a user can only register another user that is maximum 2 classes below him/her. | |||
classdif_kick | See above. | |||
classdif_download | See above. | |||
classdif_pm | See above. | |||
min_class_register | This is self explanitory. If you set this to 3 then it will over-ride any other settings and ONLY OPS or higher will be able to register a new user. | |||
min_class_bc | This setting is again self explanitory, a setting of 5 means only admins can send broadcast messages. | |||
min_class_bc_regs | See above. The regs extension is referring to registered users. This over-rides the value above when set. | |||
min_class_redir | Self explanitory. Applies to manually redirect users from your hub. | |||
dest_report_chat | This setting is the output of the +report command. By default all +reports will be shown in opchat. | |||
dest_regme_chat | See above. Applies to the +regme command. | |||
dest_drop_chat | See above. Applies to users who are dropped from the hub by other users i.e. OP's who use the !drop command, | |||
default_password_encryption | The ecryption method which will be used (if available) to encrypt passwords that will be set. Effective immediately. (1 - ENCRYPT (default), 0 - not encrypted - plain text, 2 - MD5). If given method is not available, another encryption method is used or at worst the plain text password is stored. | |||
timeout_key | timeout (in seconds) from the connection until the first response | |||
timeout_nick | timeout (seconds) from the key response, until the reception of nick | |||
timeout_myinfo | timeout (seconds) - from the nick until the myinfo (description, share, tags,etc..) | |||
timeout_flush | timeout (seconds) (reserved, not used) | |||
timeout_login | timeout (seconds) from the connection until the appearance in the userlist | |||
timeout_setpass | timeout (seconds) from login until user sets his/her initial password | |||
max_class_int_login | maximal class that get int_login seconds long tempban on every login (this is added mainly for debugging purpose) | |||
mainchat_class | The minimum class that can use the mainchat. | |||
topic_mod_class | The minimum class that can set the hub topic. | |||
plugin_mod_class | The minimum class that can issue plugin commands. | |||
trigger_mod_class | The minimum class that can issue trigger moderation commands. | |||
disable_regme_cmd | Set this to 1 to prevent people using the +regme command. | |||
disable_me_cmd | See above. | |||
disable_usr_cmds | Set this to 1 to temporarily disable all + commands for users below class 1. | |||
max_class_int_login | maximal class that get int_login seconds long tempban on every login (this is added mainly for debugging purpose) |
Class | Tag | Description |
0 | Regular users | Any user that connects to the hub |
1 | Registered users | Password protected nickname |
2 | VIP users | Special share limit |
3 | Operator user | Special share limit, kick/ban users, can register level 1 users |
4 | Cheef user | Mainly is allowed to register users and VIP members, but not allowed to create OPs |
5 | Admin user | Can create OPs, broadcast messages and change hub settings via !set |
10 | Master user | This user can do everything, including create more admin users, can't create another master user |
User Level | Can create users of level |
0 (Normal users) | can't add users |
1 (Registered user) | can't add users unless min class register is set for them |
2 (VIP user) | see above |
3 (Regular OP) | see above |
4 (Cheef user) | By default can add classes 1 and 2 |
5 (Admin user) | By default can add 1 2 and 3 |
10 (Master user) | Can add all regardless of any settings |
Variable | Description |
nick | The user's nickname. |
class | The class the user belongs to. |
class_protect | User is protected from being kicked by this class and lower. |
class_hidekick | User won't see kicks from OPs this class or lower. |
hide_kick | Flag to indicate whether User sees any kick messages. |
hide_share | Flag to indicate whether Users share should be shown or not. |
reg_date | Date the nickname was registered. (UNIX timestamp!) This HAS to be set! |
reg_op | The OP that registered the nickname. |
pwd_change | Flag to indicate if user needs to change his/her password. |
pwd_crypt | Type of encryption used on the password. |
login_pwd | The user's password. |
login_last | Last time User logged in. (UNIX timestamp!) |
logout_last | Last time User logged out. (UNIX timestamp!) |
login_cnt | How many times user has logged into the hub. |
login_ip | IP address of user when they last entered hub. |
error_last | Last error message User reported. (UNIX timestamp!) |
error_cnt | Total number of errors User has had. |
error_ip | IP address of User when last error occured. |
enabled | Flag to indicate whether account is enabled or not. |
User's email address | |
note_op | A field you can use to leave yourself a note regarding this user. |
note_usr | Another note field. |
msg_welcome | Custom personal welcome message. |
Time Unit | Abbreviation |
Second | s |
Minute | m |
Hour | h |
Day | d |
Week | w |
Month | M |
Year | y |
Ban Command | Explanation |
!banhost2 <hostname> <reason> | This will ban the second level of the given |
!banhost3 <hostname> <reason> | This will ban the third level of the given |
!banhostr1 <hostname> <reason> | Bans the leftmost part of the hostname (in the example, "someuglynumbers" would be banned.) |
Unban Command | Explanation |
!unban <ip_or_nick> <unban_reason> | Standard method for removing bans. |
!unbanip <ip> <unban_reason> | Will remove only existing IP bans. |
!unbannick <nick> <unban_reason> | Removes nickname bans. |
!unbanhost2 <hostname> <unban_reason> | Removes a second-level hostname ban. |
!unbanhost3 <hostname> <unban_reason> | Removes a third-level hostname ban. |
!unbanhostr1 <hostname> <unban_reason> | Removes the leftmost part of a hostname ban. |
!unbanemail <email> <unban_reason> | Removes an email ban. |
!unbanprefix <prefix> <unban_reason> | Removes a nickname prefix ban. |
!unbanshare <exact_share_in_bytes> <unban_reason> | Removes a share size ban. |
!unbanrange <low IP value>..<high IP value> <unban_reason> | Removes a range of IP bans. |
!unban _nickban_ <reason> | Removes ALL current nickbans |
!unban _ipban_ <reason> | Removes ALL current ipbans |
!unban _shareban_ <reason> | Removes ALL current sharebans |
!unban _rangeban_ <reason> | Removes ALL current rangebans |
!unban _tempban_ <reason> | Removes ALL current tempbans |
!unban _emailban_ <reason> | Removes ALL current emailbans |
!unban _hostban_ <reason> | Removes ALL current hostbans |
Command | Parameters | Description |
!lstplug | List the registered plugins | |
!addplug | <nick[8]> [-p <"path"> [-d "desc"] -a <autoload (0/1)> | Registers a new plugin. nick is a short plugin nickname (8 characters); path is a relative or absolute path to the plugin's binary; desc is an optional description; autoload set to 1 to have it start when verlihub loads. |
!delplug | <nick> | Unregisters the plugin. |
!onplug | <nick> | Turns the plugin on. |
!offplug | <nick> | Turns the plugin off. |
!replug | <nick> | Reloads the plugin, turning it off then on. |
The Plugin Manager | |
Plugin Name | Description |
plugman | This is the plugin manager for Verlihub, and is part of the verlihub download tarball. |
Scripting Languages | |
Plugin Name | Description |
lua | This allows you to use simple scripts written with LUA. |
perl | This allows you to use simple scripts written in Perl. |
Developer Tools | |
Plugin Name | Description |
PluginScriptInterface | This is a special interface with better support of scripting languages. |
Chat and Flood control | |
Plugin Name | Description |
forbid | This plugin allows you to filter main chat and private messages for forbidden words. |
replacer | This plugin replaces given patterns in text. For example if someone types Windows in the main chat, you can have this plugin change it to Winblows. |
funny | This one is amusing, it mixes up the chat messages. Install this one and don't tell your hub users. ;) |
floodprot | This plugin offers more control from users flooding the hub. |
diakritika | This plugin replaces some letters with other letters (to remove diatrics for example, or just to simply make all of the chat messages lowercase. This was included in the tarball of verlihub. |
Miscellaneous | |
Plugin Name | Description |
stats | This periodically saves statistics in the database (i.e. users, share, upload, searching, etc...) |
messanger | This plugin is used to send messages to offline users. |
gagrange | This plugin is used to disable chat for all non registered users in a given IP range. |
iplog | This logs IP addresses as users join and leave the hub. |
chatroom | This will set up individual chatrooms for users. This would work similarly to OPChat. This is great if you have a multiple-language hub. |
isp | This plugin allows you to check connection types, nickname prefixes, and minimum shares, among other things... |
Command | Description |
!lualist | Lists loaded LUA scripts. |
!luaload <script> | Loads specified LUA script. |
!luaunload <script> | Unloads specified LUA script. |
Command | Description | ||||||||
!lstforbid | Lists forbidden patterns. | ||||||||
!addforbid <"pattern"> [-C <max_class>] [-f <flags>] [-r <"kick_reason">] | Adds a forbidden pattern. Using the -C option, you can specify the classes to ignore filtering. Set to 1 to ignore registered users and up. Using the -r option, you can specify a kick reason. Using the -f option, you can specify which chats are screened and whether or not a message is sent to OpChat when a rule is broken. Using the table below, to screen main chat and private messages, use -f 3.
|
||||||||
!modforbid <"pattern"> | Modifies forbidden pattern. See parameters for adding. | ||||||||
!delforbid <"pattern"> | Deletes forbidden pattern. |
Command | Description |
!lastip <nick> [ <limit=10>] | Shows last IP addresses for nickname specified. |
!lastnick <ip> [ <limit=10>] | Shows the last nicknames used by the IP address. |
!iplog <ip> | Shows log history for ip address. |
!nicklog <nick> | Show log history for nickname. |
Command | Description |
!getreplacer | Lists replaced words. |
!addreplacer <word> <replacement word> <level to apply> | Adds a word replacement. If you specify level 1, registered users and up are immune to the word replacement. |
!delreplacer <word> | Removes an entry. |
Command | Description |
+msgsend <nick> <topic/subject> <newline> <message text> | Sends a message to nick and will be displayed next time they log in. It is a good idea to send this to a registered nickname. Enter a newline character between the subject and the message! Some clients require ctrl+enter to do this! |
Command | Description |
!lstroom | Lists all chatrooms available. |
!addroom <nick> <topic> | Create a chatroom named nick and sets the topic specified. When specifying the nickname, make sure you obey the nickname rules! |
!delroom <nick> | Removes specified chat room. |
Command | Description |
+invite <online_users_nick> <invite message> | Invites a person into the chatroom with an optional invitation message. |
+leave | Leaves chatroom; no messages from the chatroom will be received. |
+out <nick> | Excludes a user from the chatroom. This is useful if you have users in the chatroom that normally do not have the rights to access the room. |
Command | Description |
!lstgagrange | Shows ip ranges that have been gagged. |
!addgagrange <ip>/<left_mask_bits> | Adds IP range to gag list. Example: 1.2.3.4/24 |
!delgagrange <ip>/<left_mask_bits> | Removes an IP range from the gag list. |
Master User Commands (Level 10) | ||||
Level | Command | Aliases | Parameters | Description |
10 | !quit | Stops the hub. | ||
Admin User Commands (Level 5) | ||||
Level | Command | Aliases | Parameters | Description |
5 | !getconfig | !gc | Prints a list of all configuration variables that can be inserted into the database. | |
5 | !set | != | <variable> <newvalue> | Sets verlihub configuration variable variable to newvalue. |
5 | !userlimit | !ul | <limit> [time - minutes] | Temporarily changes the user limit to limit. If time is not specified, 60 minutes is assumed. |
5 | !hublist | Sends your hub information to the public hublisting. | ||
5 | !reload | Reloads verlihub's configuration. NOTE: Some configuration changes require the hub to be restarted! | ||
5 | !regset | !r | <nick> <variable> <value> | Manipulates registered users table directly. See Manipulating the registered users table directly for more information. |
5 | !plugin | <plugin_name> | Loads specified plugin. | |
5 | !plugout | <plugin_name> | Unloads specified plugin. | |
5 | !pluglist | all | Shows loaded plugins. | |
5 | !plugreload | <plugin_name> | Reloads specified plugin. | |
5 | !protoall_hubname | unknown | Sends new hub name to all users. | |
5 | !protoall_hello | unknown | Simulates a login. | |
5 | !protoall_quit | unknown | Simulates a logout. | |
5 | !protoall_pm | unknown | Sends a PM, similar to the !broadcast command. | |
5 | !protoall_chat | unknown | Sends a chat message, similar to if you typed it in the main chat window. | |
5 | !protoall_redir | unknown | Forces hub redirection. | |
5 | !protoall_any | unknown | You can try anything here, the pipe is added to the end automatically. | |
5 | !protoactive_* | unknown | Sends the proto command to active users. Commands are similar to the !protoany commands above; for example, !protouser_hubname. | |
5 | !protohello_* | unknown | Sends the proto command to users that don't support the NoHello feature. Commands are similar to the !protoany commands above; for example, !protouser_hubname. | |
5 | !protouser_* | unknown | Sends the proto command to users. Commands are similar to the !protoany commands above; for example, !protouser_hubname. | |
Cheef User Commands (Level 4) | ||||
Level | Command | Aliases | Parameters | Description |
4 | !broadcast | !bc | <msg> | Sends msg to all users. |
4 | !regnewuser | !rn | <username> [class] | Registers new username. If you do not specify class, the user is registered with a class of 1. You can not register users with a class higher than your class - 2 |
4 | !regpasswd | <nick> | Allows registered nick to change his password (he has to use command +passwd <pass>). | |
4 | !regdisable | <nick> | Disable a user's registration, but he can be re-enabled later. You should use this if you only want to punish a user for example. | |
4 | !regenable | <nick> | Enable a user's registration that was previously disabled with !regdisable. | |
4 | !regdelete | <nick> | Destroys a registered user by removing him from the database. If you later change your mind, you must register the user all over again. You should use this if you want to permanently remove a user. | |
4 | !regclass | <nick> <class> | Changes a previously registered user's class to <class>. You cannot change a user to a class higher than yours - 2. | |
4 | !class | <nick> <class> | Temporarily changes nick's class to class. Stays effective until user leaves and rejoins hub. | |
4 | !regprotect | <nick> <class> | Protects a registered user from being kicked/banned etc. by a user of a class lower than class. The user does not have to be in the hub. | |
4 | !protect | <nick> <class> | Protects an unregistered user from being kicked/banned etc. by a user of a class lower than class. The user must be currently connected to the hub for this to take effect. | |
4 | !drop | <nick> | Disconnects user from hub without giving him a reason and without banning him. | |
Op User Commands (Level 3) | ||||
Level | Command | Aliases | Parameters | Description |
3 | !hubinfo | Shows information about the hub. | ||
3 | !kick | <nick>nbsp;<reason> | Kick the user from command line and give a ban equal to the hub's specified tempban time. If you right-click in your client and kick, it does the same thing. If you include _ban_time in the reason, then the ban is extended to the time you specify. Valid entries for time are Ns, Nm, Nh, Nd, NM, Nw, Ny. The IP and the nick are both banned. This is the most reliable and easiest way to ban. | |
3 | !hidekick | <nick>nbsp;<reason> | Kicks user nick with reason. It does this quietly; it doesn't announce it to the hub users. | |
3 | !ban | <ip> <reason> | Bans ip from hub with reason. | |
3 | !banip | <ip> <reason> | Bans ip from hub with reason. | |
3 | !bannick | <nick> <reason> | Bans nick from hub with reason. | |
3 | !banhost1 | <host> <reason> | Bans first level of host from hub with reason. This usually isn't too useful; for example in my.web.host.com it would ban '.com'. | |
3 | !banhost2 | <host> <reason> | Bans second level of host from hub with reason. For example in my.web.host.com it would ban 'host.com'. | |
3 | !banhost3 | <host> <reason> | Bans second level of host from hub with reason. For example in my.web.host.com it would ban 'web.host.com'. | |
3 | !banhostr1 | <host> <reason> | Bans leftmost part in the hostname. | |
3 | !banprefix | <prefix> <reason> | Bans a user prefix in the nickname. | |
3 | !banshare | <shareamount> <reason> | Bans a share amount (in bytes). | |
3 | !banemail | <email> <reason> | Bans an email address reported by clients. | |
3 | !banrange | <ipmin>...<ipmax> <reason> <ip>/<bitmask> <reason> |
Bans range of IPs. Examples: !banrange 1.1.1.1...1.1.1.4 or !banrange 1.1.1.1/24. | |
3 | !ban_time | <ip> <reason> | This bans the IP for the specified time. If a nick with the <ip> has been previously kicked, then that nick is banned too and any user with the <ip> is dropped. If no nick with the <ip> was previously kicked then no nick is banned and no user is dropped. If a nick with the <ip> is later kicked, then that nick is banned for the same time as the <ip>. Valid entries for time are Ns, Nm, Nh, Nd, NM, Nw, Ny. So '!ban_1M <ip> <reason>' would ban an ip for one month with the reason. The best use for !bannick is if you want to prevent a certain ip (no matter the nick) from entering the hub. If you wish to ban a user who is connected to the hub you should use !kick instead. | |
3 | !bannick_time | <nick> <reason> | This bans only the nick of the user for the specified time. Valid entries for time are Ns, Nm, Nh, Nd, Nw, NM, Ny. So '!bannick_10m nick reason' would ban a nick for 10 minutes with the reason. The best use for !bannick is if you want to prevent a certain nick (no matter the ip) from entering the hub. If you wish to ban a user who is connected to the hub you should use !kick instead. | |
3 | !unban | <ip> <reason> | Unban IP and nick for the user. If a nick is associated with an ip or an ip is associated with a nick, then both are removed. This also removes bans that were issued with !kick. | |
3 | !unbannick | <nick> <reason> | Removes a nickname ban. | |
3 | !unbanhost1 | <host> <reason> | Removes a first level host ban. | |
3 | !unbanhost2 | <host> <reason> | Removes a 2nd level host ban. | |
3 | !unbanhost3 | <host> <reason> | Removes a 3rd level host ban. | |
3 | !unbanhostr1 | <host> <reason> | Removes a leftmost host ban. | |
3 | !unbanprefix | <prefix> <reason> | Removes a nickname prefix ban. | |
3 | !unbanshare | <share> <reason> | Removes a share ban. | |
3 | !unbanemail | <email> <reason> | Removes an email ban. | |
3 | !unbanrange | <any_ip_from_range> <reason> | Specify and IP in the range that is banned and the entire IP block will be unbanned. | |
3 | !hideme | <class> | Set this and users below class won't be able to see you. | |
3 | !ccbroadcast | !ccbc | <msg> | If you have country codes in your nickname, this will send a message to only those with specified country codes. For example: !ccbc :GB:US: Hi those from Great Britian and the US!.. |
3 | !flood | <nick> | Floods user off hub. Beware! | |
3 | !infobanip | <ip> | Shows ban information for ip. | |
3 | !infobannick | <nick> | Shows ban information for nick. | |
3 | !infobanrange | <any_ip_from_range> | Specify an IP from the IP range that is banned, and it will show the ip range that is banned. | |
3 | !infoban | _ipban_ | Shows current IP bans. | |
3 | !infoban | _nickban_ | Shows current nickname bans. | |
3 | !infoban | _banrange_ | Shows current IP Range bans. | |
3 | !lsban | 100 | Shows the 100 most recent bans. | |
3 | !getip | <nick> | Shows ip address for nick. | |
3 | !gethost | <nick> | Shows hostname for nick. This requires dns_lookup in verlihub configuration to be set to 1. | |
3 | !getinfo | <nick> | Shows information about nick. | |
3 | !whoip | <ip> | Attempts to find nickname for ip. | |
3 | !whorange | <ipmin>...<ipmax> <ip>/<bitmask> |
Attempts to show nicknames for the range of IP addresses. Examples: !whorange 1.1.1.1...1.1.1.4 and !whorange 1.1.1.1/24 | |
3 | !regs | <msg> | Sends msg to all registered users. | |
3 | !nosearch | <nick> | Prevents nick from searching the hub. | |
3 | !unnosearch | <nick> | Allows nick to search, if previously prevented with !nosearch. | |
3 | !gag | <nick> [time] | Prevents the user from using the chat function until he restarts his session or until [time] has expired. If you leave the [time] blank, then the time is set for one week. Valid entries for [time] are Ns, Nm, Nh, Nd, NM, Nw, Ny. So '!gag |
|
3 | !nopm | <nick> | Prevents nick from PM'ing others in the hub. | |
3 | !noctm | <nick> | Prevents nick from connecting to others. | |
3 | !unnoctm | <nick> | Allows nick to connect to others, when prevented with !noctm. | |
3 | !unnopm | <nick> | Allows nick to PM other users of hub, if they were denied with !nopm. | |
3 | !ungag | <nick> | Allows nick to chat in main channel, if they were silenced with !gag. | |
VIP User Commands (Level 2) | ||||
Level | Command | Aliases | Parameters | Description |
No commands | ||||
Registered User Commands (Level 1) | ||||
Level | Command | Aliases | Parameters | Description |
No commands | ||||
Normal User Commands (Level 0) | ||||
Level | Command | Aliases | Parameters | Description |
0 | +rules | Shows hub rules. | ||
0 | +faq | Shows frequently asked questions. | ||
0 | +motd | Shows message of the day. | ||
0 | +help | Shows help. | ||
0 | +report | <msg> | Sends a message to an OP, through OPChat. | |
0 | +regme | <msg> | Sends a message to an OP, through OPChat. | |
0 | +myip | Shows user their IP address. | ||
0 | +myinfo | Shows user information about themself. | ||
0 | +me | <msg> | Replaces '+me' with their nick and sends message to channel. |