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.

oragono.yaml 30KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751
  1. # oragono IRCd config
  2. # network configuration
  3. network:
  4. # name of the network
  5. name: OragonoTest
  6. # server configuration
  7. server:
  8. # server name
  9. name: oragono.test
  10. # addresses to listen on
  11. listeners:
  12. # The standard plaintext port for IRC is 6667. Allowing plaintext over the
  13. # public Internet poses serious security and privacy issues. Accordingly,
  14. # we recommend using plaintext only on local (loopback) interfaces:
  15. "127.0.0.1:6667": # (loopback ipv4, localhost-only)
  16. "[::1]:6667": # (loopback ipv6, localhost-only)
  17. # If you need to serve plaintext on public interfaces, comment out the above
  18. # two lines and uncomment the line below (which listens on all interfaces):
  19. # ":6667":
  20. # Alternately, if you have a TLS certificate issued by a recognized CA,
  21. # you can configure port 6667 as an STS-only listener that only serves
  22. # "redirects" to the TLS port, but doesn't allow chat. See the manual
  23. # for details.
  24. # The standard SSL/TLS port for IRC is 6697. This will listen on all interfaces:
  25. ":6697":
  26. tls:
  27. key: tls.key
  28. cert: tls.crt
  29. # 'proxy' should typically be false. It's only for Kubernetes-style load
  30. # balancing that does not terminate TLS, but sends an initial PROXY line
  31. # in plaintext.
  32. proxy: false
  33. # Example of a Unix domain socket for proxying:
  34. # "/tmp/oragono_sock":
  35. # Example of a Tor listener: any connection that comes in on this listener will
  36. # be considered a Tor connection. It is strongly recommended that this listener
  37. # *not* be on a public interface --- it should be on 127.0.0.0/8 or unix domain:
  38. # "/hidden_service_sockets/oragono_tor_sock":
  39. # tor: true
  40. # sets the permissions for Unix listen sockets. on a typical Linux system,
  41. # the default is 0775 or 0755, which prevents other users/groups from connecting
  42. # to the socket. With 0777, it behaves like a normal TCP socket
  43. # where anyone can connect.
  44. unix-bind-mode: 0777
  45. # configure the behavior of Tor listeners (ignored if you didn't enable any):
  46. tor-listeners:
  47. # if this is true, connections from Tor must authenticate with SASL
  48. require-sasl: false
  49. # what hostname should be displayed for Tor connections?
  50. vhost: "tor-network.onion"
  51. # allow at most this many connections at once (0 for no limit):
  52. max-connections: 64
  53. # connection throttling (limit how many connection attempts are allowed at once):
  54. throttle-duration: 10m
  55. # set to 0 to disable throttling:
  56. max-connections-per-duration: 64
  57. # strict transport security, to get clients to automagically use TLS
  58. sts:
  59. # whether to advertise STS
  60. #
  61. # to stop advertising STS, leave this enabled and set 'duration' below to "0". this will
  62. # advertise to connecting users that the STS policy they have saved is no longer valid
  63. enabled: false
  64. # how long clients should be forced to use TLS for.
  65. # setting this to a too-long time will mean bad things if you later remove your TLS.
  66. # the default duration below is 1 month, 2 days and 5 minutes.
  67. duration: 1mo2d5m
  68. # tls port - you should be listening on this port above
  69. port: 6697
  70. # should clients include this STS policy when they ship their inbuilt preload lists?
  71. preload: false
  72. # casemapping controls what kinds of strings are permitted as identifiers (nicknames,
  73. # channel names, account names, etc.), and how they are normalized for case.
  74. # with the recommended default of 'precis', utf-8 identifiers that are "sane"
  75. # (according to RFC 8265) are allowed, and the server additionally tries to protect
  76. # against confusable characters ("homoglyph attacks").
  77. # the other options are 'ascii' (traditional ASCII-only identifiers), and 'permissive',
  78. # which allows identifiers to contain unusual characters like emoji, but makes users
  79. # vulnerable to homoglyph attacks. unless you're really confident in your decision,
  80. # we recommend leaving this value at its default (changing it once the network is
  81. # already up and running is problematic).
  82. casemapping: "precis"
  83. # whether to look up user hostnames with reverse DNS
  84. # (to suppress this for privacy purposes, use the ip-cloaking options below)
  85. lookup-hostnames: true
  86. # whether to confirm hostname lookups using "forward-confirmed reverse DNS", i.e., for
  87. # any hostname returned from reverse DNS, resolve it back to an IP address and reject it
  88. # unless it matches the connecting IP
  89. forward-confirm-hostnames: true
  90. # use ident protocol to get usernames
  91. check-ident: false
  92. # password to login to the server
  93. # generated using "oragono genpasswd"
  94. #password: ""
  95. # motd filename
  96. # if you change the motd, you should move it to ircd.motd
  97. motd: oragono.motd
  98. # motd formatting codes
  99. # if this is true, the motd is escaped using formatting codes like $c, $b, and $i
  100. motd-formatting: true
  101. # addresses/CIDRs the PROXY command can be used from
  102. # this should be restricted to 127.0.0.1/8 and ::1/128 (unless you have a good reason)
  103. # you should also add these addresses to the connection limits and throttling exemption lists
  104. proxy-allowed-from:
  105. # - localhost
  106. # - "192.168.1.1"
  107. # - "192.168.10.1/24"
  108. # controls the use of the WEBIRC command (by IRC<->web interfaces, bouncers and similar)
  109. webirc:
  110. # one webirc block -- should correspond to one set of gateways
  111. -
  112. # SHA-256 fingerprint of the TLS certificate the gateway must use to connect
  113. # (comment this out to use passwords only)
  114. fingerprint: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
  115. # password the gateway uses to connect, made with oragono genpasswd
  116. password: "$2a$04$sLEFDpIOyUp55e6gTMKbOeroT6tMXTjPFvA0eGvwvImVR9pkwv7ee"
  117. # addresses/CIDRs that can use this webirc command
  118. # you should also add these addresses to the connection limits and throttling exemption lists
  119. hosts:
  120. # - localhost
  121. # - "192.168.1.1"
  122. # - "192.168.10.1/24"
  123. # allow use of the RESUME extension over plaintext connections:
  124. # do not enable this unless the ircd is only accessible over internal networks
  125. allow-plaintext-resume: false
  126. # maximum length of clients' sendQ in bytes
  127. # this should be big enough to hold bursts of channel/direct messages
  128. max-sendq: 96k
  129. # compatibility with legacy clients
  130. compatibility:
  131. # many clients require that the final parameter of certain messages be an
  132. # RFC1459 trailing parameter, i.e., prefixed with :, whether or not this is
  133. # actually required. this forces Oragono to send those parameters
  134. # as trailings. this is recommended unless you're testing clients for conformance;
  135. # defaults to true when unset for that reason.
  136. force-trailing: true
  137. # some clients (ZNC 1.6.x and lower, Pidgin 2.12 and lower) do not
  138. # respond correctly to SASL messages with the server name as a prefix:
  139. # https://github.com/znc/znc/issues/1212
  140. # this works around that bug, allowing them to use SASL.
  141. send-unprefixed-sasl: true
  142. # IP-based DoS protection
  143. ip-limits:
  144. # whether to limit the total number of concurrent connections per IP/CIDR
  145. count: true
  146. # maximum concurrent connections per IP/CIDR
  147. max-concurrent-connections: 16
  148. # whether to restrict the rate of new connections per IP/CIDR
  149. throttle: true
  150. # how long to keep track of connections for
  151. window: 10m
  152. # maximum number of new connections per IP/CIDR within the given duration
  153. max-connections-per-window: 32
  154. # how long to ban offenders for. after banning them, the number of connections is
  155. # reset, which lets you use /UNDLINE to unban people
  156. throttle-ban-duration: 10m
  157. # how wide the CIDR should be for IPv4 (a /32 is a fully specified IPv4 address)
  158. cidr-len-ipv4: 32
  159. # how wide the CIDR should be for IPv6 (a /64 is the typical prefix assigned
  160. # by an ISP to an individual customer for their LAN)
  161. cidr-len-ipv6: 64
  162. # IPs/networks which are exempted from connection limits
  163. exempted:
  164. - "localhost"
  165. # - "192.168.1.1"
  166. # - "2001:0db8::/32"
  167. # custom connection limits for certain IPs/networks. note that CIDR
  168. # widths defined here override the default CIDR width --- the limit
  169. # will apply to the entire CIDR no matter how large or small it is
  170. custom-limits:
  171. # "8.8.0.0/16":
  172. # max-concurrent-connections: 128
  173. # max-connections-per-window: 1024
  174. # IP cloaking hides users' IP addresses from other users and from channel admins
  175. # (but not from server admins), while still allowing channel admins to ban
  176. # offending IP addresses or networks. In place of hostnames derived from reverse
  177. # DNS, users see fake domain names like pwbs2ui4377257x8.oragono. These names are
  178. # generated deterministically from the underlying IP address, but if the underlying
  179. # IP is not already known, it is infeasible to recover it from the cloaked name.
  180. ip-cloaking:
  181. # whether to enable IP cloaking
  182. enabled: false
  183. # fake TLD at the end of the hostname, e.g., pwbs2ui4377257x8.oragono
  184. netname: "oragono"
  185. # secret key to prevent dictionary attacks against cloaked IPs
  186. # any high-entropy secret is valid for this purpose:
  187. # you MUST generate a new one for your installation.
  188. # suggestion: use the output of `oragono mksecret`
  189. # note that rotating this key will invalidate all existing ban masks.
  190. secret: "siaELnk6Kaeo65K3RCrwJjlWaZ-Bt3WuZ2L8MXLbNb4"
  191. # name of an environment variable to pull the secret from, for use with
  192. # k8s secret distribution:
  193. # secret-environment-variable: "ORAGONO_CLOAKING_SECRET"
  194. # the cloaked hostname is derived only from the CIDR (most significant bits
  195. # of the IP address), up to a configurable number of bits. this is the
  196. # granularity at which bans will take effect for IPv4. Note that changing
  197. # this value will invalidate any stored bans.
  198. cidr-len-ipv4: 32
  199. # analogous granularity for IPv6
  200. cidr-len-ipv6: 64
  201. # number of bits of hash output to include in the cloaked hostname.
  202. # more bits means less likelihood of distinct IPs colliding,
  203. # at the cost of a longer cloaked hostname. if this value is set to 0,
  204. # all users will receive simply `netname` as their cloaked hostname.
  205. num-bits: 64
  206. # secure-nets identifies IPs and CIDRs which are secure at layer 3,
  207. # for example, because they are on a trusted internal LAN or a VPN.
  208. # plaintext connections from these IPs and CIDRs will be considered
  209. # secure (clients will receive the +Z mode and be allowed to resume
  210. # or reattach to secure connections). note that loopback IPs are always
  211. # considered secure:
  212. secure-nets:
  213. # - "10.0.0.0/8"
  214. # account options
  215. accounts:
  216. # is account authentication enabled, i.e., can users log into existing accounts?
  217. authentication-enabled: true
  218. # account registration
  219. registration:
  220. # can users register new accounts for themselves? if this is false, operators with
  221. # the `accreg` capability can still create accounts with `/NICKSERV SAREGISTER`
  222. enabled: true
  223. # this is the bcrypt cost we'll use for account passwords
  224. bcrypt-cost: 9
  225. # length of time a user has to verify their account before it can be re-registered
  226. verify-timeout: "32h"
  227. # callbacks to allow
  228. enabled-callbacks:
  229. - none # no verification needed, will instantly register successfully
  230. # example configuration for sending verification emails via a local mail relay
  231. # callbacks:
  232. # mailto:
  233. # server: localhost
  234. # port: 25
  235. # tls:
  236. # enabled: false
  237. # username: ""
  238. # password: ""
  239. # sender: "admin@my.network"
  240. # throttle account login attempts (to prevent either password guessing, or DoS
  241. # attacks on the server aimed at forcing repeated expensive bcrypt computations)
  242. login-throttling:
  243. enabled: true
  244. # window
  245. duration: 1m
  246. # number of attempts allowed within the window
  247. max-attempts: 3
  248. # some clients (notably Pidgin and Hexchat) offer only a single password field,
  249. # which makes it impossible to specify a separate server password (for the PASS
  250. # command) and SASL password. if this option is set to true, a client that
  251. # successfully authenticates with SASL will not be required to send
  252. # PASS as well, so it can be configured to authenticate with SASL only.
  253. skip-server-password: false
  254. # require-sasl controls whether clients are required to have accounts
  255. # (and sign into them using SASL) to connect to the server
  256. require-sasl:
  257. # if this is enabled, all clients must authenticate with SASL while connecting
  258. enabled: false
  259. # IPs/CIDRs which are exempted from the account requirement
  260. exempted:
  261. - "localhost"
  262. # - '10.10.0.0/16'
  263. # nick-reservation controls how, and whether, nicknames are linked to accounts
  264. nick-reservation:
  265. # is there any enforcement of reserved nicknames?
  266. enabled: true
  267. # how many nicknames, in addition to the account name, can be reserved?
  268. additional-nick-limit: 2
  269. # method describes how nickname reservation is handled
  270. # timeout: let the user change to the registered nickname, give them X seconds
  271. # to login and then rename them if they haven't done so
  272. # strict: don't let the user change to the registered nickname unless they're
  273. # already logged-in using SASL or NickServ
  274. # optional: no enforcement by default, but allow users to opt in to
  275. # the enforcement level of their choice
  276. #
  277. # 'optional' matches the behavior of other NickServs, but 'strict' is
  278. # preferable if all your users can enable SASL.
  279. method: strict
  280. # allow users to set their own nickname enforcement status, e.g.,
  281. # to opt out of strict enforcement
  282. allow-custom-enforcement: true
  283. # rename-timeout - this is how long users have 'til they're renamed
  284. rename-timeout: 30s
  285. # rename-prefix - this is the prefix to use when renaming clients (e.g. Guest-AB54U31)
  286. rename-prefix: Guest-
  287. # multiclient controls whether oragono allows multiple connections to
  288. # attach to the same client/nickname identity; this is part of the
  289. # functionality traditionally provided by a bouncer like ZNC
  290. multiclient:
  291. # when disabled, each connection must use a separate nickname (as is the
  292. # typical behavior of IRC servers). when enabled, a new connection that
  293. # has authenticated with SASL can associate itself with an existing
  294. # client
  295. enabled: true
  296. # if this is disabled, clients have to opt in to bouncer functionality
  297. # using nickserv or the cap system. if it's enabled, they can opt out
  298. # via nickserv
  299. allowed-by-default: true
  300. # whether to allow clients that remain on the server even
  301. # when they have no active connections. The possible values are:
  302. # "disabled", "opt-in", "opt-out", or "mandatory".
  303. always-on: "disabled"
  304. # vhosts controls the assignment of vhosts (strings displayed in place of the user's
  305. # hostname/IP) by the HostServ service
  306. vhosts:
  307. # are vhosts enabled at all?
  308. enabled: true
  309. # maximum length of a vhost
  310. max-length: 64
  311. # regexp for testing the validity of a vhost
  312. # (make sure any changes you make here are RFC-compliant)
  313. valid-regexp: '^[0-9A-Za-z.\-_/]+$'
  314. # options controlling users requesting vhosts:
  315. user-requests:
  316. # can users request vhosts at all? if this is false, operators with the
  317. # 'vhosts' capability can still assign vhosts manually
  318. enabled: false
  319. # if uncommented, all new vhost requests will be dumped into the given
  320. # channel, so opers can review them as they are sent in. ensure that you
  321. # have registered and restricted the channel appropriately before you
  322. # uncomment this.
  323. #channel: "#vhosts"
  324. # after a user's vhost has been approved or rejected, they need to wait
  325. # this long (starting from the time of their original request)
  326. # before they can request a new one.
  327. cooldown: 168h
  328. # vhosts that users can take without approval, using `/HS TAKE`
  329. offer-list:
  330. #- "oragono.test"
  331. # support for deferring password checking to an external LDAP server
  332. # you should probably ignore this section! consult the grafana docs for details:
  333. # https://grafana.com/docs/grafana/latest/auth/ldap/
  334. # you will probably want to set require-sasl and disable accounts.registration.enabled
  335. # ldap:
  336. # enabled: true
  337. # # should we automatically create users if their LDAP login succeeds?
  338. # autocreate: true
  339. # # example configuration that works with Forum Systems's testing server:
  340. # # https://www.forumsys.com/tutorials/integration-how-to/ldap/online-ldap-test-server/
  341. # host: "ldap.forumsys.com"
  342. # port: 389
  343. # timeout: 30s
  344. # # example "single-bind" configuration, where we bind directly to the user's entry:
  345. # bind-dn: "uid=%s,dc=example,dc=com"
  346. # # example "admin bind" configuration, where we bind to an initial admin user,
  347. # # then search for the user's entry with a search filter:
  348. # #search-base-dns:
  349. # # - "dc=example,dc=com"
  350. # #bind-dn: "cn=read-only-admin,dc=example,dc=com"
  351. # #bind-password: "password"
  352. # #search-filter: "(uid=%s)"
  353. # # example of requiring that users be in a particular group
  354. # # (note that this is an OR over the listed groups, not an AND):
  355. # #require-groups:
  356. # # - "ou=mathematicians,dc=example,dc=com"
  357. # #group-search-filter-user-attribute: "dn"
  358. # #group-search-filter: "(uniqueMember=%s)"
  359. # #group-search-base-dns:
  360. # # - "dc=example,dc=com"
  361. # # example of group membership testing via user attributes, as in AD
  362. # # or with OpenLDAP's "memberOf overlay" (overrides group-search-filter):
  363. # attributes:
  364. # member-of: "memberOf"
  365. # channel options
  366. channels:
  367. # modes that are set when new channels are created
  368. # +n is no-external-messages and +t is op-only-topic
  369. # see /QUOTE HELP cmodes for more channel modes
  370. default-modes: +nt
  371. # how many channels can a client be in at once?
  372. max-channels-per-client: 100
  373. # if this is true, new channels can only be created by operators with the
  374. # `chanreg` operator capability
  375. operator-only-creation: false
  376. # channel registration - requires an account
  377. registration:
  378. # can users register new channels?
  379. enabled: true
  380. # how many channels can each account register?
  381. max-channels-per-account: 15
  382. # operator classes
  383. oper-classes:
  384. # local operator
  385. "local-oper":
  386. # title shown in WHOIS
  387. title: Local Operator
  388. # capability names
  389. capabilities:
  390. - "oper:local_kill"
  391. - "oper:local_ban"
  392. - "oper:local_unban"
  393. - "nofakelag"
  394. # network operator
  395. "network-oper":
  396. # title shown in WHOIS
  397. title: Network Operator
  398. # oper class this extends from
  399. extends: "local-oper"
  400. # capability names
  401. capabilities:
  402. - "oper:remote_kill"
  403. - "oper:remote_ban"
  404. - "oper:remote_unban"
  405. # server admin
  406. "server-admin":
  407. # title shown in WHOIS
  408. title: Server Admin
  409. # oper class this extends from
  410. extends: "local-oper"
  411. # capability names
  412. capabilities:
  413. - "oper:rehash"
  414. - "oper:die"
  415. - "accreg"
  416. - "sajoin"
  417. - "samode"
  418. - "vhosts"
  419. - "chanreg"
  420. # ircd operators
  421. opers:
  422. # operator named 'dan'
  423. dan:
  424. # which capabilities this oper has access to
  425. class: "server-admin"
  426. # custom whois line
  427. whois-line: is a cool dude
  428. # custom hostname
  429. vhost: "n"
  430. # modes are the modes to auto-set upon opering-up
  431. modes: +is acjknoqtuxv
  432. # operators can be authenticated either by password (with the /OPER command),
  433. # or by certificate fingerprint, or both. if a password hash is set, then a
  434. # password is required to oper up (e.g., /OPER dan mypassword). to generate
  435. # the hash, use `oragono genpasswd`.
  436. password: "$2a$04$LiytCxaY0lI.guDj2pBN4eLRD5cdM2OLDwqmGAgB6M2OPirbF5Jcu"
  437. # if a SHA-256 certificate fingerprint is configured here, then it will be
  438. # required to /OPER. if you comment out the password hash above, then you can
  439. # /OPER without a password.
  440. #fingerprint: "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
  441. # if 'auto' is set (and no password hash is set), operator permissions will be
  442. # granted automatically as soon as you connect with the right fingerprint.
  443. #auto: true
  444. # logging, takes inspiration from Insp
  445. logging:
  446. -
  447. # how to log these messages
  448. #
  449. # file log to given target filename
  450. # stdout log to stdout
  451. # stderr log to stderr
  452. # (you can specify multiple methods, e.g., to log to both stderr and a file)
  453. method: stderr
  454. # filename to log to, if file method is selected
  455. # filename: ircd.log
  456. # type(s) of logs to keep here. you can use - to exclude those types
  457. #
  458. # exclusions take precedent over inclusions, so if you exclude a type it will NEVER
  459. # be logged, even if you explicitly include it
  460. #
  461. # useful types include:
  462. # * everything (usually used with exclusing some types below)
  463. # server server startup, rehash, and shutdown events
  464. # accounts account registration and authentication
  465. # channels channel creation and operations
  466. # commands command calling and operations
  467. # opers oper actions, authentication, etc
  468. # services actions related to NickServ, ChanServ, etc.
  469. # internal unexpected runtime behavior, including potential bugs
  470. # userinput raw lines sent by users
  471. # useroutput raw lines sent to users
  472. type: "* -userinput -useroutput"
  473. # one of: debug info warn error
  474. level: info
  475. #-
  476. # # example of a file log that avoids logging IP addresses
  477. # method: file
  478. # filename: ircd.log
  479. # type: "* -userinput -useroutput -localconnect -localconnect-ip"
  480. # level: debug
  481. # debug options
  482. debug:
  483. # when enabled, oragono will attempt to recover from certain kinds of
  484. # client-triggered runtime errors that would normally crash the server.
  485. # this makes the server more resilient to DoS, but could result in incorrect
  486. # behavior. deployments that would prefer to "start from scratch", e.g., by
  487. # letting the process crash and auto-restarting it with systemd, can set
  488. # this to false.
  489. recover-from-errors: true
  490. # optionally expose a pprof http endpoint: https://golang.org/pkg/net/http/pprof/
  491. # it is strongly recommended that you don't expose this on a public interface;
  492. # if you need to access it remotely, you can use an SSH tunnel.
  493. # set to `null`, "", leave blank, or omit to disable
  494. # pprof-listener: "localhost:6060"
  495. # datastore configuration
  496. datastore:
  497. # path to the datastore
  498. path: ircd.db
  499. # if the database schema requires an upgrade, `autoupgrade` will attempt to
  500. # perform it automatically on startup. the database will be backed
  501. # up, and if the upgrade fails, the original database will be restored.
  502. autoupgrade: true
  503. # connection information for MySQL (currently only used for persistent history):
  504. mysql:
  505. enabled: false
  506. host: "localhost"
  507. # port is unnecessary for connections via unix domain socket:
  508. #port: 3306
  509. user: "oragono"
  510. password: "hunter2"
  511. history-database: "oragono_history"
  512. timeout: 3s
  513. # languages config
  514. languages:
  515. # whether to load languages
  516. enabled: true
  517. # default language to use for new clients
  518. # 'en' is the default English language in the code
  519. default: en
  520. # which directory contains our language files
  521. path: languages
  522. # limits - these need to be the same across the network
  523. limits:
  524. # nicklen is the max nick length allowed
  525. nicklen: 32
  526. # identlen is the max ident length allowed
  527. identlen: 20
  528. # channellen is the max channel length allowed
  529. channellen: 64
  530. # awaylen is the maximum length of an away message
  531. awaylen: 500
  532. # kicklen is the maximum length of a kick message
  533. kicklen: 1000
  534. # topiclen is the maximum length of a channel topic
  535. topiclen: 1000
  536. # maximum number of monitor entries a client can have
  537. monitor-entries: 100
  538. # whowas entries to store
  539. whowas-entries: 100
  540. # maximum length of channel lists (beI modes)
  541. chan-list-modes: 60
  542. # maximum number of messages to accept during registration (prevents
  543. # DoS / resource exhaustion attacks):
  544. registration-messages: 1024
  545. # message length limits for the new multiline cap
  546. multiline:
  547. max-bytes: 4096 # 0 means disabled
  548. max-lines: 100 # 0 means no limit
  549. # fakelag: prevents clients from spamming commands too rapidly
  550. fakelag:
  551. # whether to enforce fakelag
  552. enabled: true
  553. # time unit for counting command rates
  554. window: 1s
  555. # clients can send this many commands without fakelag being imposed
  556. burst-limit: 5
  557. # once clients have exceeded their burst allowance, they can send only
  558. # this many commands per `window`:
  559. messages-per-window: 2
  560. # client status resets to the default state if they go this long without
  561. # sending any commands:
  562. cooldown: 2s
  563. # message history tracking, for the RESUME extension and possibly other uses in future
  564. history:
  565. # should we store messages for later playback?
  566. # by default, messages are stored in RAM only; they do not persist
  567. # across server restarts. however, you should not enable this unless you understand
  568. # how it interacts with the GDPR and/or any data privacy laws that apply
  569. # in your country and the countries of your users.
  570. enabled: false
  571. # how many channel-specific events (messages, joins, parts) should be tracked per channel?
  572. channel-length: 1024
  573. # how many direct messages and notices should be tracked per user?
  574. client-length: 256
  575. # how long should we try to preserve messages?
  576. # if `autoresize-window` is 0, the in-memory message buffers are preallocated to
  577. # their maximum length. if it is nonzero, the buffers are initially small and
  578. # are dynamically expanded up to the maximum length. if the buffer is full
  579. # and the oldest message is older than `autoresize-window`, then it will overwrite
  580. # the oldest message rather than resize; otherwise, it will expand if possible.
  581. autoresize-window: 1h
  582. # number of messages to automatically play back on channel join (0 to disable):
  583. autoreplay-on-join: 0
  584. # maximum number of CHATHISTORY messages that can be
  585. # requested at once (0 disables support for CHATHISTORY)
  586. chathistory-maxmessages: 100
  587. # maximum number of messages that can be replayed at once during znc emulation
  588. # (znc.in/playback, or automatic replay on initial reattach to a persistent client):
  589. znc-maxmessages: 2048
  590. # options to delete old messages, or prevent them from being retrieved
  591. restrictions:
  592. # if this is set, messages older than this cannot be retrieved by anyone
  593. # (and will eventually be deleted from persistent storage, if that's enabled)
  594. #expire-time: 1w
  595. # if this is set, logged-in users cannot retrieve messages older than their
  596. # account registration date, and logged-out users cannot retrieve messages
  597. # older than their sign-on time (modulo grace-period, see below):
  598. enforce-registration-date: false
  599. # but if this is set, you can retrieve messages that are up to `grace-period`
  600. # older than the above cutoff time. this is recommended to allow logged-out
  601. # users to do session resumption / query history after disconnections.
  602. grace-period: 1h
  603. # options to store history messages in a persistent database (currently only MySQL):
  604. persistent:
  605. enabled: false
  606. # store unregistered channel messages in the persistent database?
  607. unregistered-channels: false
  608. # for a registered channel, the channel owner can potentially customize
  609. # the history storage setting. as the server operator, your options are
  610. # 'disabled' (no persistent storage, regardless of per-channel setting),
  611. # 'opt-in', 'opt-out', and 'mandatory' (force persistent storage, ignoring
  612. # per-channel setting):
  613. registered-channels: "opt-out"
  614. # direct messages are only stored in the database for logged-in clients;
  615. # you can control how they are stored here (same options as above).
  616. # if you enable this, strict nickname reservation is strongly recommended
  617. # as well.
  618. direct-messages: "opt-out"