doc/features/services.txt

   1 Services compatibility documentation
   2 ------------------------------------
   3
   4 Originally written by Lee Hardy for ircd-ratbox. Minor changes by Elizabeth
   5 Myers for modern services.
   6
   7
   8 Compatibility with services is always enabled.  Supported services include
   9 atheme and anope. They add the following features to Charybdis:
  10
  11 1. Channel mode +r
  12
  13    A simple mode taking no parameters, will require users are logged in
  14    with user services before they may join the channel.
  15
  16    Gives numeric 477 to users who arent logged in:
  17    :<server> 477 <nick> <channel> :Cannot join channel (+r)
  18
  19 2. service block to ircd.conf
  20
  21    Ability to specify the names of services servers in ircd.conf:
  22    service {
  23        name = "services.charybdis.io";
  24        name = "backup-services.charybdis.io";
  25    };
  26
  27    These must be specified for certain features to work.  You may specify as
  28    many name entries as you wish, however you must define only one service
  29    block.
  30
  31    Entries will be listed in stats U with the flag 's'.
  32
  33 3. Services protection
  34
  35    Services will be protected from being deopped or kicked from a channel.
  36
  37 4. Username tracking through netsplits
  38
  39    When users are logged in, the username they are logged in with will be
  40    preserved on a netsplit, so users will not have to relogin when the
  41    network merges together.
  42
  43 5. Username given on WHOIS
  44
  45    When users are logged in, WHOIS will also give numeric 330:
  46    :<server> 330 <yournick> <targetnick> <loginname> :is logged in as
  47
  48 6. Forced nick change
  49
  50    When using nickname services and a client requests they regain a
  51    nickname, services can perform a forced nick change on the client.
  52    This forcibly changes the clients nickname to the one they requested
  53    they regain, ensuring they can always regain their nickname.
  54
  55 7. User mode +R
  56
  57    This user mode will require users are logged in with user services
  58    before they may send private messages or notices to the user.
  59
  60    As with user mode +g, IRC operators and accepted users can send even
  61    if they are not logged in.
  62
  63    Gives numeric 486 to users sending a PRIVMSG who are not logged in:
  64    :<server> 486 <nick> <targetnick> :You must log in with services to message this user
  65