Documentation update for reserved SIDs.

This commit is contained in:
Blair Bonnett 2012-08-14 11:35:50 +12:00
parent dc94754488
commit a95e703b36
2 changed files with 10 additions and 0 deletions

View File

@ -28,6 +28,13 @@ show_banner_sys_info=1
# Allow only registered users on the hub if set to 1.
registered_users_only=0
# Reserve SIDs for certain users. These users must have a registered account.
# CHANGES TO THIS VALUE WILL NOT BE NOTICED BY A CONFIGURATION RELOAD, YOU
# MUST RESTART THE HUB FOR THEM TO TAKE EFFECT.
#
# QuoteBot = AAAB, StatBot = AAAC
# reserved_sids=QuoteBot StatBot
# A server name and description.
hub_name=my hub
hub_description=Powered by uHub

View File

@ -127,6 +127,9 @@
<p>
Each nickname in the list must be separated by a space. The SID AAAA is reserved for the hub itself. The first nickname in the list will be aliased to AAAB, the second to AAAC and so on. Fixed SIDs can only be allocated to registered users - if somebody without a password logs in under a reserved nickname, the alias will not be applied (but they can still log in). Also, they are only checked when a private message is sent, so any other messages to/from the aliased SID will be dropped as an unknown user per the ADC protocol.
</p>
<p>
<strong>As these SIDs are reserved when the hub starts up, any change to the values are ignored when the configuration is reloaded. You have to restart the hub for the changes to take effect.</strong>
</p>
]]></description>
<example><![CDATA[
# QuoteBot = AAAB, StatBot = AAAC