uhub

- High performance ADC hub

expand all | collapse_all
• hub_name

  Description:	Configures the name of the hub
  Syntax:	String
  Since:	uhub 0.1.0
  Example:	hub_name = "my hub"

• hub_description

  Description:	This is the description of the hub, as seen by users and hub lists
  Syntax:	String
  Since:	uhub 0.1.0
  Example:	hub_description = "a friendly hub for friendly people"

• max_users

  Description:	The maximum amount of users allowed on the hub. No new users will be allowed to enter the hub if the number of users is greater than this. Operators (and above) are still able to log in.
  Syntax:	Number > 0
  Since:	uhub 0.1.0
  Example:	max_users = 25

• 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"
  Syntax:	boolean
  Since:	uhub 0.1.0
  Example:	show_banner = no

• 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).
  Syntax:	boolean
  Since:	uhub 0.1.1

• chat_only

  Description:	If this is enabled the hub will refuse to relay messages for search and connection setup. This effectively makes the hub viable for chat only.
  Syntax:	boolean
  Since:	uhub 0.1.1

• chat_is_privileged

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

• low_bandwidth_mode

  Description:	If this is enabled the hub will remove excessive information from each client's INF message before broadcasting to all connected users. Things like description, e-mail address will be removed.
  Syntax:	boolean
  Since:	uhub 0.2.2

• file_motd

  Description:	This can be specified as a message of the day file. If a valid file is given here it's content will be sent to all users after they have logged in to the hub. If the file is missing or empty this configuration entry will be ignored.
  Syntax:	file
  Since:	uhub 0.1.3
  Example:	Unix users: file_acl = "/etc/uhub/motd.txt" Windows users: file_acl = "c:\uhub\motd.txt"

• 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.
  Syntax:	file
  Since:	uhub 0.1.3
  Example:	Unix users: file_acl = "/etc/uhub/users.conf" Windows users: file_acl = "c:\uhub\users.conf"

• 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.
  Syntax:	String, IP address, "any" or "loopback"
  Since:	uhub 0.1.2
  Example:	To listen to a specific IP:server_bind_addr = "192.168.12.69" To listen to any IP:server_bind_addr = "0.0.0.0" Or: server_bind_addr = "any"

• server_port

  Description:	This is specifies the port number the hub should listen on.
  Syntax:	number > 0 and < 65536
  Since:	uhub 0.1.0

• 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.
  Syntax:	number > 5
  Since:	uhub 0.3.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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  Since:	uhub 0.2.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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  Since:	uhub 0.2.0
  Example:	To require users to share at least 1 GB in order to enter the hub: limit_min_share = 1024

• limit_max_share

  Description:	Maximum share limit in megabytes (MiB). Users sharing more than this will not be allowed to enter the hub.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  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.
  Syntax:	number, 0 = disabled
  Since:	uhub 0.2.0

• tls_certificate

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

• tls_private_key

  Description:	Path to a TLS/SSL private key (PEM format).
  Syntax:	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..
  Syntax:	boolean
  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.
  Syntax:	boolean
  Since:	uhub 0.3.0

These are advanced settings and should not be used unless you really know what you are doing!

expand all | collapse_all
• hub_enabled

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

• 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.
  Syntax:	number

• 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.
  Syntax:	number

• 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.
  Syntax:	number