Every directive there is to know. Type to filter; click a directive to expand it.
No directives match your search.
Hub options
hub_namedefault: "uhub"
Description
Configures the name of the hub.
Type
String
Default
"uhub"
Since
uhub 0.1.0
Example
hub_name = "my hub"
hub_descriptiondefault: ""
Description
The description of the hub, as seen by users and hub lists.
Type
String
Default
""
Since
uhub 0.1.0
Example
hub_description = "a friendly hub for friendly people"
max_usersdefault: 500
Description
The maximum number of users allowed on the hub. No new users are allowed in once this is exceeded. Operators (and above) can still log in.
Type
Number > 0
Default
500
Since
uhub 0.1.0
Example
max_users = 25
show_bannerdefault: yes
Description
If enabled, the hub announces the software version to clients when they connect, e.g. "Powered by uhub/0.x.y".
Type
boolean
Default
yes
Since
uhub 0.1.0
Example
show_banner = no
registered_users_onlydefault: no
Description
If enabled, only registered users can use the hub. A user must be registered in the acl file (file_acl).
Type
boolean
Default
no
Since
uhub 0.1.1
chat_onlydefault: no
Description
If enabled, the hub refuses to relay search and connection-setup messages, making it viable for chat only.
Type
boolean
Default
no
Since
uhub 0.1.1
chat_is_privilegeddefault: no
Description
If enabled, only operators and admins are allowed to chat in the main chat.
Type
boolean
Default
no
Since
uhub 0.2.4
low_bandwidth_modedefault: no
Description
If enabled, the hub removes excessive information (description, e-mail, etc.) from each client's INF message before broadcasting it.
Type
boolean
Default
no
Since
uhub 0.2.2
file_motddefault: "/etc/uhub/motd.txt"
Description
A message-of-the-day file. Its contents are sent to all users after they log in. Ignored if the file is missing or empty.
Type
file
Default
"/etc/uhub/motd.txt"
Since
uhub 0.1.3
Example
file_motd = "/etc/uhub/motd.txt"
file_acldefault: "/etc/uhub/users.conf"
Description
The access control list (acl) file storing registered users, bans, etc. If missing or empty, no registered users or ban records are used.
Type
file
Default
"/etc/uhub/users.conf"
Since
uhub 0.1.3
Example
file_acl = "/etc/uhub/users.conf"
server_bind_addrdefault: "any"
Description
The IP address the hub binds to. An IPv4/IPv6 address, or the special values "any" or "loopback". With "any"/"loopback" the hub auto-detects and prefers IPv6.
Type
String, IP address, "any" or "loopback"
Default
"any"
Since
uhub 0.1.2
Example
server_bind_addr = "192.168.12.69"
server_portdefault: 1511
Description
The port number the hub listens on.
Type
number > 0 and < 65536
Default
1511
Since
uhub 0.1.0
server_listen_backlogdefault: 50
Description
Number of connections the hub accepts in the backlog before they must be processed. Too low a value means the hub will not accept reconnecting users fast enough.
Type
number > 5
Default
50
Since
uhub 0.3.0
limit_max_hubs_userdefault: 0
Description
Limits the number of hubs a user can be logged into as a guest. If exceeded, entry is denied.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_max_hubs_regdefault: 0
Description
Limits the number of hubs a user can be logged into as a registered user.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_max_hubs_opdefault: 0
Description
Limits the number of hubs a user can be logged into as an operator.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_max_hubsdefault: 0
Description
Limits the total number of hubs a user can be logged into, regardless of registration or privileges.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_min_hubs_userdefault: 0
Description
Only allow users that are logged into other hubs with guest privileges to enter this hub.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_min_hubs_regdefault: 0
Description
Only allow users that are logged into other hubs as a registered user to enter this hub.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_min_hubs_opdefault: 0
Description
Only allow users that are logged into other hubs with operator privileges to enter this hub.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_min_sharedefault: 0
Description
Minimum share in MiB. Users sharing less are not allowed in.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
Example
limit_min_share = 1024
limit_max_sharedefault: 0
Description
Maximum share in MiB. Users sharing more are not allowed in.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_min_slotsdefault: 0
Description
Minimum number of upload slots required. Users with fewer are not allowed in.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
limit_max_slotsdefault: 0
Description
Maximum number of upload slots allowed. Users with more are not allowed in.
Type
number, 0 = disabled
Default
0
Since
uhub 0.2.0
tls_certificateno default
Description
Path to a TLS/SSL certificate (PEM format).
Type
file
Since
uhub 0.3.0
tls_private_keyno default
Description
Path to a TLS/SSL private key (PEM format).
Type
file
Since
uhub 0.3.0
tls_enabledefault: no
Description
Enables/disables TLS/SSL support. tls_certificate and tls_private_key must be set if enabled.
Type
boolean
Default
no
Since
uhub 0.3.0
tls_requiredefault: yes
Description
If TLS/SSL is enabled, whether it is mandatory. If disabled, users may connect with or without TLS.
Type
boolean
Default
yes
Since
uhub 0.3.0
Access control (users.conf)
user_adminusername:password
Description
An administrator user with full access to configure the hub, plus operator privileges.
Syntax
user_admin username:password
Since
uhub 0.1.2
user_superusername:password
Description
A super user with more privileges than an operator but fewer than an administrator.
Syntax
user_super username:password
Since
uhub 0.2.1
user_opusername:password
Description
An operator who can kick and ban users from the hub.
Syntax
user_op username:password
Since
uhub 0.1.2
user_regusername:password
Description
A registered user with no special privileges, but a password-protected username that can enter registered-only hubs.
Syntax
user_reg username:password
Since
uhub 0.1.2
deny_nickusername
Description
A denied username. Any user identifying with this nickname is denied access.
A user banned by nickname. Differs from deny_nick in the message the user receives.
Syntax
ban_nick username
ban_cidcid
Description
A user banned by CID (a 39-byte base32-encoded client identifier).
Syntax
ban_cid cid
Since
uhub 0.1.2
Example
ban_cid FOIL5EK2UDZYAXT7UIUFEKL4SEBEAJE3INJDKAY
deny_ipip range/mask
Description
Deny access to users from certain IP addresses, given as ranges or address/bitmask. Works for IPv6 too.
Syntax
deny_ip ip range/mask
Since
uhub 0.1.2
Example
deny_ip 192.168.0.0/24 deny_ip ::1/128
nat_ipip range/mask
Description
Allow users behind the same NAT router as the hub to advertise a public IP. The hub rewrites IPs for other users on the same NATed network. IPv4 only.
Syntax
nat_ip ip range/mask
Since
uhub 0.2.1
Example
nat_ip 192.168.1.0/24
Message strings
msg_hub_fullstring
Description
Sent when the hub is full.
Type
String
Default
"Hub is full"
Since
uhub 0.2.0
msg_hub_disabledstring
Description
Sent when the hub is disabled (hub_enable = no).
Type
String
Default
"Hub is disabled"
Since
uhub 0.2.0
msg_hub_registered_users_onlystring
Description
Sent when the hub only accepts registered users.
Type
String
Default
"Hub is for registered users only"
Since
uhub 0.2.0
msg_inf_error_nick_missingstring
Description
Sent to clients that do not provide a nickname.
Type
String
Default
"No nickname given"
Since
uhub 0.2.0
msg_inf_error_nick_multiplestring
Description
Sent to clients that provide multiple nicknames.
Type
String
Default
"Multiple nicknames given"
Since
uhub 0.2.0
msg_inf_error_nick_invalidstring
Description
Sent to clients that provide an invalid nickname.
Type
String
Default
"Nickname is invalid"
Since
uhub 0.2.0
msg_inf_error_nick_longstring
Description
Sent to clients with a too-long nickname.
Type
String
Default
"Nickname too long"
Since
uhub 0.2.0
msg_inf_error_nick_shortstring
Description
Sent to clients with a too-short nickname.
Type
String
Default
"Nickname too short"
Since
uhub 0.2.0
msg_inf_error_nick_spacesstring
Description
Sent to clients whose nickname starts with a space.
Type
String
Default
"Nickname cannot start with spaces"
Since
uhub 0.2.0
msg_inf_error_nick_bad_charsstring
Description
Sent to clients with invalid characters in the nickname.
Type
String
Default
"Nickname contains invalid characters"
Since
uhub 0.2.0
msg_inf_error_nick_not_utf8string
Description
Sent to clients whose nickname is not valid UTF-8.
Type
String
Default
"Nickname is not valid utf8"
Since
uhub 0.2.0
msg_inf_error_nick_takenstring
Description
Sent when the provided nickname is already in use.
Type
String
Default
"Nickname is already in use"
Since
uhub 0.2.0
msg_inf_error_nick_restrictedstring
Description
Sent when a restricted nickname is used (configured in the acl).
Type
String
Default
"Nickname cannot be used on this hub"
Since
uhub 0.2.0
msg_inf_error_cid_invalidstring
Description
Sent to clients that provide an invalid client ID (CID).
Type
String
Default
"CID is not valid"
Since
uhub 0.2.0
msg_inf_error_cid_missingstring
Description
Sent to clients that do not provide a client ID (CID).
Type
String
Default
"CID is not specified"
Since
uhub 0.2.0
msg_inf_error_cid_takenstring
Description
Sent when the provided CID is already in use.
Type
String
Default
"CID is taken"
Since
uhub 0.2.0
msg_inf_error_pid_missingstring
Description
Sent to clients that do not provide a private ID (PID).
Type
String
Default
"PID is not specified"
Since
uhub 0.2.0
msg_inf_error_pid_invalidstring
Description
Sent to clients that provide an invalid private ID (PID).
Type
String
Default
"PID is invalid"
Since
uhub 0.2.0
msg_ban_permanentlystring
Description
Sent to users who are permanently banned (see acl).
Type
String
Default
"Banned permanently"
Since
uhub 0.2.0
msg_ban_temporarilystring
Description
Sent to users who are temporarily banned.
Type
String
Default
"Banned temporarily"
Since
uhub 0.2.0
msg_auth_invalid_passwordstring
Description
Sent to users who provide a wrong password.
Type
String
Default
"Password is wrong"
Since
uhub 0.2.0
msg_user_share_size_lowstring
Description
Sent to users who are not sharing enough.
Type
String
Default
"User is not sharing enough"
Since
uhub 0.2.0
msg_user_share_size_highstring
Description
Sent to users who are sharing too much.
Type
String
Default
"User is sharing too much"
Since
uhub 0.2.0
msg_user_slots_lowstring
Description
Sent to users with too few upload slots.
Type
String
Default
"User have too few upload slots."
Since
uhub 0.2.0
msg_user_slots_highstring
Description
Sent to users with too many upload slots.
Type
String
Default
"User have too many upload slots."
Since
uhub 0.2.0
msg_user_hub_limit_lowstring
Description
Sent to users on too few other hubs.
Type
String
Default
"User is on too few hubs."
Since
uhub 0.2.0
msg_user_hub_limit_highstring
Description
Sent to users on too many other hubs.
Type
String
Default
"User is on too many hubs."
Since
uhub 0.2.0
Advanced
hub_enableddefault: yes
Description
Use this to disable the hub for a while.
Type
boolean
Default
yes
Since
uhub 0.1.3
max_recv_bufferdefault: 4096
Description
Maximum receive buffer before commands are processed. A single ADC message exceeding this limit is discarded. Use with caution.
Type
number
Default
4096
max_send_bufferdefault: 131072
Description
Maximum bytes queued for sending to a user before the hub disconnects them. Lower means more aggressive disconnection of slow clients. Use with caution.
Type
number
Default
131072
max_send_buffer_softdefault: 98304
Description
Like max_send_buffer, but low-priority messages may be discarded once reached. Use with caution.
