]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/conf/opers.conf.example
Merge insp20
[user/henk/code/inspircd.git] / docs / conf / opers.conf.example
1 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
2 #                                                                     #
3 #   Classes are a group of commands which are grouped together and    #
4 #   given a unique name. They're used to define which commands        #
5 #   are available to certain types of Operators.                      #
6 #                                                                     #
7 #                                                                     #
8 #  Note: It is possible to make a class which covers all available    #
9 #  commands. To do this, specify commands="*". This is not really     #
10 #  recommended, as it negates the whole purpose of the class system,  #
11 #  however it is provided for fast configuration (e.g. in test nets)  #
12 #                                                                     #
13
14 <class
15      name="Shutdown"
16
17      # commands: oper commands that users of this class can run.
18      commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD GUNLOADMODULE GRELOADMODULE SAJOIN SAPART SANICK SAQUIT SATOPIC"
19
20      # privs: special privileges that users with this class may utilise.
21      #  VIEWING:
22      #   - channels/auspex: allows opers with this priv to see more detail about channels than normal users.
23      #   - users/auspex: allows opers with this priv to view more details about users than normal users.
24      #   - servers/auspex: allows opers with this priv to see more detail about server information than normal users.
25      # ACTIONS:
26      #   - users/mass-message: allows opers with this priv to PRIVMSG and NOTICE to a server mask (e.g. NOTICE $*)
27      #   - users/samode-usermodes: allows opers with this priv to change the user modes of any other user using /SAMODE
28      #   - channels/high-join-limit: allows opers with this priv to join <channels:opers> total channels instead of <channels:users> total channels.
29      # PERMISSIONS:
30      #   - users/flood/no-throttle: allows opers with this priv to send commands without being throttled (*NOTE)
31      #   - users/flood/increased-buffers: allows opers with this priv to send and receive data without worrying about being disconnected for exceeding limits (*NOTE)
32      #
33      # *NOTE: These privs are potentially dangerous, as they grant users with them the ability to hammer your server's CPU/RAM as much as they want, essentially.
34      privs="users/auspex channels/auspex servers/auspex users/mass-message channels/high-join-limit users/flood/no-throttle users/flood/increased-buffers"
35
36      # usermodes: Oper-only usermodes that opers with this class can use.
37      usermodes="*"
38
39      # chanmodes: Oper-only channel modes that opers with this class can use.
40      chanmodes="*">
41
42 <class name="ServerLink" commands="CONNECT SQUIT CONNECT MKPASSWD ALLTIME SWHOIS CLOSE JUMPSERVER LOCKSERV" usermodes="*" chanmodes="*" privs="servers/auspex">
43 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE TLINE RLINE CHECK NICKLOCK SHUN CLONES CBAN" usermodes="*" chanmodes="*">
44 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE" usermodes="*" chanmodes="*" privs="users/mass-message">
45 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT" usermodes="*" chanmodes="*" privs="users/auspex">
46
47
48 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
49 #                                                                     #
50 #   This is where you specify which types of operators you have on    #
51 #   your server, as well as the commands they are allowed to use.     #
52 #   This works alongside with the classes specified above.            #
53 #                                                                     #
54
55 <type
56     # name: Name of type. Used in actual olines below.
57     name="NetAdmin"
58
59     # classes: classes (above blocks) that this type belongs to.
60     classes="OperChat BanControl HostCloak Shutdown ServerLink"
61
62     # vhost: host oper gets on oper-up. This is optional.
63     vhost="netadmin.omega.org.za"
64
65     # modes: usermodes besides +o that are set on a oper of this type
66     # when they oper up. Used for snomasks and other things.
67     # Requires that m_opermodes.so be loaded.
68     modes="+s +cCqQ">
69
70 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" vhost="ircop.omega.org.za">
71 <type name="Helper" classes="HostCloak" vhost="helper.omega.org.za">
72
73
74 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
75 #                                                                     #
76 #   Opers are defined here. This is a very important section.         #
77 #   Remember to only make operators out of trust worthy people.       #
78 #                                                                     #
79
80 # oline with plain-text password
81 <oper
82       # name: oper login that is used to oper up (/oper name password).
83       # Remember: This is case sensitive
84       name="Brain"
85
86       # password: case-sensitive, unhashed...yea...self-explanatory.
87       password="s3cret"
88
89       # host: What hostnames/IP's are allowed to oper up with this oline.
90       # Multiple options can be separated by spaces and CIDR's are allowed.
91       # You CAN use just * or *@* for this section, but it is not recommended
92       # for security reasons.
93       host="yourident@dialup15.isp.com *@localhost *@example.com *@2001:db8::/32"
94
95       # ** ADVANCED ** This option is disabled by default.
96       # fingerprint: When using the m_sslinfo module, you may specify
97       # a key fingerprint here. This can be obtained by using the /sslinfo
98       # command while the module is loaded, and is also noticed on connect.
99       # This enhances security by verifying that the person opering up has
100       # a matching SSL client certificate, which is very difficult to
101       # forge (impossible unless preimage attacks on the hash exist).
102       # If m_sslinfo isn't loaded, this option will be ignored.
103       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
104
105       # autologin: if an SSL fingerprint for this oper is specified, you can
106       # have the oper block automatically log in. This moves all security of the
107       # oper block to the protection of the client certificate, so be sure that
108       # the private key is well-protected! Requires m_sslinfo.
109       #autologin="on"
110
111       # sslonly: This oper can only oper up if they're using a SSL connection.
112       # Setting this option adds a decent bit of security. Highly recommended
113       # if the oper is on wifi, or specifically, unsecured wifi. Note that it
114       # is redundant to specify this option if you specify a fingerprint.
115       # This setting only takes effect if m_sslinfo is loaded.
116       #sslonly="yes"
117
118       # vhost: overrides the vhost in the type block. Class and modes may also
119       # be overridden
120       vhost="brain.netadmin.omega"
121
122       # type: What oper type this oline is. See the block above for list
123       # of types. NOTE: This is case-sensitive as well.
124       type="NetAdmin">
125
126 # oline with plain-text password and no comments..for all who like copy & paste
127 <oper
128       name="Brain"
129       password="s3cret"
130       host="yourident@dialup15.isp.com *@localhost *@example.com *@2001:db8::/32"
131       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
132       type="NetAdmin">
133
134 # oline with hashed password. It is highly recommended to use hashed passwords.
135 <oper
136       # name: oper login that is used to oper up (/oper name password).
137       # Remember: This is case sensitive
138       name="Brain"
139
140       # hash: what hash this password is hashed with.
141       # Requires the module for selected hash (m_md5.so, m_sha256.so
142       # or m_ripemd160.so) be loaded and the password hashing module
143       # (m_password_hash.so) loaded.
144       # Options here are: "md5", "sha256" and "ripemd160", or one of
145       # these prefixed with "hmac-", e.g.: "hmac-sha256".
146       # Create hashed password with: /mkpasswd <hash> <password>
147       hash="sha256"
148
149       # password: a hash of your password (see above option) hashed
150       # with /mkpasswd <hash> <password> . See m_password_hash in modules.conf
151       # for more information about password hashing.
152       password="1ec1c26b50d5d3c58d9583181af8076655fe00756bf7285940ba3670f99fcba0"
153
154       # host: What hostnames/IP's are allowed to oper up with this oline.
155       # Multiple options can be separated by spaces and CIDR's are allowed.
156       # You CAN use just * or *@* for this section, but it is not recommended
157       # for security reasons.
158       host="yourident@dialup15.isp.com *@localhost *@example.com *@2001:db8::/32"
159
160       # type: What oper type this oline is. See the block above for list
161       # of types. NOTE: This is case-sensitive as well.
162       type="NetAdmin">