Manual

From FlexHub
Jump to: navigation, search

More detailed manual can be downloaded from FlexHub forum: http://www.flexhub.org/forum/index.php?topic=179.0

How to do basic settings check here: http://flexhub.org/wiki/index.php?title=Set_explained

Installation

Linux InstallationWindows Installation

Console

After you install FlexHub (help links above), first thing you need to do, to turn your hub on, is to get friendly with Flexhub Console. You can find it in a folder of your installation called FlexHub, file name is: FlexHub.exe - double click it. Give your hub a name and put it in "Hubname" field. Make sure you forwarded ports for your hub (if any doubts check here: Port Forward Guides,) and same ports put in "Regular port(s)" field (if there is more then one, should be seperated with comma.) And now hit the button called "Start Hub" and voilà :) Check your external IP and use it to connect to your hub (your IP:port).

FlexHub-Console-01.jpg

Start/Stop Hub - Start/stop the hub
Autostart hub - Hub will start automaticly every time when console will be turned on
Hubname - Name of your hub
Regular port(s) - Ports you want to use for your hub (seperated with commas)
Start/Stop GUI - Start/stop GUI
Allow remote - Allow remote GUI connections
GUI password - Password assigned to your GUI
Debug level - Debug lever for console window

FlexHub-Console-Accounts-01.jpg

To make your first hub account:
- Choose profile Hubowner in "Profile" section
- Add your loginname and choose a SAFE password
- Optionally 'Use PID' and enter the PID of your client
- Click 'Save'

Now you can use your DC client to login using this loginname and pass. Accounts with profile Hubowner will have all rights and overrides. After loggin in start setting up your hub. See next section: "First Time Use"

Import.jpg

If you want to import old accounts from your previous hub:

First make sure that FlexHub contains the same profilenames as your Ynhub or Ptokax hub. Click the 'Import accounts' button that opens an import dialogbox.

For Ynhub: Choose Ynhub, click Browse and select the accounts.xml file, then click 'Import accounts'

For Ptokax: Choose Ptokax, click Browse and select the RegisteredUsers.xml file, then click 'Import accounts'. The file Profiles.xml needs to in the same folder as the RegisteredUsers.xml for this to work.

Grey buttons are not for use yet!

Operation Manual

You can display the help content for all commands available in the hub. They have been divided into 3 sections. Type:

  • !help - to see all general management hub commands
  • !sethelp - to see all commands needed for basic hub set up
  • !set - to see all commands to configure your hub (like: rules, limits, security settings)

Execute commands in main chat, PM bot or PM feed. Commands are not case sensitive. All variables in square brackets [ ] are optional.

Help Commands

!help content is divided into:

  • Hub Information Commands
  • User Information & Commands
  • Room Commands
  • User Control & Blocks
  • Registration Commands
  • Kick & Ban Commands
  • Admin Commands
  • Miscellaneous Commands

Hub Information Commands


All commands visible for user profile by default are:
!help - Show this help (!h)
!history - Show mainchat/chatroom history (as default will show last 15 lines)
!hubinfo - Show general hub information (!hi)
!stats - Show hub statistics


All commands visible for operator profiles by default are:
!help - Show this help (!h)
!history [<number of lines>]- Show mainchat/chatroom history (as default will show last 15 lines). Use !history 50 to show last 50 times of the history
!history [clean] - Clean mainchat/chatroom histor
!hubinfo - Show general hub information (!hi)End part of !hubinfo can be changed by operators with !set hub_info
!stats - Show hub statistics


User Information Commands


!myip - Show your own IP address
!ipinfo <ip> - Show online and offline IP information (!ii)
!dns <dns-address> - Resolve a dns-address to an IP
!revdns <ip> - Reverses an IP to a dns-address
!hide [<nick>] - Hide yourself (use without nick), or hide a user/chatroom, from users lower than it's own
!unhide [<nick>] - Unhide yourself (use without nick), or unhide a user/chatroom
!hideshare [<nick>] - Hide someone's share, without <nick> it will hide your own share
!unhideshare [<nick>] - Unhide share, this will allow incoming connection attempts
!report <nick> <reason> - Report something to the operator chatroom
!say <nick> <message> - Impersonate someone in mainchat
!userinfo <nick> - Show online and offline user information (!ui)

Example2
 !ui TestUser
General information:
User: TestUser User's nickname
SID: RG2U User's SID
CID: CS7A55JGHWI2DSILDF3R46V7JKL42T5UAZPBZKA User's CID
Protocol: NMDC Which protocol user is connected to
Profile: User (-1) User's hubprofile
IP: 97.457.436.980 User's IP
HubPort: 3131 Which port is used to connect to the hub
Active Port: 4455 User's port for active search and download
Supports:UserCommand,NoGetINFO Features supported by user's client
Countrycode: PL User's country code
Tag:<++V:0.770,M:P,H:2/0/1,S:3> User's tag
Description: Music, Movies User's description
Active / Passive: Active User's connection mode
In hubs as user: 2 How many hubs user is connected to and not registered
In hubs as regged: 0 How many hubs user is registered
In hubs with key: 1 How many hubs user is registered as an operator
Slots open:6 User's open upload slots
Sharesize:28.37 Gb (30463066280) User's share in gigabytes (exact share)
Times warned:1 How many times user has been warned
Times kicked:0 How many times user has been kicked
Blocks/Filters: Connections and searches are blocked
97.457.436.980 From: 2010/02/04 15:08:21
To: Still connected
IP history of a user
97.457.436.980 From: 2010/02/04 11:43:56
To: 2010/02/04 14:39:30
IPBAN related to this nickname
with IP: 97.457.436.980
Existing bans in database related to this IP
Nick: TestUser User's nick
IP: 97.457.436.980 Banned IP
Reason: Unknown client Reason for the ban
Date: 2010/02/04 17:55:44 Date and time of ban
By: LadyStardust Who banned the IP
Expires: 2010/02/04 18:15:44
(Expires in 0 day(s) 00:19:56)
Date and time for ban to expire


!userstats <nickname> - Show traffic statistics of user
!whisper <nick or profile or level> <msg> - Send a mainchat message to a user, to all in a profile or to all users equal to or higher than level


Room Commands


!privateroom <roomname> <nick> - Create a private chatroom/ Add nick(s) to chatroom
!invite <nick> - Invite user to a chatroom (use inside room)
!list - List the members of a chatroom (use inside room)
!leave - Leave a private chatroom (use inside room)
!uninvite <nick> - Uninvite a member of a chatroom (use inside room)


User Control and Blocks


!kenny <nick> - Kennylize a user in mainchat
!unkenny <nick> - Unkennylize a user in mainchat
!muppetize <nick> - Muppetize a user in mainchat
!unmuppetize <nick> - Unmuppetize a user in mainchat
!mute <nick> - Mute a user in mainchat, use !mute <nick> -s for stealth mute
!unmute <nick> - Unmute a user in mainchat
!blockdownload <nick> - Block a user from making new connections to users
!unblockdownload <nick> - Unblock a user from making new connections
!blockpm <nick> - Block user's private messages
!unblockpm <nick> - Allow a user to send private messages again
!showblocks - Show all (partial) blocks (download, PM, mute, kenny, muppetize)
!unblock - Remove all (partial) blocks for a user or Ip (download, PM, mute, kenny, muppetize)
!unblock * <blocktype> - Remove all blocks of a certain type. Blocktypes: mute,kenny,muppet,connects,pm


Registration Commands


!addreg <nick> <pass> <profile> [<ip>] - Register a user (!ar)
!bindip <nick> [<ip>] - Bind an IP to an account, if no IP is specified it will remove the binding.
!changereg <nick> <newnick> - Change the nickname of a registered user (!cr)
!comment <nick> <text> - Add a comment to reginfo, or !comment <nick> to clear all comments
!delreg <nick> - Remove a registered account (!dr)
!getpass <nick> - Show a user's password
!getmypass - Show your own password
!reginfo <nickname> - Show a user's registration information
!setpass [<nick>] <password> - Change a user's password
!setmypass <password> - Change your own password
!setprofile <nick> <newprofile> - Change profile of registered user (!sp)
!showprofiles - Show all profiles
!showregs <profilename> [<offset>] - Show registered users for chosen profile (or !showregs * to show all registered users

Example2
Default profiles are:
10 Hubowner - Owner of the hub
10 HubBot - Main hubbot, can't be changed
10 Gui - Profile for GUI, can't be changed
9 NetOwner - Network founder or Net owner
8 Master - Hub Master
7 Admin - Hub Administrator
6 Moderator - Hub Moderator
5 Operator - Operator
4 SuperUser - SU
3 Kvip - Special Vip
2 Vip - Very Important Person
0 Reg - Registered user
-1 User - Unregistered user
-1 Pinger - Pinger visiting the hub

Kick And Ban Commands


!drop <nick> <reason> - Disconnect a user from the hub
!dropsid <sid> <reason> - Disconnect a user
!warn <nick> <reason> - Warn a user
!unwarn <nick> - Resets the number of warnings of a user
!kick <nick> <reason> - Kicks and disconnects a user from the hub
!ban <nick> <reason> - Bans user IP and disconnects user(s) with this IP
!autoban <ip> - Autoban IP, this disconnects an IP without sending a reason and resets autoban time
!baninfo <nick/IP> - Shows information about a banned nick/IP (!bi)
!banip <ip> <reason> - Bans IP and disconnects users with this IP
!bannick <nick> <reason> - Bans nickname
!banrange <start IP>-<end IP> <reason> - Bans an IP range (and disconnects user(s) with IP in this range)
!kill <nick> <reason> - Bans user IP and nick and disconnects user(s) with this IP
!redirect <nick> <address> [<reason>] - Redirect a user
!tempban <nick>


Admin Commands


!attackstats - Shows statistics of DDOS attacks on the hub
!corestats - Show hubcore statistics (!cs)
!cmdhistory [<nick/ip>] - Show command history
!historyclean <confirmation code> - Clean mainchat/chatroom history
!mass <message> - Sends a mass PM to all users
!massprofile <profile> <message> - Sends a mass PM to all users with a certain profile
!mc <message> - Send a mainchat message from hubbot
!lockhub - Lock hub, no new connections will be allowed
!unlockhub - Unlock hub
!lockmain - Lock mainchat, only operators can speak (!lm)
!unlockmain - Unlock mainchat (!ulm)
!lockpm - Lock personal messages, only operators can PM
!unlockpm - Unlock personal messages
!quote <num> - Show a quote in mainchat or without number to show a random quote
!addquote <text> - Add a quote
!delquote <number> - Delete quote number
!delquote all <confirmation code> - Delete all quotes
!showquotes - Show all quotes
!resettimeout [<ip>] - Removes the reconnection timeout for an IP (or own IP when unspecified) for next login
!showconnects - Show new connections over the past five minutes
!showdisconnects - Show recent disconnection reasons
!showlogins - Show users currently logging in.
!showports [<portnumber>] [<offset>] - Show number of connections for all ports (if no port and offset specified) or connected users to specific port
!showsid <sid> - Show nick and IP of a user-ID (SID)
!showtopic - Show topic
!topic [-s] <message> - Set topic, or use !topic without any message to clear it, -s means dont show the change in main (use !showtopic to view the current topic)
!trafficstats - Show traffic statistics of the hub


Miscellaneous commands


!about - About FlexHub
!checksums - Generates a list of check sums of the hub files, useful for support issues
!convstats - Show Protocol Conversion Statistics

Sethelp Commands

!sethelp content is divided into:

  • Basic Hub Settings
  • Chatroom Management
  • Command Management
  • Pattern Management
  • Profile Management
  • Hublist Commands
  • Hub Management
  • Set Variables
  • Conversion Commands
  • Hub Stats Management
  • Redirect Commands

Basic Hub Settings


!sethelp - Show help for hubsettings
!sethubname <name> - Change hubname
!sethubdesc <name> - Change hubdescription
!setbotname <botname> - Change securitybot name
!setbotdesc <description> - Change securitybot description


Chatroom Management


!showrooms - Show all chatrooms
!addroom <name> <profilelevel> [<description>] - Add chatroom for <profilelevel> and higher
!delroom <name> - Delete chatroom
!setroomname <oldname> <newname> - Change Chatroom name
!setroomdesc <name> <description> - Change chatroom description


Command Management


!addcmd <name> [-o<options>] [-p<profilelevel>] [-m<max profilelevel>] [-u<use profilelevel>] [-t<time>] [-h"<helptext>"] "<text>" - Add a textcommand
<options> - A number created by adding the values of the following options:

0 - Output to mainchat (default)
1 - Display text in PM instead of mainchat
2 - Show text to all (when this is used, you can use -p and -m to limit output to certain profilelevels)
4 - Show text when user logged in (welcome messages/rightclicks)
8 - Don't allow the command to be activated in mainchat (useful in combination with 4)
16 - Do not create an item in !help for this command (forced when 8 is used)
32 - Do not create a rightclick item for this command (forced when 8 is used)
64 - Text should be send in raw format instead of mainchat/pm (useful to send custom rightclicks)
128 - Only send to ADC user(s)
256 - Only send to NMDC user(s)

<profilelevel> - (for use with option 2) A number in the range from -1 (User) to 10 (Hubowner) that is the lowest profile that will see the command output (default is -1)
<max profilelevel> - (for use with option 2) A number in the range from -1 (User) to 10 (Hubowner) that is the highest profile that will see the command output (default is level 10)
<use profilelevel> - A number in the range from -1 (User) to 10 (Hubowner) that is the lowest profile that can use the command (default is -1)
<time> - (for use with option 2) Time in seconds between broadcasts, or use m for minutes, h for hours
<helptext> - Helptext to show in !help and display in rightclick usercommands
<text> - Text to send, must be the last parameter on the line

!delcmd <name> - Delete a textcommand
!modcmd <name> [-o<options>] [-p<profilelevel>] [-m<max profilelevel>] [-u<use profilelevel>] [-t<time>] [-h"<helptext>"] "<text>" Modify a textcommand
!showcmd - List all textcommands
!showcmd <name> - Show a specific textcommand
!showcmd -showvars - Show all avaliable variables for textcommands
!renamecmd <current cmd name> <new cmd name> - Rename a textcommand (remember to reconnect to get the updated rightclicks)


Pattern Management


!addpattern <type> "<pattern>" [-p<profilelevel>] [-a<actions>] [-r<replace> "<replacetxt>"] Add textpattern, affects users of <profilelevel> and below
<type> - What to check:
MC = Mainchat
PM = Personal messages
RE = Reports
SE = Searches
SR = Searchresults

NI = Nickname
DE = Description
EM = Email
VE = Client version
SS = Sharesize

"<pattern>" - A Lua pattern for matching the string

[-p<profilelevel>] - The maximum profilelevel to check, a number in the range from -1 (User) to 10 (Hubowner), defaults to -1 if not set

[-a<actions>] - A number defining what action to take:
0 - Allow (can only be used in combination with replace)
1 - Ignore
2 - Notify user
4 - Warn user
8 - Mute user
16 - Disconnect user
32 - Kick user
64 - Ban user
128 - Redirect user (uses the redirect address from: !set rd_flood)

One of the values above (except 0) can be combined with one or more of the following:

256 - Notify Opchat
512 - Lock Mainchat (use with caution)

[-r<number> "<text>"] - What to replace <number> followed by the replacing "<text>":
1 - Replace match
2 - Replace entire message

!delpattern <type> "<pattern>" - Delete a textpattern
!modpattern <type> "<pattern>" [-p<profilelevel>] [-a<action>] [-r<replace> "<replacetxt>"] - Modify a textpattern
!showpattern <type> - Show patterns of a certain type
!showpattern <type> "<pattern>" - Show a specific pattern

Example patterns in Flexhub:

Showing patterns for: NI nickname (priority ordered)
Profile Actions Pattern Actions
0 288 "%S+://" Kick NotifyOpchat
2 32 "[Ww]+%.%w+%.%w+" Kick
0 288 "%d+%.%d+%.%d+%.%d+" Kick NotifyOpchat
Showing patterns for: MC mainchat message (priority ordered)
Profile Actions Pattern Actions
0 256 "%S+://" NotifyOpchat Replace line with: Visit our forum: http://www.flexhub.org
0 256 "%d+%.%d+%.%d+%.%d+" NotifyOpchat Replace line with: Visit our forum: http://www.flexhub.org
0 288 "[Ww][Ww][Ww]%." Replace line with: Visit our forum at: http://www.flexhub.org
Showing patterns for: PM private message (priority ordered)
Profile Actions Pattern Actions
0 256 "%S+://" NotifyOpchat Replace line with: Visit our forum: http://www.flexhub.org
0 256 "%d+%.%d+%.%d+%.%d+" NotifyOpchat Replace line with: Visit our forum: http://www.flexhub.org
-1 0 "[Ww][Ww][Ww]%." Replace line with: Visit our forum at: http://www.flexhub.org

Profile Management


!addprofile <profilename> <profilelevel> [<source profile>] - Add a profile. If no source profile is specified, the Reg profile settings will be used
!delprofile <profilename> [<replacement profile>] - Delete a userprofile, if no replacement profile is specified, users will be moved to 'Reg' profile
!modprofile <profilename> <setting> <value> - Change a profilesetting or use !modprofile -h for more help:

Showing avaliable settings for !modprofile <profilename> <setting> <value>
Show current setting with !showprofile <profilename>

Setting - Description
________________________________________________________________________________
level - Which level should this profile have, a number between -1 and 10.
desc - Profile description, a text describing the profile.
message - Profile login message, a text that can be displayed with a text command when the user logs in.
operator - Is Operator, can be set to true or false, the operator switch controls numerous behaviour in the hub, in general an operator will have precedence before any non operator.
key - Has key, can be set to true or false.
fakekey - Has 'fake' key, can be set to true or false.
hideshare - Force hideshare, can be set to true or false.
extbot - This profile is used for external bots, can be set to true or false. When set to true replies from the bot will only be seen by the user sending the command, even when used in mainchat.
relay - Enable support for the ORLY ADC extension for this profile, can be set to true or false. When set to true it allows the users of this profile to send messages to the hub that are relayed to other users as if the hub sent them.
showprofiletoops - If enabled, the profile name will be added to the description of all users, only shown to operators, can be set to true or false.
minshare - Minimum share to be allowed to join the hub (in B, kB, MB, GB, TB), set to 'false' to use the normal hub setting.
maxshare - Maximum share to be allowed to join the hub (in B, kB, MB, GB, TB), set to 'false' to use the normal hub setting.
minslots - Minimum amount of slots to be allowed to join the hub, set to 'false' to use the normal hub setting.
maxslots - Maximum amount of slots to be allowed to join the hub, set to 'false' to use the normal hub setting.
maxhubs - Maximum amount of hubs a user is allowed to be connected to, set to 'false' to use the normal hub setting.
maxpublichubs - Maximum amount of public hubs a user is allowed to be connected to, set to 'false' to use the normal hub setting.
maxreghubs - Maximum amount of hubs where user is registered to be allowed to join the hub, set to 'false' to use the normal hub setting.
maxophubs - Maximum amount of hubs where user is operator to be allowed to join the hub, set to 'false' to use the normal hub setting.


!showprofile <profilename> - Show profile settings
!allow <profilename> <commandname>[,<commandname2>] [false] - Allow a profile to use certain commands/options:

about,addquote,addreg,attackstats,ban,baninfo,banip,bannick,banrange,bindip,blockdownload,blockpm,changereg,checksums, clearautobans,clearexpiringbans,clearipbans,clearlastbans,clearnickbans,clearrangebans,cmdhistory,comment,corestats, delquote,delreg,dns,drop,dropsid,feed,getmypass,getpass,help,hide,hideshare,history,historyclean,hubinfo,invite,ipinfo, kenny,kick,kill,leave,list,lockhub,lockmain,lockpm,mass,massprofile,mc,muppetize,mute,myip,opchat,privateroom,protect, quote,redirect,reginfo,regme,report,resettimeout,revdns,say,setcmd,setmypass,setpass,setprofile,showallbans,showblocks, showconnects,showdisconnects,showipbans,showlogins,shownickbans,showports,showprofiles,showprotected,showquotes, showrangebans,showregs,showsid,showtopic,showwarns,silentban,stats,tempban,tempbanip,tempbannick,tempbanrange,tempkill, topic,trafficstats,unban,unblockdownload,unblockpm,unhide,unhideshare,uninvite,unkenny,unlockhub,unlockmain,unlockpm, unmuppetize,unmute,unprotect,unwarn,userinfo,userstats,warn,whisper

!override <profilename> <setting> [false] - Override a certain setting for a profile:

blockadc,blockdht,blockdownload,blocknmdc,blockpassive,blockproxy,blockupload,checkmyinfo,lockmc,lockpm,maxclones,maxhubs, maxophubs,maxpublichubs,maxreghubs,maxshare,maxslots,maxusers,minshare,minslots,modecheck,redirect,securityct,securityha, securityhc,securityma,securitymc,securitymn,securitypm,securitypr,securityrc,securityre,securitysa,securitysp,securitysr, securityxx

Note: !allow and !override can now use * to allow/override for all profiles


Hublist Commands


!addhublist <protocol> <address:port> - Add a hublist (protocol = ADC or NMDC)
!delhublist <protocol> <address:port> - Delete a hublist (protocol = ADC or NMDC)
!showhublists - Show hublists
!reghub - Register the hub to available hublists


Conversion Commands


!import <hubsoft> <filename> - Import accounts from ADCH, Aquila, Luadch, Ptokax, Verlihub or Ynhub, the file must be placed in the import folder (names are case sensitive)


Hub Management


!restartscripts - Restart hubscripts (!rs)
!update [now] - Update FlexHub, use !update to check if an update is avaliable and !update now to download and install updates
!restart <confirmation code> [<message to users>] - Restart FlexHub after posting the message in main
!shutdown <confirmation code> [<message to users>] - Shut down FlexHub after posting the message in main
!addports <port>,<port>S, - Add listenports for the hub, add a S for secure port (or multiple ports comma-separated, no spaces).
!delports <port>,<port>S, - Remove listenports for the hub, add a S for secure port (or multiple ports comma-separated, no spaces).


Set Variables


!set - Show hubsettings
!set <settingname> <value> - Change hubsetting

All the settings commands available in FlexHub under the !set command you can find on another page, just click: !set help explanation


Redirect Commands


!showredirects - Show redirect statistics
!showredirects clean - Clear redirect statistics
!checkredirects - Check online status of redirect addresses


Hub Stats Management


!addstats <filename> -t<time> <text> - Add saving statistics
!showstats - Show saving statistics
!showstats <filename> - Show saving statistics filename
!modstats <filename> [-t<time>] [<text>] - Modify a statistics file
!delstats <name> - Delete a statistics save


Miscellaneous


!createcert <path to openssl.exe> [-force] - Create a selfsigned certificate for SSL. Use !createcert -h for more information
!purgeaccounts <profilename or *> <days of inactivity> - Delete unused and expired accounts
!sendalive - send a ILIV command to a user
!setredirects - Set redirect addresses for multiple types
!showemptypass - Show all regs with empty passwords
!showlog <log file> [<number of lines>] - Show the last lines of a log file, type showlog without parameters to see a list of avaliable logfiles (default 25, max 100 lines)
!webstats_reg <forumnick> <forumpass> - Register this hub to enable web statistics, use your http://flexhub.org forum account details


FAQ