Users

• Get started
• Example
• Reference
• Plug-ins
• SSL documentation

Developers

• Contributors
• Compiling
• Architecture
• Plug-in API

Configuration directives

expand all | collapse_all
• chat_is_privileged

  Description:	If enabled only operators and admins are allowed to chat in the main chat.
  Type:	boolean
  Since:	uhub 0.2.4

• file_acl

  Description:	This is an access control list (acl) file. In this file all registered users, bans, etc should be stored. If the file is missing, or empty no registered users, or ban records are used.
  Type:	file
  Since:	uhub 0.1.3

• file_plugins

  Description:	Plugin configuration file.
  Type:	file
  Since:	uhub 0.3.3

• flood_ctl_chat

  Description:	If this is 0 then no flood control is disabled for chat messages.
  Type:	integer
  Since:	uhub 0.3.1

• flood_ctl_connect

  Description:	If this is 0 then no flood control is disabled for connection requests.
  Type:	integer
  Since:	uhub 0.3.1

• flood_ctl_extras

  Description:	Extra messages are messages that don't fit into the category of chat, search, update or connect.
  Type:	integer
  Since:	uhub 0.3.1

• flood_ctl_interval

  Description:	This is the time interval that will be used for all flood control calculations. If this is 0 then all flood control is disabled.
  Type:	integer
  Since:	uhub 0.3.1

• flood_ctl_search

  Description:	If this is 0 then no flood control is disabled for search requests.
  Type:	integer
  Since:	uhub 0.3.1

• flood_ctl_update

  Description:	If this is 0 then no flood control is disabled for info updates (INF messages).
  Type:	integer
  Since:	uhub 0.3.1

• hub_description

  Description:	This is the description of the hub, as seen by users and hub lists.
  Type:	string
  Since:	uhub 0.1.0

• hub_enabled

  Description:	Use this to disable the hub for a while.
  Type:	boolean
  Since:	uhub 0.1.3

• hub_name

  Description:	Configures the name of the hub
  Type:	string
  Since:	uhub 0.1.0

• limit_max_hubs

  Description:	Limit the number of hubs a user can be logged into in total regardless of registrations or privileges. If this number is exceeded, the user will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_max_hubs_op

  Description:	This limits the number of hubs a user can be logged into as an operator. If this number is exceeded, the user will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_max_hubs_reg

  Description:	This limits the number of hubs a user can be logged into as a registered user. If this number is exceeded, the user will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_max_hubs_user

  Description:	This limits the number of hubs a user can be logged into as a guest user. If this number is exceeded, the user will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_max_share

  Description:	Maximum share limit in megabytes (MiB). Users sharing more than this will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_max_slots

  Description:	Maximum number of upload slots allowed. Users with more than this will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_min_hubs_op

  Description:	Only allow users that are logged into other hubs with operator privileges to enter this hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_min_hubs_reg

  Description:	Only allow users that are logged into other hubs as a registered user to enter this hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_min_hubs_user

  Description:	Only allow users that are logged into other hubs with guest privileges to enter this hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_min_share

  Description:	Minimum share limit in megabytes (MiB). Users sharing less than this will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• limit_min_slots

  Description:	Minimum number of upload slots required. Users with less than this will not be allowed to enter the hub.
  Type:	integer
  Since:	uhub 0.2.0

• low_bandwidth_mode

  Description:	If this is enabled the hub will remove excessive information from each user's info message before broadcasting to all connected users. Description, e-mail address will be removed. This saves upload bandwidth for the hub.
  Type:	boolean
  Since:	uhub 0.2.2
  Example	true

• max_chat_history

  Description:	This specifies the number of main chat messages that are kept in the history buffer. Users can use the "!history" command to list these messages.
  Type:	integer
  Since:	uhub 0.3.0

• max_logout_log

  Description:	Operators can use the "!log" command to list users who have recently left the hub. This option specifies the maximum size of this log.
  Type:	integer
  Since:	uhub 0.3.0

• max_recv_buffer

  Description:	Maximum receive buffer allowed before commands are procesed. If a single ADC message exceeds this limit, it will be discarded by the hub. Use with caution.
  Type:	integer
  Since:	uhub 0.1.3
  Example	true

• max_send_buffer

  Description:	Maximum amount of bytes allowed to be queued for sending to any particular user before the hub will disconnect the user. The lower the limit, the more aggressive the hub will be to disconnect slow clients. Use with caution.
  Type:	integer
  Since:	uhub 0.1.3
  Example	true

• max_send_buffer_soft

  Description:	Same as max_send_buffer, however low priority messages may be discarded if this limit is reached. Use with caution.
  Type:	integer
  Since:	uhub 0.1.3
  Example	true

• max_users

  Description:	The maximum amount of users allowed on the hub. No new users will be allowed to enter the hub if this number is exceeded, however privileged users (operators, admins, etc) are still able to log in.
  Type:	integer
  Since:	uhub 0.1.0

• msg_auth_invalid_password

  Description:	This message is sent to users if they provide a wrong password.
  Type:	message
  Since:	uhub 0.2.0

• msg_auth_user_not_found

  Description:	This message is used if a user cannot be found in the password database.
  Type:	message
  Since:	uhub 0.2.0

• msg_ban_permanently

  Description:	This message is sent to users if they are banned (see acl)
  Type:	message
  Since:	uhub 0.2.0

• msg_ban_temporarily

  Description:	This message is sent to users if they are banned temporarily
  Type:	message
  Since:	uhub 0.2.0

• msg_error_no_memory

  Description:	Hub has no more memory
  Type:	message
  Since:	uhub 0.2.0

• msg_hub_disabled

  Description:	This will be sent if the hub is disabled (hub_enable = off)
  Type:	message
  Since:	uhub 0.2.0

• msg_hub_full

  Description:	This will be sent if the hub is full
  Type:	message
  Since:	uhub 0.2.0

• msg_hub_registered_users_only

  Description:	This will be sent if the hub is configured to only accept registered users (registered_users_only = yes)
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_cid_invalid

  Description:	This is an error message that will be sent to clients that provides an invalid client ID (CID)
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_cid_missing

  Description:	This is an error message that will be sent to clients that does not provide a client ID (CID)
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_cid_taken

  Description:	This is an error message that will be sent to clients that provides a client ID (CID) already in use on the hub.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_bad_chars

  Description:	This is an error message that will be sent to clients that provides invalid characters in the nickname.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_invalid

  Description:	This is an error message that will be sent to clients that provides an invalid nickname.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_long

  Description:	This is an error message that will be sent to clients that provides a too long nickname.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_missing

  Description:	This is an error message that will be sent to clients that do not provide a nickname.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_multiple

  Description:	This is an error message that will be sent to clients that provide multiple nicknames.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_not_utf8

  Description:	This is an error message that will be sent to clients that provides a nick name that is not valid UTF-8 encoded.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_restricted

  Description:	This message will be sent to clients if they provide a restricted nickname. Restricted names can be configured in the acl.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_short

  Description:	This is an error message that will be sent to clients that provides a too short nickname.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_spaces

  Description:	This is an error message that will be sent to clients that provides a nickname that starts with a space.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_nick_taken

  Description:	This message will be sent to clients if their provided nickname is alredy in use on the hub.
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_pid_invalid

  Description:	This is an error message that will be sent to clients that provides an invalid private ID (PID)
  Type:	message
  Since:	uhub 0.2.0

• msg_inf_error_pid_missing

  Description:	This is an error message that will be sent to clients that does not provide a private ID (PID)
  Type:	message
  Since:	uhub 0.2.0

• msg_proto_no_common_hash

  Description:	This message is sent if a client connects that does support ADC/1.0 but not a hash algorithm that the hub supports.
  Type:	message
  Since:	uhub 0.3.1

• msg_proto_obsolete_adc0

  Description:	This message is sent if a client connects that does not support ADC/1.0, but rather the obsolete ADC/0.1 version.
  Type:	message
  Since:	uhub 0.3.1

• msg_user_flood_chat

  Description:	This message is sent once to users who are flooding the chat.
  Type:	message
  Since:	uhub 0.3.1

• msg_user_flood_connect

  Description:	This message is sent once to users who are sending too many connect requests too fast.
  Type:	message
  Since:	uhub 0.3.1

• msg_user_flood_extras

  Description:	This message is sent once to users who are sending too many messages to the hub that neither are chat, searhes, updates nor connection requests..
  Type:	message
  Since:	uhub 0.3.1

• msg_user_flood_search

  Description:	This message is sent once to users who are sending too many search requests too fast.
  Type:	message
  Since:	uhub 0.3.1

• msg_user_flood_update

  Description:	This message is sent once to users who are sending too many updates too fast.
  Type:	message
  Since:	uhub 0.3.1

• msg_user_hub_limit_high

  Description:	This message is sent to users if they are on too many other hubs.
  Type:	message
  Since:	uhub 0.2.0

• msg_user_hub_limit_low

  Description:	This message is sent to users if they are on too few other hubs.
  Type:	message
  Since:	uhub 0.2.0

• msg_user_share_size_high

  Description:	This message is sent to users if they are sharing too much.
  Type:	message
  Since:	uhub 0.2.0

• msg_user_share_size_low

  Description:	This message is sent to users if they are not sharing enough.
  Type:	message
  Since:	uhub 0.2.0

• msg_user_slots_high

  Description:	This message is sent to users if they have too many upload slots.
  Type:	message
  Since:	uhub 0.2.0

• msg_user_slots_low

  Description:	This message is sent to users if they do not have enough upload slots.
  Type:	message
  Since:	uhub 0.2.0

• obsolete_clients

  Description:	If this is enabled users using old ADC clients are allowed to enter the hub, however they cannot log in using passwords since the protocols are incompatible.
  Type:	boolean
  Since:	uhub 0.3.1

• redirect_addr

  Description:	This is the redirect address used when the hub wants to redirect a client for not fulfilling some requirements.
  Type:	string
  Since:	uhub 0.3.2

• registered_users_only

  Description:	If this is enabled only registered users will be able to use the hub. A user must be registered in the acl file (file_acl).
  Type:	boolean
  Since:	uhub 0.1.1

• register_self

  Description:	If this is enabled guests can register their nickname on the hub. Otherwise only operators can register users.
  Type:	boolean
  Since:	uhub 0.4.0

• server_alt_ports

  Description:	In addition to the server_port the hub can listen to a list of alternative ports.
  Type:	string
  Since:	uhub 0.3.0

• server_bind_addr

  Description:	Specify the IP address the local hub should bind to. This can be an IPv4 or IPv6 address, or one of the special addresses "any" or "loopback". When "any" or "loopback" is used, the hub will automatically detect if IPv6 is supported and prefer that.
  Type:	string
  Since:	uhub 0.1.2

• server_listen_backlog

  Description:	This specifies the number of connections the hub will be able to accept in the backlog before they must be processed by the hub. A too low number here will mean the hub will not accept connections fast enough when users are reconnecting really fast. The hub should under normal circumstances be able to empty the listen backlog several times per second.
  Type:	integer
  Since:	uhub 0.3.0

• server_port

  Description:	This specifies the port number the hub should listen on.
  Type:	integer
  Since:	uhub 0.1.0

• show_banner

  Description:	If enabled, the hub will announce the software version running to clients when they connect with a message like: "Powered by uhub/0.x.y"
  Type:	boolean
  Since:	uhub 0.1.0

• show_banner_sys_info

  Description:	If enabled, the hub will announce the operating system and CPU architecture to clients when they join. This option has no effect if show_banner is disabled.
  Type:	boolean
  Since:	uhub 0.3.0

• tls_certificate

  Description:	Path to a TLS/SSL certificate (PEM format).
  Type:	file
  Since:	uhub 0.3.0

• tls_enable

  Description:	Enables/disables TLS/SSL support. tls_certificate and tls_private_key must be set if this is enabled.
  Type:	boolean
  Since:	uhub 0.3.0

• tls_private_key

  Description:	Path to a TLS/SSL private key (PEM format).
  Type:	file
  Since:	uhub 0.3.0

• tls_require

  Description:	If TLS/SSL support is enabled it can either be optional or mandatory. If this option is disabled then SSL/TLS is not required to enter the hub, however it is possible to enter either with or without. This option has no effect unless tls_enable is enabled.
  Type:	boolean
  Since:	uhub 0.3.0

• tls_require_redirect_addr

  Description:	This is the redirect address used when the hub wants to redirect a client for not using ADCS. For instance a hub at adc://adc.example.com might redirect to adcs://adc.example.com
  Type:	string
  Since:	uhub 0.3.3

uhub is copyright © 2007-2023 Jan Vidar Krey (uhub <at> extatic <dot> org)