Fix some signed/unsigned misbehaviors; add FAQ
[srvx.git] / FAQ
1 srvx Frequently Asked Questions
2 -------------------------------
3
4 This FAQ assumes that your services are named NickServ, ChanServ and
5 OpServ respectively.
6
7 Q1) How do I set up srvx?
8 A1) Read the README and INSTALL files, especially INSTALL.
9
10 Q2) How do I set up my IRC server so srvx talks to it?
11 A2) That depends on which IRC server you use.  Check its
12 documentation.  #srvx WILL NOT SUPPORT YOUR IRCD QUESTIONS.
13
14 Q3) I get "You must first authenticate with NickServ", help!
15 A3) To register an account, /msg NickServ@services.example.com
16 register YourName Password.  You must be a global IRC operator to
17 register the first account; srvx gives the first account "root" level
18 (1000) access.  To log in afterwards, use the "auth" command instead
19 of "register".
20
21 Q4) I do not like having to type "/msg NickServ@services.example.com"
22 for all of my commands.  How can I change that?
23 A4) If you want to disable that for the auth command, use "/msg OpServ
24 modcmd NickServ.auth flags -qualified".  However, that is a BAD idea:
25 if you have an auto-perform to log in, and you connect to some other
26 IRC network, you will send your password to whoever or whatever is
27 named NickServ on that network.
28
29 Q5) When I try to register a channel with ChanServ, it tells me I have
30 to have "security override" on.  Why?
31 A5-1) srvx's default configuration is to only allow network staff to
32 register channels.  For IRC operators and network helpers (users with
33 account flag +H), security override can be enabled by sending "/msg
34 ChanServ god on".  For support helpers (users with account flag +h),
35 security override is enabled when the user is in the configured
36 support channel.
37 A5-2) If you want to allow anyone to register channels, use "/msg
38 OpServ modcmd ChanServ.register flags -helping".
39
40 Q6) How do I enable HelpServ?
41 A6) When you run the "configure" script, you must enable the helpserv
42 module; for example, "./configure --enable-modules=helpserv".  After
43 you compile and start srvx with that option, "/msg OpServ bind OpServ
44 helpserv *helpserv.helpserv".  After that, you can use "/msg OpServ
45 helpserv help" and "/msg OpServ helpserv register"; the "helpserv"
46 command acts as a gateway into the HelpServ system.
47
48 Q7) How do I enable MemoServ?
49 A7) When you run the "configure" script, you must enable the MemoServ
50 module; for example, "./configure --enable-modules=memoserv".  Then
51 see the comment near the start of src/mod-memoserv.c for configuration
52 options.