Table of Contents
Verlihub
Verlihub 1.5.0.x
Verlihub is a NMDC server for Unix and Linux based operating systems that provides useful high level functionality such as:
- Low RAM and CPU usage
- It can hold more than 25.000 users
- TLS secured connection via NMDCS protocol
- Utility scripts for simple installation and hub management
- Export and import of hub setting via MySQL
- User management with privilegies
- Logging of nicks and IPs
- Clients and connection management
- Extend functionality with Lua, Python (deprecated) and Perl (deprecated) scripts
- Generate statistics for your hub
- Import users from PtokaX, Aquila or YnHub
- Plus much more
- Links:
- Website: https://github.com/verlihub
- Crash: https://crash.verlihub.net
- Translate: https://transifex.com/feardc/verlihub
- Ledokol: https://github.com/verlihub/ledokol
Verlihub 1.4.0.x
Verlihub is a NMDC server for Unix and Linux based operating systems that provides useful high level functionality such as:
- Low RAM and CPU usage
- It can hold more than 25.000 users
- TLS secured connection via NMDCS protocol
- Utility scripts for simple installation and hub management
- Export and import of hub setting via MySQL
- User management with privilegies
- Logging of nicks and IPs
- Clients and connection management
- Extend functionality with Lua, Python and Perl scripts
- Generate statistics for your hub
- Import users from PtokaX, Aquila or YnHub
- Plus much more
- Links:
- Website: https://github.com/verlihub
- Crash: https://crash.verlihub.net
- Translate: https://transifex.com/feardc/verlihub
- Ledokol: https://github.com/verlihub/ledokol
https://github.com/Verlihub/verlihub.git
INSTALL Verlihub
- Dependencies and installation
- Required dependencies:
- [ bin — hdr ] CMake 2.8.12
- [ bin lib hdr ] MySQL 5.7.1
- [ — lib hdr ] OpenSSL 1.1.0
- [ — lib hdr ] LibICU 55.0
- [ bin — — ] Make
- [ — lib hdr ] ZLib
- [ — lib hdr ] PCRE
- [ — lib hdr ] GetText
- [ — lib hdr ] MaxMindDB
- [ ??? ??? ??? ] LibIntl
- [ ??? ??? ??? ] Crypt
- [ ??? ??? ??? ] Threads
- [ ??? ??? ??? ] DL
- Optional dependencies:
- [ — lib hdr ] Lua 5.2
- [ — lib hdr ] Python 2.7
- [ — lib hdr ] PERL 5.20
- [ bin — — ] Dialog
- Install dependencies on Debian:
- sudo apt install libpcre3-dev libssl-dev mysql-server mysql-client libmysqlclient-dev libmaxminddb-dev libicu-dev gettext libasprintf-dev g++ make cmake
- Optional dependencies
- sudo apt install python2.7-dev liblua5.2-dev libperl-dev
- Install dependencies on CentOS:
- [todo]
- Install dependencies on Gentoo:
- [todo]
- Install dependencies on RedHat:
- [todo]
- Install dependencies on ArchLinux:
- [todo]
- Compile and install Verlihub itself:
- cd verlihub
- mkdir build
- cd build
- cmake ..
- make
- make install (as super user)
- ldconfig (as super user, this is required only when you get: cannot open shared object file, no such file or directory)
- updatedb (as super user, people say this command is needed to update slocate locations)
- Supported CMake options
- -DCMAKE_INSTALL_PREFIX=/usr (default: /usr/local)
- install prefix
- -DLIB_INSTALL_DIR=<lib prefix> (default: lib)
- install lib to <prefix for install>/<lib prefix>
- example:
-DLIB_INSTALL_DIR=lib64 - install lib to <prefix for install>/lib64
-DPLUGIN_INSTALL_DIR=<plugin prefix> (default: <lib prefix>) install plugins to <prefix for install>/<plugin prefix>
- example:
- -DPLUGIN_INSTALL_DIR=lib64/vh_plugins
End of file
Ledokol 2.9.8.135
Verlihub Command List hub
- This is a completed list of available commands in VerliHub. Commands are grouped by user's class and may change based on hub configuration (for example you can limit some commands to some class only). This is the list for the default hub configuration:
- Guest users (class 0)
- Command Description
- +chat Active main chat for you
- +rules Displays a listing of the hub rules *
- +faq Displays a list of helpful links if you are having trouble *
- +info Show information about the hub
- +regme Send a message to all OPs, asking them to register your nick
- +report <user> <reason> Report a user to opchat for breaking the rules
- +myip Shows you your IP address
- +myinfo Shows you information about yourself
- +motd Displays the Message of the Day (MOTD) *
- +me Replaces +me with your nick, and then sends a message to main chat
- +nochat Disable main chat for you
- +release Show information about VerliHub development team
- Commands marked with * are file triggers
- Registered user (class 1)
- Command Description
- +passwd Set your password
- +release Show information about authors, translators, etc.
- +verlihub See +release command
- +vh See +release command
- Operator (class 3)
- Command Description
- !broadcast <msg> Send broadcast message to all users
- !ccbroadcast <:CC:> <msg> Sends a broadcast to users with the specified country code(s) only
- !guests <msg> Broadcast to guests (class 0)
- !regs <msg> Broadcast to registered users (class 1)
- !vips <msg> Broadcast to VIPs (class 2)
- !ops <msg> Broadcast to operators (class 3)
- !cheefs <msg> Broadcast to cheefs (class 4)
- !admins <msg> Broadcast to administrators (class 5)
- !masters <msg> Broadcast to masters (class 10)
- !ban_time <nick/ip> <reason> Temporarily bans a nickname or IP for the specified time (_time). Valid entries for time are Ns, Nm, Nh, Nd, NM, Nw, Ny where N is a number. If you do not include a time, then the ban is permanent. Perform the same action of !ban command
- !banhost1_time <hostname> <reason> Bans the first level of the given DNS. See !ban command to format _time string
- !banhost2_time <hostname> <reason> Bans the second level of the given DNS. See !ban command to format _time string
- !banhost3_time <hostname> <reason> Bans the third level of the given DNS. See !ban command to format _time string
- !banhostr1_time <hostname> <reason> Bans the leftmost part of the hostname. See !ban command to format _time string
- !banip_time <ip> <reason> Bans IP address only. See !ban command to format _time string
- !bannick_time <nick> <reason> Bans a nick only. See !ban command to format _time string
- !banrange_time <range> <reason> Bans a range of IP addresses. Use <start_ip-end_ip> or <CIDR> notation. See !ban command to format _time string
- !banprefix_time <prefix> <reason> Bans a nick prefix. See !ban command to format _time string
- !banshare_time <share> <reason> Bans a share size; specify the exact share in bytes. See !ban command to format _time string
- !class <nickname> <new_class> Temporarily change the class (max to 5) of a user. Action will disappear at hub restarting
- !drop <nick> Disconnects user from hub without giving him a reason and without banning him
- !gag <nickname> [time] Mute a user in main chat for the time specified (default is 7 days)
- !getconfig or !gc Prints a list of all configuration variables
- !getinfo <nickname> Return IP address and hostname (if dns_lookup is set to 1)
- !getip or !gi <nickname> Return IP address of the requested nick(s)
- !gethost or !gh <nickname> Return hostname (if dns_lookup is set to 1)
- !hidekick <nick> <reason> Kicks a user and does not announce it to the hub
- !hideme <class> Hides yourself from users below the specified class
- !hubinfo Show information about the hub
- !hublist Send your hub information to the public hublist
- !infoban <keyword> Lists all possible matches for what you entered as keyword (nick, IP, range).
- !infobanip <ip> Lists all bans for specifyed IP
- !infobannnick <nick> Lists all bans for specifyed nickname
- !infobanrange <ip> Lists all bans for specifyed IP that belongs to a range
- !infoban_banrange_ Shows all current banned ranges
- !infoban_ipban_ Shows all current IP bans
- !infoban_nickban_ Shows all current nickbans
- !kick <nick> <reason> Kick a users temporarily, so user will not be able to rejoin until a number of seconds will expire
- !lsban <limit> Shows the most recent bans. Use <limit> to limit results
- !nochats <nickname> [time]) Prevent a user from send public and private messages for the time specified (default is 2 days)
- !nodl <nickname> [time]) Prevent a user from download files for the time specified (default is 2 days)
- !nopm <nickname> [time]) Prevent a user from send private messages for the time specified (default is 2 days)
- !nosearch <nickname> [time] Prevent users from searching for the time specified (default is 2 days)
- !regclass <nickname> <new_class> Change the class of a user based on given nickname
- !regdelete <nickname> Removing a registered user based on given nickname
- !regdisable <nickname> Temporarily disable a registered nickname without permanently removing it from the database
- !regenable <nickname> Enable a temporarily disabled user with !regdisable command
- !reginfo <nickname> See all information about a registered user
- !reglist [class=0] List all users with the given class. Default is 0
- !regnewuser <nickname> <class> [password] Register a new user with given class. Password is optional
- !regpass <nickname> <password> Set user password
- !regprotect <nickname> <class> Protect a user from the class minor or equal of the given value
- !reload Reloads verlihub's configuration
- !set <variable> <new_value> Change value of variables
- !topic <topic> Change the topic shown in the top of the client window
- !unban <ip_or_nick> <reason> Removes ban(s) from nickname or IP
- !unbannick <nick> <reason> Removes nickname ban(s)
- !unbanhost1 <hostname> <reason> Removes a first level hostname ban
- !unbanhost2 <hostname> <reason> Removes a second level hostname ban
- !unbanhost3 <hostname> <reason> Removes a third level hostname ban
- !unbanhostr1 <hostname> <reason> Removes the leftmost part of a hostname ban
- !unbanip <ip> <reason> Removes only existing ban(s) for IP
- !unbanprefix <prefix> <reason> Removes a nickname prefix ban
- !unbanshare <share> <reason> Removes a share size ban. Specify the exact share in bytes
- !unbanrange <range> <reason> Removes a range of IP bans. <range> may be the range, or any IP in the range
- !unban hostban <reason> Removes ALL current host bans
- !unban ipban <reason> Removes ALL current IP bans
- !unban nickban <reason> Removes ALL current nick bans
- !unban rangeban <reason> Removes ALL current range bans
- !unban shareban <reason> Removes ALL current share bans
- !unban tempban <reason> Removes ALL current temp bans
- !ungag <nickname> Un-mute a gagged user
- !unhidekick <nickname_list Show kick message again. Remove * !hidekick action
- !unnochats <nickname> Remove no-chats restriction
- !unnodl <nickname> Remove no-download restriction
- !unnopm <nickname> Remove no-PM restriction
- !unnosearch <nickname> Remove search restriction
- !whoip <IP address> Search users with given IP address
- !whorange <lower IP>-<upper IP> Shows nicknames in the given range of IP addresses
- !whorange <IP>/<left mask bits> Shows nicknames in the given subnet
- Admin (class 5)
- Command Description
- !addconntype <connection_type> <params> Add the <connection_type> with their restrictions
- !addplug <params> Register new plugin
- !addtag <name> <params> Adds a rule for the client
- !addtrigger <trigger> <params> Adds a new trigger
- !cleanbanlist Truncate ban table
- !cleankicklist Truncate kick table
- !cleantemprights Truncate temp rights table
- !cleanunbanlist Truncate unban table
- !delconntype <connection_type> Remove specified <connection_type>
- !delplug <nick> Unregisters the plugin
- !deltag <name> Remove a client
- !deltrigger <trigger> Remove a trigger
- !htag
- !htrigger Show an help and available trigger flags
- !lstconntype Shows the current connection type and their restrictions
- !lstplug List the registered plugins
- !lsttag
- !lsttrigger Lists available triggers
- !modconntype <conn_type> <params> Update the <connection_type> with their restrictions
- !modtrigger <trigger> <params> Change a trigger
- !offplug <nick> Turns the plugin off
- !onplug <nick> Turns the plugin on
- !proto <action>_<target> <data> Send protocol command to users
- !regset <nickname> hide_keys <0/1> Hide key operator for the given nickname. 1 to hide, 0 to show
- !regset <nickname> hide_share <0/1> Hide share of the given nickname. 1 to hide, 0 to show
- !regset <nickname> note_op <message> Add a note for the registered user in the database
- !replug <nick> Reloads the plugin, turning it off then on
- !ul <user_limit> [time_in_minutes] Temporarily change the max_users variable to given limit. If time (in minutes) is not specified, it will be assumed 1 hour
- Master (class 10)
- Command Description
- !core_dump Crash the hub so that stack trace can be examineted by debugger program like GDB
- !gdb_hash Quit the hub and dump the content of the user list
- !restart Restart the hub
- !quit Close the hub
- Plugins
- Command Description
- !addforbid <pattern> [-C <max_class>] [-f <flags>] [-r <kick_reason>] Adds a forbidden pattern. See below the table for more information regarding the parameters
- !addisp <iprange> <other_parameters> Add new ISP. See below the table for more information regarding the parameters
- !addplug <nick> -p <path> [-d desc] -a <autoload (0/1)> Register new plugin. Nick is a short plugin nickname, path is a relative or absolute path to the plugin's binary, desc is an optional description and autoload set to 1 means that plugin will start with hubsoft
- !addreplacer <word> <replacement word> <level of immunity> Adds a word replacement. You can specify level of immunity so user with class equal or bigger than to given value will be immune to the word replacement
- !addroom <nick> [-CC <country code>] [-ac <min_auto_class>][-AC <max_auto_class>][-c <min_class>][-t <topic>] Create a chatroom named nick. When specifying the nickname, make sure to respect nickname rules. See below the table for more information regarding the parameters
- !delforbid <pattern> Deletes forbidden pattern
- !delisp <ipmin/iprange> Deletes the given ISP. See below the table for more information regarding the parameters
- !delplug <nick> Unregisters the plugin
- !delreplacer <word> Removes an entry
- !delroom <nick> Removes specified chat room
- !getreplacer Lists words to replace
- !iplog <ip> Shows log history for given IP address
- +invite <online_users_nick> <invite message> Invites a person into the chatroom with an optional invitation message
- lastip <nick> [ <limit=10>] Shows last IP addresses for given nickname
- lastnick <ip> [ <limit=10>] Shows the last nicknames used by the given IP address
- +leave User can use this command to leave the room; no messages from the chatroom will be received
- !lstplug List the registered plugins
- !lstroom Lists all available chatrooms
- !luainfo Show information about running scripts
- !lstforbid Lists forbidden patterns
- !lstisp Give a list of ISPs
- !lualist Lists loaded LUA scripts
- !luaload <script> Loads specified LUA script using relative path to VerliHub config folder
- !lualog <enable (0/1)> Enable or disable LUA debug when you load a new script
- !luareload <script / ID> Reload a script, instead of using * !luaunload and then * !luaload or script ID as proposed with lualist command
- !luaunload <script / ID> Unloads specified LUA script using relative path to VerliHub config folder or script ID as proposed with lualist command
- !luaversion Show information about LUA library
- !modforbid <pattern> Modifies forbidden pattern. See below the table for more information regarding the parameters
- !modisp <iprange> <other_parameters> Edit existing ISP. See below the table for more information regarding the parameters
- +msgip <ip> <topic/subject> <message text> Sends a message to IP and will be displayed next time they log in
- +msgsend <nick> <topic/subject> <message text> Sends a message to given nickname and will be displayed next time they log in
- !nicklog <nick> Show log history for given nickname
- !offplug <nick> Turns the plugin off
- !onplug <nick> Turns the plugin on
- +out <nick> Excludes a user from the chatroom. This command is different from the previous one because can be used by OP to exclude a user from the room
- !pluglist all List all loaded plugins
- !plugin <plugin_filename.so> After you have compiled a plugin, you can use this command to load it. You need to specify the name of the plugin with its extension (.so). You can find all plugins in /usr/local/bin depending on installation prefix. For example to load hublist plugin use * !plugin /usr/local/lib/libhublink_pi.so
- !plugout <plugin_name> Unload a plugin use. You need to specify the plugin name that is available using the * !pluglist all command. Remember not to include the plugin version
- !plugreload <plugin_name> Reload a plugin. Use always the plugin name
- Python Plugins
- Require Python plugin to be enabled (it's not recommended as python plugin is outdated).
- Command Description
- !pylist Lists loaded Python scripts
- !pyload <script> Loads specified Python script using relative path to VerliHub config folder
- !pylog <enable (0/1)> Enable or disable Python debug when you load a new script
- !pyreload <script / ID> Reload a script, instead of using * !pyunload and then * !pyload or script ID as proposed with lualist command
- !pyunload <script / ID> Unloads specified Python script using relative path to VerliHub config folder or script ID as proposed with lualist command
- !replug <nick> Reloads the plugin, turning it off then on
- You can see this list using from hub this command:
- !help