-/* doc/reference.conf - charybdis Example configuration file
+/* doc/reference.conf - solanum example configuration file
*
* Copyright (C) 2000-2002 Hybrid Development Team
* Copyright (C) 2002-2005 ircd-ratbox development team
* .include "filename"
* .include <filename>
*
+ * Flags variables are comma-separated sets of predefined values,
+ * specific to each block. For example in operator {} blocks:
+ * flags = encrypted, encrypted;
+ *
* Times/durations are written as:
* 12 hours 30 minutes 1 second
*
* Channel mode +-T (blocks notices) -- chm_nonotice
* Channel mode +-O (oper only) -- chm_operonly
* Channel mode +-S (ssl only) -- chm_sslonly
- * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat
- * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat
- * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat
* Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace
* Restrict channel creation to logged in users -- createauthonly
* Account bans (+b $a[:mask]) -- extb_account
* Server bans (+b $s:mask) -- extb_server
* SSL bans (+b $z) -- extb_ssl
* User mode bans (+b $u:modes) -- extb_usermode
- * Helpops system (umode +H) -- helpops
+ * Helpops system (umode +h) -- helpops
* HURT system -- hurt
* New host mangling (umode +x) -- ip_cloaking_4.0
* Old host mangling (umode +h) -- ip_cloaking
* /locops support -- m_locops
* Opers cannot be invisible (umode +i) -- no_oper_invis
* Far connection notices (snomask +F) -- sno_farconnect
- * Remote k/d/x line active notices -- sno_globalkline
* Remote oper up notices -- sno_globaloper
* Global nick-change notices -- sno_globalnickchange
- * /whois notifications (snomask +W) -- sno_whois
* Oper-override (modehacking only) -- override
* Stop services kills -- no_kill_services
+ * Allows you to hide your idle time (umode +I) -- umode_hide_idle_time
*/
#loadmodule "extensions/chm_adminonly";
#loadmodule "extensions/chm_nonotice";
#loadmodule "extensions/chm_operonly";
#loadmodule "extensions/chm_sslonly";
-#loadmodule "extensions/chm_operonly_compat";
-#loadmodule "extensions/chm_quietunreg_compat";
-#loadmodule "extensions/chm_sslonly_compat";
#loadmodule "extensions/chm_operpeace";
#loadmodule "extensions/createauthonly";
#loadmodule "extensions/extb_account";
#loadmodule "extensions/m_locops";
#loadmodule "extensions/no_oper_invis";
#loadmodule "extensions/sno_farconnect";
-#loadmodule "extensions/sno_globalkline";
#loadmodule "extensions/sno_globalnickchange";
#loadmodule "extensions/sno_globaloper";
-#loadmodule "extensions/sno_whois";
#loadmodule "extensions/override";
#loadmodule "extensions/no_kill_services";
+#loadmodule "extensions/umode_hide_idle_time";
/* serverinfo {}: Contains information about the server. (OLD M:) */
serverinfo {
/* vhost6: the IP to bind to when we connect outward to ipv6 servers.
* This should be an ipv6 IP only.
*/
- #vhost6 = "2001:db7:2::6";
+ #vhost6 = "2001:db8:2::6";
/* ssl_cert: certificate (and optionally key) for our ssl server */
ssl_cert = "etc/ssl.pem";
ssl_dh_params = "etc/dh.pem";
/* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
- #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
+ #ssl_cipher_list = "TLS_CHACHA20_POLY1305_SHA256:EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
/* ssld_count: number of ssld processes you want to start, if you
* have a really busy server, using N-1 where N is the number of
*/
connectfreq = 5 minutes;
- /* max number: the amount of servers to autoconnect to. if the number
+ /* max_autoconn: the amount of servers to autoconnect to. if the number
* of servers in the class is or exceeds this, no more servers in the
* class are autoconnected. oper initiated connects are unaffected.
* this should usually be set to either 0 or 1. (autoconnecting from
* hubs to leaves may cause leaves to function as hubs by having
* multiple servers connected to them.)
*/
- max_number = 1;
+ max_autoconn = 1;
+
+ /* max_number: the maximum number of servers allowed in this class */
+ max_number = 100;
/* sendq: servers need a higher sendq as they are sent more data */
sendq = 2 megabytes;
/* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
port = 5000, 6665 .. 6669;
- /* sslport: listen for ssl connections on all available IPs, port 9999 */
- sslport = 9999;
+ /* sslport: listen for ssl connections on all available IPs, port 6697 */
+ sslport = 6697;
/* host: set a specific IP/host the ports after the line will listen
* on. This may be ipv4 or ipv6.
host = "2001:db8:2::6";
port = 7002;
sslport = 9002;
+
+ /* wsock: listeners defined with this option enabled will be websocket listeners,
+ * and will not accept normal clients.
+ */
+ wsock = yes;
+ sslport = 9999;
};
/* auth {}: allow users to connect to the ircd (OLD I:) */
auth {
+ /* description: descriptive text to help recognize this auth block in
+ * stats i output.
+ */
+ description = "example oper";
+
/* user: the user@host allowed to connect. Multiple IPv4/IPv6 user
* lines are permitted per auth block. This is matched against the
* hostname and IP address (using :: shortening for IPv6 and
* exceed_limit (old > flag) | allow user to exceed class user limits
* kline_exempt (old ^ flag) | exempt this user from k/g/xlines,
* | dnsbls, and proxies
- * dnsbl_exempt | exempt this user from dnsbls
+ * dnsbl_exempt | exempt this user from dnsbls
* proxy_exempt | exempt this user from proxies
- * spambot_exempt | exempt this user from spambot checks
- * shide_exempt | exempt this user from serverhiding
+ * spambot_exempt | exempt this user from spambot checks
+ * shide_exempt | exempt this user from serverhiding
* jupe_exempt | exempt this user from generating
* warnings joining juped channels
- * resv_exempt | exempt this user from resvs
+ * resv_exempt | exempt this user from resvs
* flood_exempt | exempt this user from flood limits
* USE WITH CAUTION.
* no_tilde (old - flag) | don't prefix ~ to username if no ident
* need_ssl | require SSL/TLS for user in this class
* need_sasl | require SASL id for user in this class
* extend_chans | allow this user to join more channels than normal
+ * kline_spoof_ip | if this block has a spoof host, klines match only
+ * | the spoof and not the underlying IP
*/
flags = kline_exempt, exceed_limit;
*
* Available options:
*
- * oper:local_kill: allows local users to be /KILL'd
- * oper:global_kill: allows local and remote users to be /KILL'd
+ * oper:general: enable most general oper privileges that came
+ * with +o in older releases
+ * auspex:oper: allows the oper to see through oper hiding
+ * auspex:umodes: allows viewing other users' modes
+ * auspex:cmodes: shows privileged cmodes
+ * auspex:hostname: shows hidden hostnames/ips
+ * oper:privs: allows /stats o/O and seeing privset in /whois
+ * oper:testline: allows /testline and /testgecos
+ * oper:kill: allows local and remote users to be /KILL'd
* oper:routing: allows remote SQUIT and CONNECT
* oper:kline: allows KLINE and DLINE
* oper:unkline: allows UNKLINE and UNDLINE
* may (un)load modules and see various
* additional information.
* oper:hidden_admin: gives admin privileges except
- * will not have the admin lines in
- * whois.
- * oper:xline: allows use of /quote xline/unxline
- * oper:resv: allows /quote resv/unresv and cmode +LP
+ * will not have the admin lines in
+ * whois.
+ * oper:xline: allows use of /quote xline/unxline
+ * oper:resv: allows /quote resv/unresv
+ * oper:cmodes: allows cmode +LP
* oper:operwall: allows the oper to send/receive operwalls
- * oper:spy: allows 'operspy' features to see through +s
- * channels etc. see /quote help operspy
+ * oper:spy: allows 'operspy' features to see through +s
+ * channels etc. see /quote help operspy
* oper:hidden: hides the oper from /stats p
* oper:remoteban: allows remote kline etc
- * oper:mass_notice: allows sending wallops and mass notices
- * oper:grant: allows using the GRANT command
- */
- privs = oper:local_kill, oper:operwall;
+ * oper:mass_notice: allows sending mass notices
+ * oper:wallops: allows sending wallops messages
+ * oper:grant: allows using the GRANT command
+ * usermode:servnotice: allows setting +s
+ * oper:message: allows opers to bypass CALLERID (usermode +g)
+ * oper:free_target: messages to the oper bypass flood controls
+ *
+ * Privileges provided by extensions include:
+ *
+ * oper:dehelper: allows the DEHELPER command (from extensions/helpops)
+ * oper:override: enables oper override via umode +p (from extensions/override)
+ * oper:receive_immunity:
+ * confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
+ * usermode:helpops allows setting +h (from extensions/helpops)
+ * auspex:usertimes:
+ * allows viewing user idle/connect times even when +I is set (from extensions/umode_hide_idle_time)
+ * oper:shedding: allows the SHEDDING command (from extensions/m_shedding)
+ */
+ privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, oper:message,
+ usermode:servnotice, auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
};
privset "server_bot" {
privset "global_op" {
extends = "local_op";
- privs = oper:global_kill, oper:routing, oper:kline, oper:unkline, oper:xline,
- oper:resv, oper:mass_notice, oper:remoteban;
+ privs = oper:routing, oper:kline, oper:unkline, oper:xline,
+ oper:resv, oper:cmodes, oper:mass_notice, oper:wallops,
+ oper:remoteban;
};
privset "admin" {
privset = "admin";
};
-/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
+/* connect {}: controls servers we connect with (OLD C:, N:, H:, L:).
+ *
+ * This configuration is used whether connections are incoming or
+ * outgoing.
+ */
connect "irc.uplink.com" {
- /* the name must go above */
+ /* the name of the other server must go above. It should match the
+ * other server's name in its serverinfo {} block, and does not
+ * need to be an actual hostname.
+ */
- /* host: the host or IP to connect to. If a hostname is used it
- * must match the reverse dns of the server.
+ /* host: the host or IP to connect to.
+ *
+ * It is also used to validate incoming connections. If a hostname
+ * is used, it must match the reverse dns of the server.
*/
host = "203.0.113.3";
send_password = "password";
accept_password = "anotherpassword";
- /* fingerprint: if specified, the server's client certificate
- * fingerprint will be checked against the specified fingerprint
- * below.
+ /* fingerprint: if flags = ssl is specified, the server's
+ * certificate fingerprint will be checked against the fingerprint
+ * specified below. required if using flags = ssl.
*/
#fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
/* port: the port to connect to this server on */
port = 6666;
- /* hub mask: the mask of servers that this server may hub. Multiple
- * entries are permitted
- */
- hub_mask = "*";
-
- /* leaf mask: the mask of servers this server may not hub. Multiple
- * entries are permitted. Useful for forbidding EU -> US -> EU routes.
- */
- #leaf_mask = "*.uk";
-
/* class: the class this server is in */
class = "server";
/* flags: controls special options for this server
- * encrypted - marks the accept_password as being crypt()'d
- * autoconn - automatically connect to this server
- * compressed - compress traffic via ziplinks
- * topicburst - burst topics between servers
- * ssl - ssl/tls encrypted server connections
+ * encrypted - marks the accept_password as being crypt()'d
+ * autoconn - automatically connect to this server
+ * topicburst - burst topics between servers
+ * ssl - ssl/tls encrypted server connections
+ * no-export - marks the link as a no-export link (not exported to other links)
*/
- flags = compressed, topicburst;
+ flags = topicburst;
};
connect "ipv6.lame.server" {
};
connect "ssl.uplink.com" {
- /* Example of ssl server-to-server connection, ssl flag doesn't need
- * compressed flag, 'cause it uses own compression
- */
host = "203.0.113.129";
send_password = "password";
accept_password = "anotherpassword";
port = 9999;
- hub_mask = "*";
class = "server";
flags = ssl, topicburst;
};
-/* cluster {}; servers that we propagate things to automatically.
- * NOTE: This does NOT grant them privileges to apply anything locally,
- * you must add a seperate shared block for that. Clustering will
- * only be done for actions by LOCAL opers, that arent directed
- * remotely.
- */
+/* cluster {}; servers that we propagate things to automatically. */
cluster {
/* name: the server to share with, this can be a wildcard and may be
* stacked.
/* service{}: privileged servers (services). These servers have extra
* privileges such as setting login names on users and introducing clients
- * with umode +S (unkickable, hide channels, etc). This does not allow them
- * to set bans, you need a separate shared{} for that.
+ * with umode +S (unkickable, hide channels, etc).
* Do not place normal servers here.
* There may be only one service{} block.
*/
name = "services.int";
};
-/* shared {}: users that are allowed to place remote bans on our server.
- * NOTE: These are ordered top down. The first one the user@host and server
- * matches will be used. Their access will then be decided on that
- * block and will not fall back to another block that matches.
- */
-shared {
- /* oper: the user@host and server the user must be on to set klines.
- * The first field must be a user@host, the second field is an
- * optional server. These may be stacked.
- */
- /* flags: list of what to allow them to place, all the oper lines
- * above this (up until another flags entry) will receive these
- * flags. This *must* be present.
- *
- * kline - allow setting perm/temp klines
- * tkline - allow setting temp klines
- * unkline - allow removing klines
- * xline - allow setting perm/temp xlines
- * txline - allow setting temp xlines
- * unxline - allow removing xlines
- * resv - allow setting perm/temp resvs
- * tresv - allow setting temp resvs
- * unresv - allow removing xlines
- * all - allow oper/server to do all of above.
- * locops - allow locops - only used for servers who cluster
- * rehash - allow rehashing
- * dline - allow setting perm/temp dlines
- * tdline - allow setting temp dlines
- * undline - allow removing dlines
- * grant - allow granting operator status
- * die - allow remote DIE/RESTART
- * module - allow remote module commands
- * none - disallow everything
- */
-
- /* allow flame@*.leeh.co.uk on server irc.ircd-ratbox.org and
- * allow leeh@*.leeh.co.uk on server ircd.ircd-ratbox.org to kline
- */
- oper = "flame@*.leeh.co.uk", "irc.ircd-ratbox.org";
- oper = "leeh@*.leeh.co.uk", "ircd.ircd-ratbox.org";
- flags = kline;
-
- /* you may forbid certain opers/servers from doing anything */
- oper = "irc@vanity.oper", "*";
- oper = "*@*", "irc.vanity.server";
- oper = "irc@another.vanity.oper", "bigger.vanity.server";
- flags = none;
-
- /* or allow everyone to place temp klines */
- oper = "*@*";
- flags = tkline;
-};
-
/* exempt {}: IPs that are exempt from Dlines and rejectcache. (OLD d:) */
exempt {
ip = "192.0.2.0/24";
ip = "127.0.0.1";
};
+/* secure {}: IPs that are considered to be secure networks, and get
+ * +Z without using TLS */
+secure {
+ ip = "127.0.0.1";
+};
+
/* The channel block contains options pertaining to channels */
channel {
/* invex: Enable/disable channel mode +I, a n!u@h list of masks
/* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
strip_topic_colors = no;
+
+ /* opmod_send_statusmsg: format messages sent to ops due to +z
+ * as PRIVMSG @#channel when sent to clients.
+ */
+ opmod_send_statusmsg = no;
+
+ /* ip_bans_through_vhost: should channel IP bans see through dynamic spoofed hosts? */
+ ip_bans_through_vhost = yes;
};
* WARNING:
* These settings are considered experimental. Only the most common proxy types
* are checked for (Charybdis is immune from POST and GET proxies). If you are
- * not comfortable with experimental code, remove or comment out the *entire*
- * block below to disable the proxy scanner.
+ * not comfortable with experimental code, do not use this feature.
*/
-opm {
+#opm {
/* IPv4 address to listen on. This must be a publicly facing IP address
* to be effective.
* If omitted, it defaults to serverinfo::vhost.
/* IPv4 port to listen on.
* This should not be the same as any existing listeners.
*/
- #port_ipv4 = 32000;
+ #port_v4 = 32000;
/* IPv6 address to listen on. This must be a publicly facing IP address
* to be effective.
/* IPv6 port to listen on.
* This should not be the same as any existing listeners.
*/
- #port_ipv6 = 32000;
+ #port_v6 = 32000;
/* You can also set the listen_port directive which will set both the
* IPv4 and IPv6 ports at once.
*/
- listen_port = 32000;
+ #listen_port = 32000;
/* This sets the timeout in seconds before ending open proxy scans.
* Values less than 1 or greater than 60 are ignored.
* It is advisable to keep it as short as feasible, so clients do not
* get held up by excessively long scan times.
*/
- timeout = 5;
+ #timeout = 5;
/* These are the ports to scan for SOCKS4 proxies on. They may overlap
* with other scan types. Sensible defaults are given below.
*/
- socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
+ #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
/* These are the ports to scan for SOCKS5 proxies on. They may overlap
* with other scan types. Sensible defaults are given below.
*/
- socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
+ #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
/* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
* They may overlap with other scan types. Sensible defaults are given
* below.
*/
- httpconnect_ports = 80, 8080, 8000;
+ #httpconnect_ports = 80, 8080, 8000;
/* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
* They may overlap with other scan types. Sensible defaults are given
* below.
*/
- httpsconnect_ports = 443, 4443;
-};
+ #httpsconnect_ports = 443, 4443;
+#};
/*
* Alias blocks allow you to define custom commands. (Old m_sshortcut.c)
*/
dline_with_reason = yes;
- /* kline delay: delay the checking of klines until a specified time.
- * Useful if large kline lists are applied often to prevent the
- * server eating CPU.
- */
- kline_delay = 0 seconds;
-
/* kline reason: show the user the reason why they are k/dlined
* on exit. may give away who set k/dline when set via tcm.
*/
kline_with_reason = yes;
+ /* tkline duration: when showing users their k/dline reason (see
+ * kline_with_reason), don't add "Temporary K-line 123 min."
+ */
+ hide_tkdline_duration = no;
+
/* kline reason: make the users quit message on channels this
* reason instead of the oper's reason.
*/
kline_reason = "Connection closed";
+ /* SASL access only client message: give users a message that
+ * informs them
+ */
+ sasl_only_client_message = "You need to identify via SASL to use this server.";
+
+ /* Identd access only client message: give users a message that
+ * informs them
+ */
+ identd_only_client_message = "You need to install identd to use this server.";
+
+ /* SCTP forbidden client message: give users a message that
+ * informs them
+ */
+ sctp_forbidden_client_message = "You are not allowed to use SCTP on this server.";
+
+ /* SSL/TLS access only client message: give users a message that
+ * informs them
+ */
+ ssltls_only_client_message = "You need to use SSL/TLS to use this server.";
+
+ /* Not authorised client message: tell users that they are not
+ * authorised
+ */
+ not_authorised_client_message = "You are not authorised to access this server.";
+
+ /* Illegal hostname client message: tell users that they have illegal
+ * chars in their hostname
+ */
+ illegal_hostname_client_message = "You have an illegal character in your hostname.";
+
+ /* Server full client message: tell users that the server they're connecting
+ * to is full
+ */
+ server_full_client_message = "Sorry, server is full - try later";
+
+ /* illegal name long client message: long-form explanation that their username
+ * contains illegal characters
+ */
+ illegal_name_long_client_message = "Your username is invalid. Please make sure that your username contains only alphanumeric characters.";
+
+ /* illegal name short client message: short-form notification that their username
+ * contains illegal characters; will be followed by ": their_username"
+ */
+ illegal_name_short_client_message = "Invalid username";
+
/* identify to services via server password
* if auth{} block had no password but the user specified a
* server password anyway, send a PRIVMSG to <identify_service>
/* stats c oper only: make stats c (connect {}) oper only */
stats_c_oper_only = no;
- /* stats h oper only: make stats h (hub_mask/leaf_mask) oper only */
- stats_h_oper_only = no;
-
/* stats y oper only: make stats y (class {}) oper only */
stats_y_oper_only = no;
*/
stats_k_oper_only = masked;
+ /* stats l/L oper only:
+ * yes: non-opers can't use this at all
+ * self: non-opers see only themselves
+ * no: show targeted users or non-hidden opers to everyone
+ */
+ stats_l_oper_only = self;
+
/* map oper only: make /map oper only */
map_oper_only = no;
*/
ping_cookie = no;
+ /* ping warn time: how long to wait after pinging a server before starting
+ * to complain it is unresponsive. Note that the ping check interval is 30
+ * seconds, so the first complaint will come at the next check after this
+ * time has passed.
+ */
+ ping_warn_time = 15 seconds;
+
/* connect timeout: sets how long we should wait for a connection
* request to succeed
*/
*/
max_targets = 4;
+ /* post-registration delay: wait this long before processing commands from a newly
+ * registered user. Used to allow network utility bots to perform any actions
+ * (such as host changes or proxy scanning) before the user can join channels.
+ */
+ post_registration_delay = 2 seconds;
+
/* use_whois_actually: send clients requesting a whois a numeric
* giving the real IP of non-spoofed clients to prevent DNS abuse.
*/
/* usermodes configurable: a list of usermodes for the options below
*
- * +g - callerid - Server Side Ignore
+ * +g - callerid - Server-side private message allow list
* +D - deaf - Don't see channel messages
* +i - invisible - Not shown in NAMES or WHO unless you share a
* a channel
* provided they have umode +s set */
oper_snomask = "+s";
- /* compression level: level of compression for compressed links between
- * servers.
- *
- * values are between: 1 (least compression, fastest)
- * and: 9 (most compression, slowest).
- */
- #compression_level = 6;
-
/* burst_away: This enables bursting away messages to servers.
* With this disabled, we will only propogate AWAY messages
* as users send them, but never burst them. Be warned though
* The spki_* variants operate on the SubjectPublicKeyInfo of the certificate, which does
* not change unless the private key is changed. This allows the fingerprint to stay
* constant even if the certificate is reissued. These fingerprints will be prefixed with
- * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type.
+ * "SPKI:SHA2-256:" or "SPKI:SHA2-512:" depending on the hash type. These fingerprints
+ * are not supported on servers running charybdis 3.5.3 or earlier.
+ *
+ * To generate a fingerprint from a certificate file, please use the mkfingerprint utility
+ * program located in the bin/ subdirectory of your IRCd installation. Running it with no
+ * arguments will give you a brief usage message; it takes method and filename arguments.
*/
certfp_method = spki_sha256;
/* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
hide_opers_in_whois = no;
+
+ /* hide_opers: Hide all opers from unprivileged users */
+ hide_opers = no;
+
+ /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
+ tls_ciphers_oper_only = no;
+
+ /* hidden_caps: client capabilities we'll pretend we don't support until they're requested */
+ #hidden_caps = "userhost-in-names";
+
+ /* oper_secure_only: require TLS on any connection trying to oper up */
+ oper_secure_only = no;
+
+ /* drain_reason: Message shown to users when they are rejected from a draining server.
+ * requires extensions/drain to be loaded.
+ */
+ drain_reason = "This server is not accepting connections.";
};
modules {
projects / solanum.git / blobdiff