You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

conventional.yaml 36KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908
  1. # This is the "conventional" or "mainstream" config file for Oragono.
  2. # It tries to replicate the behavior of other ircds, at the cost of not
  3. # taking full advantage of Oragono's features. This config is suitable for use
  4. # in IRCv3 conformance testing.
  5. # network configuration
  6. network:
  7. # name of the network
  8. name: OragonoTest
  9. # server configuration
  10. server:
  11. # server name
  12. name: oragono.test
  13. # addresses to listen on
  14. listeners:
  15. # This version of the config provides a public plaintext listener on
  16. # port 6667 for testing and compatibility with legacy applications.
  17. # We recommend disabling this listener in a production setting
  18. # and replacing it with loopback-only listeners (see default.yaml):
  19. ":6667":
  20. # The standard SSL/TLS port for IRC is 6697. This will listen on all interfaces:
  21. ":6697":
  22. tls:
  23. cert: fullchain.pem
  24. key: privkey.pem
  25. # 'proxy' should typically be false. It's only for Kubernetes-style load
  26. # balancing that does not terminate TLS, but sends an initial PROXY line
  27. # in plaintext.
  28. proxy: false
  29. # Example of a Unix domain socket for proxying:
  30. # "/tmp/oragono_sock":
  31. # Example of a Tor listener: any connection that comes in on this listener will
  32. # be considered a Tor connection. It is strongly recommended that this listener
  33. # *not* be on a public interface --- it should be on 127.0.0.0/8 or unix domain:
  34. # "/hidden_service_sockets/oragono_tor_sock":
  35. # tor: true
  36. # Example of a WebSocket listener:
  37. # ":8097":
  38. # websocket: true
  39. # tls:
  40. # cert: fullchain.pem
  41. # key: privkey.pem
  42. # sets the permissions for Unix listen sockets. on a typical Linux system,
  43. # the default is 0775 or 0755, which prevents other users/groups from connecting
  44. # to the socket. With 0777, it behaves like a normal TCP socket
  45. # where anyone can connect.
  46. unix-bind-mode: 0777
  47. # configure the behavior of Tor listeners (ignored if you didn't enable any):
  48. tor-listeners:
  49. # if this is true, connections from Tor must authenticate with SASL
  50. require-sasl: false
  51. # what hostname should be displayed for Tor connections?
  52. vhost: "tor-network.onion"
  53. # allow at most this many connections at once (0 for no limit):
  54. max-connections: 64
  55. # connection throttling (limit how many connection attempts are allowed at once):
  56. throttle-duration: 10m
  57. # set to 0 to disable throttling:
  58. max-connections-per-duration: 64
  59. # strict transport security, to get clients to automagically use TLS
  60. sts:
  61. # whether to advertise STS
  62. #
  63. # to stop advertising STS, leave this enabled and set 'duration' below to "0". this will
  64. # advertise to connecting users that the STS policy they have saved is no longer valid
  65. enabled: false
  66. # how long clients should be forced to use TLS for.
  67. # setting this to a too-long time will mean bad things if you later remove your TLS.
  68. # the default duration below is 1 month, 2 days and 5 minutes.
  69. duration: 1mo2d5m
  70. # tls port - you should be listening on this port above
  71. port: 6697
  72. # should clients include this STS policy when they ship their inbuilt preload lists?
  73. preload: false
  74. websockets:
  75. # Restrict the origin of WebSocket connections by matching the "Origin" HTTP
  76. # header. This settings makes oragono reject every WebSocket connection,
  77. # except when it originates from one of the hosts in this list. Use this to
  78. # prevent malicious websites from making their visitors connect to oragono
  79. # without their knowledge. An empty list means that there are no restrictions.
  80. allowed-origins:
  81. # - "https://oragono.io"
  82. # - "https://*.oragono.io"
  83. # casemapping controls what kinds of strings are permitted as identifiers (nicknames,
  84. # channel names, account names, etc.), and how they are normalized for case.
  85. # with the recommended default of 'precis', UTF8 identifiers that are "sane"
  86. # (according to RFC 8265) are allowed, and the server additionally tries to protect
  87. # against confusable characters ("homoglyph attacks").
  88. # the other options are 'ascii' (traditional ASCII-only identifiers), and 'permissive',
  89. # which allows identifiers to contain unusual characters like emoji, but makes users
  90. # vulnerable to homoglyph attacks. unless you're really confident in your decision,
  91. # we recommend leaving this value at its default (changing it once the network is
  92. # already up and running is problematic).
  93. casemapping: "precis"
  94. # enforce-utf8 controls whether the server allows non-UTF8 bytes in messages
  95. # (as in traditional IRC) or preemptively discards non-UTF8 messages (since
  96. # they cannot be relayed to websocket clients).
  97. enforce-utf8: true
  98. # whether to look up user hostnames with reverse DNS.
  99. # (disabling this will expose user IPs instead of hostnames;
  100. # to make IP/hostname information private, see the ip-cloaking section)
  101. lookup-hostnames: true
  102. # whether to confirm hostname lookups using "forward-confirmed reverse DNS", i.e., for
  103. # any hostname returned from reverse DNS, resolve it back to an IP address and reject it
  104. # unless it matches the connecting IP
  105. forward-confirm-hostnames: true
  106. # use ident protocol to get usernames
  107. check-ident: true
  108. # ignore the supplied user/ident string from the USER command; always set the value to
  109. # `~user` (literally) instead. this can potentially reduce confusion and simplify bans.
  110. suppress-ident: false
  111. # password to login to the server
  112. # generated using "oragono genpasswd"
  113. #password: ""
  114. # motd filename
  115. # if you change the motd, you should move it to ircd.motd
  116. motd: oragono.motd
  117. # motd formatting codes
  118. # if this is true, the motd is escaped using formatting codes like $c, $b, and $i
  119. motd-formatting: true
  120. # relaying using the RELAYMSG command
  121. relaymsg:
  122. # is relaymsg enabled at all?
  123. enabled: true
  124. # which character(s) are reserved for relayed nicks?
  125. separators: "/"
  126. # can channel operators use RELAYMSG in their channels?
  127. # our implementation of RELAYMSG makes it safe for chanops to use without the
  128. # possibility of real users being silently spoofed
  129. available-to-chanops: true
  130. # addresses/CIDRs the PROXY command can be used from
  131. # this should be restricted to localhost (127.0.0.1/8, ::1/128, and unix sockets),
  132. # unless you have a good reason. you should also add these addresses to the
  133. # connection limits and throttling exemption lists.
  134. proxy-allowed-from:
  135. - localhost
  136. # - "192.168.1.1"
  137. # - "192.168.10.1/24"
  138. # controls the use of the WEBIRC command (by IRC<->web interfaces, bouncers and similar)
  139. webirc:
  140. # one webirc block -- should correspond to one set of gateways
  141. -
  142. # SHA-256 fingerprint of the TLS certificate the gateway must use to connect
  143. # (comment this out to use passwords only)
  144. certfp: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
  145. # password the gateway uses to connect, made with oragono genpasswd
  146. password: "$2a$04$abcdef0123456789abcdef0123456789abcdef0123456789abcde"
  147. # addresses/CIDRs that can use this webirc command
  148. # you should also add these addresses to the connection limits and throttling exemption lists
  149. hosts:
  150. - localhost
  151. # - "192.168.1.1"
  152. # - "192.168.10.1/24"
  153. # allow use of the RESUME extension over plaintext connections:
  154. # do not enable this unless the ircd is only accessible over internal networks
  155. allow-plaintext-resume: false
  156. # maximum length of clients' sendQ in bytes
  157. # this should be big enough to hold bursts of channel/direct messages
  158. max-sendq: 96k
  159. # compatibility with legacy clients
  160. compatibility:
  161. # many clients require that the final parameter of certain messages be an
  162. # RFC1459 trailing parameter, i.e., prefixed with :, whether or not this is
  163. # actually required. this forces Oragono to send those parameters
  164. # as trailings. this is recommended unless you're testing clients for conformance;
  165. # defaults to true when unset for that reason.
  166. force-trailing: true
  167. # some clients (ZNC 1.6.x and lower, Pidgin 2.12 and lower) do not
  168. # respond correctly to SASL messages with the server name as a prefix:
  169. # https://github.com/znc/znc/issues/1212
  170. # this works around that bug, allowing them to use SASL.
  171. send-unprefixed-sasl: true
  172. # IP-based DoS protection
  173. ip-limits:
  174. # whether to limit the total number of concurrent connections per IP/CIDR
  175. count: true
  176. # maximum concurrent connections per IP/CIDR
  177. max-concurrent-connections: 16
  178. # whether to restrict the rate of new connections per IP/CIDR
  179. throttle: true
  180. # how long to keep track of connections for
  181. window: 10m
  182. # maximum number of new connections per IP/CIDR within the given duration
  183. max-connections-per-window: 32
  184. # how long to ban offenders for. after banning them, the number of connections is
  185. # reset, which lets you use /UNDLINE to unban people
  186. throttle-ban-duration: 10m
  187. # how wide the CIDR should be for IPv4 (a /32 is a fully specified IPv4 address)
  188. cidr-len-ipv4: 32
  189. # how wide the CIDR should be for IPv6 (a /64 is the typical prefix assigned
  190. # by an ISP to an individual customer for their LAN)
  191. cidr-len-ipv6: 64
  192. # IPs/networks which are exempted from connection limits
  193. exempted:
  194. - "localhost"
  195. # - "192.168.1.1"
  196. # - "2001:0db8::/32"
  197. # custom connection limits for certain IPs/networks. note that CIDR
  198. # widths defined here override the default CIDR width --- the limit
  199. # will apply to the entire CIDR no matter how large or small it is
  200. custom-limits:
  201. # "8.8.0.0/16":
  202. # max-concurrent-connections: 128
  203. # max-connections-per-window: 1024
  204. # pluggable IP ban mechanism, via subprocess invocation
  205. # this can be used to check new connections against a DNSBL, for example
  206. # see the manual for details on how to write an IP ban checking script
  207. ip-check-script:
  208. enabled: false
  209. command: "/usr/local/bin/check-ip-ban"
  210. # constant list of args to pass to the command; the actual query
  211. # and result are transmitted over stdin/stdout:
  212. args: []
  213. # timeout for process execution, after which we send a SIGTERM:
  214. timeout: 9s
  215. # how long after the SIGTERM before we follow up with a SIGKILL:
  216. kill-timeout: 1s
  217. # how many scripts are allowed to run at once? 0 for no limit:
  218. max-concurrency: 64
  219. # IP cloaking hides users' IP addresses from other users and from channel admins
  220. # (but not from server admins), while still allowing channel admins to ban
  221. # offending IP addresses or networks. In place of hostnames derived from reverse
  222. # DNS, users see fake domain names like pwbs2ui4377257x8.oragono. These names are
  223. # generated deterministically from the underlying IP address, but if the underlying
  224. # IP is not already known, it is infeasible to recover it from the cloaked name.
  225. ip-cloaking:
  226. # whether to enable IP cloaking
  227. enabled: false
  228. # whether to use these cloak settings (specifically, `netname` and `num-bits`)
  229. # to produce unique hostnames for always-on clients. you can enable this even if
  230. # you disabled IP cloaking for normal clients above. if this is disabled,
  231. # always-on clients will all have an identical hostname (the server name).
  232. enabled-for-always-on: true
  233. # fake TLD at the end of the hostname, e.g., pwbs2ui4377257x8.irc
  234. # you may want to use your network name here
  235. netname: "irc"
  236. # the cloaked hostname is derived only from the CIDR (most significant bits
  237. # of the IP address), up to a configurable number of bits. this is the
  238. # granularity at which bans will take effect for IPv4. Note that changing
  239. # this value will invalidate any stored bans.
  240. cidr-len-ipv4: 32
  241. # analogous granularity for IPv6
  242. cidr-len-ipv6: 64
  243. # number of bits of hash output to include in the cloaked hostname.
  244. # more bits means less likelihood of distinct IPs colliding,
  245. # at the cost of a longer cloaked hostname. if this value is set to 0,
  246. # all users will receive simply `netname` as their cloaked hostname.
  247. num-bits: 64
  248. # secure-nets identifies IPs and CIDRs which are secure at layer 3,
  249. # for example, because they are on a trusted internal LAN or a VPN.
  250. # plaintext connections from these IPs and CIDRs will be considered
  251. # secure (clients will receive the +Z mode and be allowed to resume
  252. # or reattach to secure connections). note that loopback IPs are always
  253. # considered secure:
  254. secure-nets:
  255. # - "10.0.0.0/8"
  256. # oragono will write files to disk under certain circumstances, e.g.,
  257. # CPU profiling or data export. by default, these files will be written
  258. # to the working directory. set this to customize:
  259. # output-path: "/home/oragono/out"
  260. # account options
  261. accounts:
  262. # is account authentication enabled, i.e., can users log into existing accounts?
  263. authentication-enabled: true
  264. # account registration
  265. registration:
  266. # can users register new accounts for themselves? if this is false, operators with
  267. # the `accreg` capability can still create accounts with `/NICKSERV SAREGISTER`
  268. enabled: true
  269. # can users use the REGISTER command to register before fully connecting?
  270. allow-before-connect: true
  271. # global throttle on new account creation
  272. throttling:
  273. enabled: true
  274. # window
  275. duration: 10m
  276. # number of attempts allowed within the window
  277. max-attempts: 30
  278. # this is the bcrypt cost we'll use for account passwords
  279. bcrypt-cost: 9
  280. # length of time a user has to verify their account before it can be re-registered
  281. verify-timeout: "32h"
  282. # options for email verification of account registrations
  283. email-verification:
  284. enabled: false
  285. sender: "admin@my.network"
  286. require-tls: true
  287. helo-domain: "my.network" # defaults to server name if unset
  288. # options to enable DKIM signing of outgoing emails (recommended, but
  289. # requires creating a DNS entry for the public key):
  290. # dkim:
  291. # domain: "my.network"
  292. # selector: "20200229"
  293. # key-file: "dkim.pem"
  294. # to use an MTA/smarthost instead of sending email directly:
  295. # mta:
  296. # server: localhost
  297. # port: 25
  298. # username: "admin"
  299. # password: "hunter2"
  300. blacklist-regexes:
  301. # - ".*@mailinator.com"
  302. # throttle account login attempts (to prevent either password guessing, or DoS
  303. # attacks on the server aimed at forcing repeated expensive bcrypt computations)
  304. login-throttling:
  305. enabled: true
  306. # window
  307. duration: 1m
  308. # number of attempts allowed within the window
  309. max-attempts: 3
  310. # some clients (notably Pidgin and Hexchat) offer only a single password field,
  311. # which makes it impossible to specify a separate server password (for the PASS
  312. # command) and SASL password. if this option is set to true, a client that
  313. # successfully authenticates with SASL will not be required to send
  314. # PASS as well, so it can be configured to authenticate with SASL only.
  315. skip-server-password: false
  316. # enable login to accounts via the PASS command, e.g., PASS account:password
  317. # this is useful for compatibility with old clients that don't support SASL
  318. login-via-pass-command: false
  319. # require-sasl controls whether clients are required to have accounts
  320. # (and sign into them using SASL) to connect to the server
  321. require-sasl:
  322. # if this is enabled, all clients must authenticate with SASL while connecting
  323. enabled: false
  324. # IPs/CIDRs which are exempted from the account requirement
  325. exempted:
  326. - "localhost"
  327. # - '10.10.0.0/16'
  328. # nick-reservation controls how, and whether, nicknames are linked to accounts
  329. nick-reservation:
  330. # is there any enforcement of reserved nicknames?
  331. enabled: true
  332. # how many nicknames, in addition to the account name, can be reserved?
  333. additional-nick-limit: 2
  334. # method describes how nickname reservation is handled
  335. # strict: don't let the user change to the registered nickname unless they're
  336. # already logged-in using SASL or NickServ
  337. # optional: no enforcement by default, but allow users to opt in to
  338. # the enforcement level of their choice
  339. #
  340. # 'optional' matches the behavior of other NickServs, but 'strict' is
  341. # preferable if all your users can enable SASL.
  342. method: optional
  343. # allow users to set their own nickname enforcement status, e.g.,
  344. # to opt out of strict enforcement
  345. allow-custom-enforcement: true
  346. # format for guest nicknames:
  347. # 1. these nicknames cannot be registered or reserved
  348. # 2. if a client is automatically renamed by the server,
  349. # this is the template that will be used (e.g., Guest-nccj6rgmt97cg)
  350. # 3. if enforce-guest-format (see below) is enabled, clients without
  351. # a registered account will have this template applied to their
  352. # nicknames (e.g., 'katie' will become 'Guest-katie')
  353. guest-nickname-format: "Guest-*"
  354. # when enabled, forces users not logged into an account to use
  355. # a nickname matching the guest template. a caveat: this may prevent
  356. # users from choosing nicknames in scripts different from the guest
  357. # nickname format.
  358. force-guest-format: false
  359. # when enabled, forces users logged into an account to use the
  360. # account name as their nickname. when combined with strict nickname
  361. # enforcement, this lets users treat nicknames and account names
  362. # as equivalent for the purpose of ban/invite/exception lists.
  363. force-nick-equals-account: false
  364. # multiclient controls whether oragono allows multiple connections to
  365. # attach to the same client/nickname identity; this is part of the
  366. # functionality traditionally provided by a bouncer like ZNC
  367. multiclient:
  368. # when disabled, each connection must use a separate nickname (as is the
  369. # typical behavior of IRC servers). when enabled, a new connection that
  370. # has authenticated with SASL can associate itself with an existing
  371. # client
  372. enabled: true
  373. # if this is disabled, clients have to opt in to bouncer functionality
  374. # using nickserv or the cap system. if it's enabled, they can opt out
  375. # via nickserv
  376. allowed-by-default: false
  377. # whether to allow clients that remain on the server even
  378. # when they have no active connections. The possible values are:
  379. # "disabled", "opt-in", "opt-out", or "mandatory".
  380. always-on: "disabled"
  381. # whether to mark always-on clients away when they have no active connections:
  382. auto-away: "opt-in"
  383. # vhosts controls the assignment of vhosts (strings displayed in place of the user's
  384. # hostname/IP) by the HostServ service
  385. vhosts:
  386. # are vhosts enabled at all?
  387. enabled: true
  388. # maximum length of a vhost
  389. max-length: 64
  390. # regexp for testing the validity of a vhost
  391. # (make sure any changes you make here are RFC-compliant)
  392. valid-regexp: '^[0-9A-Za-z.\-_/]+$'
  393. # options controlling users requesting vhosts:
  394. user-requests:
  395. # can users request vhosts at all? if this is false, operators with the
  396. # 'vhosts' capability can still assign vhosts manually
  397. enabled: false
  398. # if uncommented, all new vhost requests will be dumped into the given
  399. # channel, so opers can review them as they are sent in. ensure that you
  400. # have registered and restricted the channel appropriately before you
  401. # uncomment this.
  402. #channel: "#vhosts"
  403. # after a user's vhost has been approved or rejected, they need to wait
  404. # this long (starting from the time of their original request)
  405. # before they can request a new one.
  406. cooldown: 168h
  407. # modes that are set by default when a user connects
  408. # if unset, no user modes will be set by default
  409. # +i is invisible (a user's channels are hidden from whois replies)
  410. # see /QUOTE HELP umodes for more user modes
  411. # default-user-modes: +i
  412. # pluggable authentication mechanism, via subprocess invocation
  413. # see the manual for details on how to write an authentication plugin script
  414. auth-script:
  415. enabled: false
  416. command: "/usr/local/bin/authenticate-irc-user"
  417. # constant list of args to pass to the command; the actual authentication
  418. # data is transmitted over stdin/stdout:
  419. args: []
  420. # should we automatically create users if the plugin returns success?
  421. autocreate: true
  422. # timeout for process execution, after which we send a SIGTERM:
  423. timeout: 9s
  424. # how long after the SIGTERM before we follow up with a SIGKILL:
  425. kill-timeout: 1s
  426. # how many scripts are allowed to run at once? 0 for no limit:
  427. max-concurrency: 64
  428. # channel options
  429. channels:
  430. # modes that are set when new channels are created
  431. # +n is no-external-messages and +t is op-only-topic
  432. # see /QUOTE HELP cmodes for more channel modes
  433. default-modes: +nt
  434. # how many channels can a client be in at once?
  435. max-channels-per-client: 100
  436. # if this is true, new channels can only be created by operators with the
  437. # `chanreg` operator capability
  438. operator-only-creation: false
  439. # channel registration - requires an account
  440. registration:
  441. # can users register new channels?
  442. enabled: true
  443. # restrict new channel registrations to operators only?
  444. # (operators can then transfer channels to regular users using /CS TRANSFER)
  445. operator-only: false
  446. # how many channels can each account register?
  447. max-channels-per-account: 15
  448. # as a crude countermeasure against spambots, anonymous connections younger
  449. # than this value will get an empty response to /LIST (a time period of 0 disables)
  450. list-delay: 0s
  451. # operator classes
  452. oper-classes:
  453. # local operator
  454. "local-oper":
  455. # title shown in WHOIS
  456. title: Local Operator
  457. # capability names
  458. capabilities:
  459. - "local_kill"
  460. - "local_ban"
  461. - "local_unban"
  462. - "nofakelag"
  463. - "roleplay"
  464. - "relaymsg"
  465. # network operator
  466. "network-oper":
  467. # title shown in WHOIS
  468. title: Network Operator
  469. # oper class this extends from
  470. extends: "local-oper"
  471. # capability names
  472. capabilities:
  473. - "remote_kill"
  474. - "remote_ban"
  475. - "remote_unban"
  476. # server admin
  477. "server-admin":
  478. # title shown in WHOIS
  479. title: Server Admin
  480. # oper class this extends from
  481. extends: "local-oper"
  482. # capability names
  483. capabilities:
  484. - "rehash"
  485. - "die"
  486. - "accreg"
  487. - "sajoin"
  488. - "samode"
  489. - "vhosts"
  490. - "chanreg"
  491. - "history"
  492. - "defcon"
  493. # ircd operators
  494. opers:
  495. # operator named 'admin'; log in with /OPER admin [password]
  496. admin:
  497. # which capabilities this oper has access to
  498. class: "server-admin"
  499. # custom whois line
  500. whois-line: is a server admin
  501. # custom hostname
  502. vhost: "staff"
  503. # normally, operator status is visible to unprivileged users in WHO and WHOIS
  504. # responses. this can be disabled with 'hidden'. ('hidden' also causes the
  505. # 'vhost' line above to be ignored.)
  506. hidden: false
  507. # modes are modes to auto-set upon opering-up. uncomment this to automatically
  508. # enable snomasks ("server notification masks" that alert you to server events;
  509. # see `/quote help snomasks` while opered-up for more information):
  510. #modes: +is acjknoqtuxv
  511. # operators can be authenticated either by password (with the /OPER command),
  512. # or by certificate fingerprint, or both. if a password hash is set, then a
  513. # password is required to oper up (e.g., /OPER dan mypassword). to generate
  514. # the hash, use `oragono genpasswd`.
  515. password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
  516. # if a SHA-256 certificate fingerprint is configured here, then it will be
  517. # required to /OPER. if you comment out the password hash above, then you can
  518. # /OPER without a password.
  519. #certfp: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
  520. # if 'auto' is set (and no password hash is set), operator permissions will be
  521. # granted automatically as soon as you connect with the right fingerprint.
  522. #auto: true
  523. # logging, takes inspiration from Insp
  524. logging:
  525. -
  526. # how to log these messages
  527. #
  528. # file log to a file
  529. # stdout log to stdout
  530. # stderr log to stderr
  531. # (you can specify multiple methods, e.g., to log to both stderr and a file)
  532. method: stderr
  533. # filename to log to, if file method is selected
  534. # filename: ircd.log
  535. # type(s) of logs to keep here. you can use - to exclude those types
  536. #
  537. # exclusions take precedent over inclusions, so if you exclude a type it will NEVER
  538. # be logged, even if you explicitly include it
  539. #
  540. # useful types include:
  541. # * everything (usually used with exclusing some types below)
  542. # server server startup, rehash, and shutdown events
  543. # accounts account registration and authentication
  544. # channels channel creation and operations
  545. # commands command calling and operations
  546. # opers oper actions, authentication, etc
  547. # services actions related to NickServ, ChanServ, etc.
  548. # internal unexpected runtime behavior, including potential bugs
  549. # userinput raw lines sent by users
  550. # useroutput raw lines sent to users
  551. type: "* -userinput -useroutput"
  552. # one of: debug info warn error
  553. level: info
  554. #-
  555. # # example of a file log that avoids logging IP addresses
  556. # method: file
  557. # filename: ircd.log
  558. # type: "* -userinput -useroutput -connect-ip"
  559. # level: debug
  560. # debug options
  561. debug:
  562. # when enabled, oragono will attempt to recover from certain kinds of
  563. # client-triggered runtime errors that would normally crash the server.
  564. # this makes the server more resilient to DoS, but could result in incorrect
  565. # behavior. deployments that would prefer to "start from scratch", e.g., by
  566. # letting the process crash and auto-restarting it with systemd, can set
  567. # this to false.
  568. recover-from-errors: true
  569. # optionally expose a pprof http endpoint: https://golang.org/pkg/net/http/pprof/
  570. # it is strongly recommended that you don't expose this on a public interface;
  571. # if you need to access it remotely, you can use an SSH tunnel.
  572. # set to `null`, "", leave blank, or omit to disable
  573. # pprof-listener: "localhost:6060"
  574. # datastore configuration
  575. datastore:
  576. # path to the datastore
  577. path: ircd.db
  578. # if the database schema requires an upgrade, `autoupgrade` will attempt to
  579. # perform it automatically on startup. the database will be backed
  580. # up, and if the upgrade fails, the original database will be restored.
  581. autoupgrade: true
  582. # connection information for MySQL (currently only used for persistent history):
  583. mysql:
  584. enabled: false
  585. host: "localhost"
  586. port: 3306
  587. # if socket-path is set, it will be used instead of host:port
  588. #socket-path: "/var/run/mysqld/mysqld.sock"
  589. user: "oragono"
  590. password: "hunter2"
  591. history-database: "oragono_history"
  592. timeout: 3s
  593. # languages config
  594. languages:
  595. # whether to load languages
  596. enabled: true
  597. # default language to use for new clients
  598. # 'en' is the default English language in the code
  599. default: en
  600. # which directory contains our language files
  601. path: languages
  602. # limits - these need to be the same across the network
  603. limits:
  604. # nicklen is the max nick length allowed
  605. nicklen: 32
  606. # identlen is the max ident length allowed
  607. identlen: 20
  608. # channellen is the max channel length allowed
  609. channellen: 64
  610. # awaylen is the maximum length of an away message
  611. awaylen: 390
  612. # kicklen is the maximum length of a kick message
  613. kicklen: 390
  614. # topiclen is the maximum length of a channel topic
  615. topiclen: 390
  616. # maximum number of monitor entries a client can have
  617. monitor-entries: 100
  618. # whowas entries to store
  619. whowas-entries: 100
  620. # maximum length of channel lists (beI modes)
  621. chan-list-modes: 60
  622. # maximum number of messages to accept during registration (prevents
  623. # DoS / resource exhaustion attacks):
  624. registration-messages: 1024
  625. # message length limits for the new multiline cap
  626. multiline:
  627. max-bytes: 4096 # 0 means disabled
  628. max-lines: 100 # 0 means no limit
  629. # fakelag: prevents clients from spamming commands too rapidly
  630. fakelag:
  631. # whether to enforce fakelag
  632. enabled: true
  633. # time unit for counting command rates
  634. window: 1s
  635. # clients can send this many commands without fakelag being imposed
  636. burst-limit: 5
  637. # once clients have exceeded their burst allowance, they can send only
  638. # this many commands per `window`:
  639. messages-per-window: 2
  640. # client status resets to the default state if they go this long without
  641. # sending any commands:
  642. cooldown: 2s
  643. # the roleplay commands are semi-standardized extensions to IRC that allow
  644. # sending and receiving messages from pseudo-nicknames. this can be used either
  645. # for actual roleplaying, or for bridging IRC with other protocols.
  646. roleplay:
  647. # are roleplay commands enabled at all? (channels and clients still have to
  648. # opt in individually with the +E mode)
  649. enabled: false
  650. # require the "roleplay" oper capability to send roleplay messages?
  651. require-oper: false
  652. # require channel operator permissions to send roleplay messages?
  653. require-chanops: false
  654. # add the real nickname, in parentheses, to the end of every roleplay message?
  655. add-suffix: true
  656. # external services can integrate with the ircd using JSON Web Tokens (https://jwt.io).
  657. # in effect, the server can sign a token attesting that the client is present on
  658. # the server, is a member of a particular channel, etc.
  659. extjwt:
  660. # # default service config (for `EXTJWT #channel`).
  661. # # expiration time for the token:
  662. # expiration: 45s
  663. # # you can configure tokens to be signed either with HMAC and a symmetric secret:
  664. # secret: "65PHvk0K1_sM-raTsCEhatVkER_QD8a0zVV8gG2EWcI"
  665. # # or with an RSA private key:
  666. # #rsa-private-key-file: "extjwt.pem"
  667. # # named services (for `EXTJWT #channel service_name`):
  668. # services:
  669. # "jitsi":
  670. # expiration: 30s
  671. # secret: "qmamLKDuOzIzlO8XqsGGewei_At11lewh6jtKfSTbkg"
  672. # history message storage: this is used by CHATHISTORY, HISTORY, znc.in/playback,
  673. # various autoreplay features, and the resume extension
  674. history:
  675. # should we store messages for later playback?
  676. # by default, messages are stored in RAM only; they do not persist
  677. # across server restarts. however, you may want to understand how message
  678. # history interacts with the GDPR and/or any data privacy laws that apply
  679. # in your country and the countries of your users.
  680. enabled: true
  681. # how many channel-specific events (messages, joins, parts) should be tracked per channel?
  682. channel-length: 2048
  683. # how many direct messages and notices should be tracked per user?
  684. client-length: 256
  685. # how long should we try to preserve messages?
  686. # if `autoresize-window` is 0, the in-memory message buffers are preallocated to
  687. # their maximum length. if it is nonzero, the buffers are initially small and
  688. # are dynamically expanded up to the maximum length. if the buffer is full
  689. # and the oldest message is older than `autoresize-window`, then it will overwrite
  690. # the oldest message rather than resize; otherwise, it will expand if possible.
  691. autoresize-window: 3d
  692. # number of messages to automatically play back on channel join (0 to disable):
  693. autoreplay-on-join: 0
  694. # maximum number of CHATHISTORY messages that can be
  695. # requested at once (0 disables support for CHATHISTORY)
  696. chathistory-maxmessages: 100
  697. # maximum number of messages that can be replayed at once during znc emulation
  698. # (znc.in/playback, or automatic replay on initial reattach to a persistent client):
  699. znc-maxmessages: 2048
  700. # options to delete old messages, or prevent them from being retrieved
  701. restrictions:
  702. # if this is set, messages older than this cannot be retrieved by anyone
  703. # (and will eventually be deleted from persistent storage, if that's enabled)
  704. expire-time: 1w
  705. # if this is set, logged-in users cannot retrieve messages older than their
  706. # account registration date, and logged-out users cannot retrieve messages
  707. # older than their sign-on time (modulo grace-period, see below):
  708. enforce-registration-date: false
  709. # but if this is set, you can retrieve messages that are up to `grace-period`
  710. # older than the above cutoff time. this is recommended to allow logged-out
  711. # users to do session resumption / query history after disconnections.
  712. grace-period: 1h
  713. # options to store history messages in a persistent database (currently only MySQL).
  714. # in order to enable any of this functionality, you must configure a MySQL server
  715. # in the `datastore.mysql` section.
  716. persistent:
  717. enabled: false
  718. # store unregistered channel messages in the persistent database?
  719. unregistered-channels: false
  720. # for a registered channel, the channel owner can potentially customize
  721. # the history storage setting. as the server operator, your options are
  722. # 'disabled' (no persistent storage, regardless of per-channel setting),
  723. # 'opt-in', 'opt-out', and 'mandatory' (force persistent storage, ignoring
  724. # per-channel setting):
  725. registered-channels: "opt-out"
  726. # direct messages are only stored in the database for logged-in clients;
  727. # you can control how they are stored here (same options as above).
  728. # if you enable this, strict nickname reservation is strongly recommended
  729. # as well.
  730. direct-messages: "opt-out"
  731. # options to control how messages are stored and deleted:
  732. retention:
  733. # allow users to delete their own messages from history?
  734. allow-individual-delete: false
  735. # if persistent history is enabled, create additional index tables,
  736. # allowing deletion of JSON export of an account's messages. this
  737. # may be needed for compliance with data privacy regulations.
  738. enable-account-indexing: false
  739. # options to control storage of TAGMSG
  740. tagmsg-storage:
  741. # by default, should TAGMSG be stored?
  742. default: false
  743. # if `default` is false, store TAGMSG containing any of these tags:
  744. whitelist:
  745. - "+draft/react"
  746. - "react"
  747. # if `default` is true, don't store TAGMSG containing any of these tags:
  748. #blacklist:
  749. # - "+draft/typing"
  750. # - "typing"