GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Code Issues Projects Releases Wiki Activity

Editing, make changelog and manual easier to read

Browse Source
This commit is contained in:
Daniel Oaks 2019-06-12 19:11:39 +10:00
parent 3f5d59838e
commit 02d9934ebd
3 changed files with 91 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
CHANGELOG.md
View File

@ -4,88 +4,89 @@ All notable changes to Oragono will be documented in this file.
## [1.1.0-rc1] - 2019-06-11 ## [1.1.0-rc1] - 2019-06-11
We're pleased to be publishing the release candidate for 1.1.0 (the official release should follow in a week or two, with more complete credits). This version has a number of exciting improvements, including: We're pleased to be publishing the release candidate for 1.1.0 (the official release should follow in a week or two, with more complete credits). This version has a number of exciting improvements, including:
* Support for attaching multiple clients to the same nickname * Simplified commands for registering new accounts with NickServ.
* Support for the newly ratified [message tags](https://ircv3.net/specs/extensions/message-tags.html) and [message ID](https://ircv3.net/specs/extensions/message-ids.html) IRCv3 specifications; client developers are invited to use Oragono as a reference when implementing these specifications * Support for IP cloaking.
* Support for running Oragono as a Tor hidden service * Support for attaching multiple clients to the same nickname.
* Support for IP cloaking * Support for the newly ratified [message tags](https://ircv3.net/specs/extensions/message-tags.html) and [message ID](https://ircv3.net/specs/extensions/message-ids.html) IRCv3 specifications; client developers are invited to use Oragono as a reference when implementing these specifications.
* Simplified commands for registering new accounts with NickServ * Support for running Oragono as a Tor hidden service.
This release includes a schema change. If you have `datastore.autoupgrade` set to `true` in your configuration, it will be automatically applied on first restart; otherwise, you can apply it manually as described in the manual. This release includes a database change. If you have `datastore.autoupgrade` set to `true` in your configuration, it will be automatically applied when you restart Oragono; otherwise, you can update the database manually by running `oragono upgradedb`.
### Config changes ### Config changes
* `tor-listeners` section added, for configuring listeners for use by Tor * `tor-listeners` section added for configuring listeners for use with Tor.
* `compatibility` section added for toggling compatibility behaviors for legacy clients * `compatibility` section added for toggling compatibility behaviors for legacy clients.
* `ip-cloaking` section added for configuring cloaking * `ip-cloaking` section added for configuring cloaking.
* `bouncer` section added for configuring bouncer-like features (in particular, whether multiple clients can use the same nickname) * `bouncer` section added for configuring bouncer-like features (in particular, whether multiple clients can use the same nickname).
* `check-ident` now has recommended value `false` * `check-ident` now defaults to `false`.
* `nick-reservation.method` now has recommended value `strict` * `nick-reservation.method` now defaults to `"strict"`.
* `fakelag.enabled` now has recommended value `true` * `fakelag.enabled` now defaults to `true`
* `limits.linelen.tags` removed due to ratification of the [message-tags spec](https://ircv3.net/specs/extensions/message-tags.html), which fixes the maximum tags length at 8191 bytes * `limits.linelen.tags` removed due to ratification of the [message-tags spec](https://ircv3.net/specs/extensions/message-tags.html), which fixes the maximum tags length at 8191 bytes.
* `registration-messages` added to limit the length of the registration sequence (i.e., handshake) * `limits.registration-messages` added to restrict how many messages a user can send to the server during connection registration (while connecting to the server).
* `channels.operator-only-creation` added to optionally restrict creation of new channels to ircops (#537) * `channels.operator-only-creation` added to optionally restrict creation of new channels to ircops (#537).
### Security ### Security
* Eliminated the possibility of using confusable Unicode characters to impersonate network services like NickServ (#519, thanks [@csmith](https://github.com/csmith)!) * Users can no longer impersonate network services like ChanServ by using confusing nicks like "ChɑnServ" (#519, thanks [@csmith](https://github.com/csmith)!).
* Improved privacy properties of secret (mode `+s`) channels (#380, thanks [@csmith](https://github.com/csmith)!) * Secret channels (mode `+s`) now act more secret (#380, thanks [@csmith](https://github.com/csmith)!).
* The `+R` (registered-only) mode now prevents unregistered clients from joining the channel, not just from speaking (#463, thanks [@bogdomania](https://github.com/bogdomania)!) * The `+R` (registered-only) mode now prevents unregistered users from joining the channel, not just from speaking (#463, thanks [@bogdomania](https://github.com/bogdomania)!).
* Limited the total length of the registration sequence (handshake) to mitigate potential DoS attacks (#505) * Limited how many messages clients can send during connection registration to mitigate potential DoS attacks (#505).
* Attempting to reauthenticate with SASL now fails with `907 ERR_SASLALREADY` (#476) * Attempting to reauthenticate with SASL now fails with `907 ERR_SASLALREADY` (#476).
### Fixed ### Fixed
* Fixed `/ISON` command reporting users as always being online (#479) * Fixed `/ISON` command reporting users as always being online (#479).
* Fixed clients who negotiated CAP version 302 or higher not receiving cap-notify messages (#464) * Fixed clients who negotiated CAP version 302 or higher not receiving cap-notify messages (#464).
* More consistent handling of channel privileges, in particular halfop (#400) * We now treat channel privileges such as halfop more consistently (#400).
* More consistent assignment of message IDs and timestamps to messages (#388, #477, #483) * Fixed a bug where clients could receive message tags they hadn't enabled (#434).
* Client-only tags are now stored for replay (#437) * When replaying history, messages now have more consistent IDs and timestamps
* Fixed various error numerics with incorrect parameters (#425, thanks [@Ascrod](https://github.com/Ascrod)!) * IDs and timestamps are now applied more consistently to messages (#388, #477, #483).
* Fixed STATUSMSG not adding the correct prefix to the channel when relaying the message (#467) * Client-to-client tags are now stored and replayed in message history (#437).
* Fixed bugs in how the `RENAME` command worked with legacy clients (#300, thanks [@jesopo](https://github.com/jesopo)!) * Fixed various error numerics that were being sent with incorrect parameters (#425, thanks [@Ascrod](https://github.com/Ascrod)!).
* Fixed a bug where clients could receive tags they hadn't enabled (#434) * Fixed STATUSMSG not adding the correct prefix to the channel when relaying the message (#467).
* History playback is batched when applicable (#456, thanks [@transitracer](https://github.com/oragono/oragono/issues/456)!) * Fixed `/RENAME` command not correctly renaming the channel for some users (#300, thanks [@jesopo](https://github.com/jesopo)!).
* Improved display of notices from NickServ etc. in some clients (#496, thanks [@jwheare](https://github.com/jwheare)!) * History playback is now batched when applicable (#456, thanks [@transitracer](https://github.com/oragono/oragono/issues/456)!).
* Fixed nickname timer warnings not displaying correctly under some circumstances (#449, thanks [@bogdomania](https://github.com/bogdomania)!) * Notices from NickServ/ChanServ/etc should display better in some clients (#496, thanks [@jwheare](https://github.com/jwheare)!).
* Fixed confusing output from `/HISTORY` when history is disabled (#429, thanks [@bogdomania](https://github.com/bogdomania)!) * Fixed nickname timer warnings not displaying correctly sometimes (#449, thanks [@bogdomania](https://github.com/bogdomania)!).
* Fixed confusing output from `/HOSTSERV ON` when no vhost is available (#404, thanks [@bogdomania](https://github.com/bogdomania)!) * When history playback is disabled, the `/HISTORY` command now says so instead of silently failing (#429, thanks [@bogdomania](https://github.com/bogdomania)!).
* Fixed confusing snomask from `/SANICK` command (#360, thanks [@bogdomania](https://github.com/bogdomania)!) * The `/HOSTSERV ON/OFF` commands now tell you when you don't have a vhost (#404, thanks [@bogdomania](https://github.com/bogdomania)!).
* When operators use the `/SANICK` command, the snomask now says which operator did it instead of saying the target changed their nickname themselves (#360, thanks [@bogdomania](https://github.com/bogdomania)!).
* History playback now includes messages that the user sent themselves (especially useful with the new bouncer-like capabilities) (#487).
### Added ### Added
* Support for attaching multiple clients to the same nickname (see the manual for details) (#403) * IP cloaking is now supported (see the manual for details) (#108).
* Support for running Oragono as a Tor hidden service (see the manual for details) (#369) * Users can now attach multiple clients to the same nickname (see the manual for details) (#403).
* Support for IP cloaking (see the manual for details) (#108) * Oragono can now be used as a Tor hidden service (see the manual for details) (#369).
* Support for `znc.in/playback`, which can automate history playback on rejoin for clients that support it (#486) * The `znc.in/playback` capability is now supported, which can automate history playback for clients that support it (#486).
* User preference system controlling various behaviors (`/msg NickServ help set` for details) (#466) * User preference system controlling various behaviors (`/msg NickServ help set` for details) (#466).
* Support for the [draft/event-playback](https://github.com/DanielOaks/ircv3-specifications/blob/master+event-playback/extensions/batch/history.md) spec (#457) * Support for the [draft/event-playback](https://github.com/DanielOaks/ircv3-specifications/blob/master+event-playback/extensions/batch/history.md) spec (#457).
* TAGMSG and NICK are now replayable (#457) * The `TAGMSG` and `NICK` messages are now replayable in history (#457).
* Added the [SETNAME](https://github.com/ircv3/ircv3-specifications/pull/361) command for changing the user's realname (#372) * Added the draft IRCv3 [`SETNAME` command](https://ircv3.net/specs/extensions/setname) for changing your realname (#372).
### Changed ### Changed
* Registering an account with NickServ is now `/msg NickServ register <password>`, which registers the current nickname as an account, matching other service frameworks (#410) * Registering an account with NickServ is now `/msg NickServ register <password>`, which registers the current nickname as an account, matching other services (#410).
* Added a compatibility hack to make SASL work with ZNC 1.6.x (#261) * Added a compatibility hack to make SASL work with ZNC 1.6.x (#261).
* Support for the ratified [message-tags](https://ircv3.net/specs/extensions/message-tags.html) spec, replacing `draft/message-tags-0.2` * We now support the ratified [message-tags](https://ircv3.net/specs/extensions/message-tags.html) spec, replacing `draft/message-tags-0.2`.
* Support for the ratified [message IDs](https://ircv3.net/specs/extensions/message-ids.html) spec, replacing `draft/msgid` * We now support the ratified [message IDs](https://ircv3.net/specs/extensions/message-ids.html) spec, replacing `draft/msgid`.
* Support for the upgraded [oragono.io/maxline-2](https://oragono.io/maxline-2) capability (#433) * The [`oragono.io/maxline-2`](https://oragono.io/maxline-2) capability has replaced `oragono.io/maxline`, the new version now working alongside the ratified message-tags spec (#433).
* Support for the [draft/resume-0.5](https://github.com/ircv3/ircv3-specifications/pull/306) capability and the associated `BRB` command, replacing `draft/resume-0.3` * We now support [`draft/resume-0.5`](https://github.com/ircv3/ircv3-specifications/pull/306) and the associated `BRB` command, replacing `draft/resume-0.3`.
* Upgraded support for the `RENAME` command to the [latest draft of the specification](https://github.com/ircv3/ircv3-specifications/pull/308) * Upgraded support for the `/RENAME` command to the [latest draft of the specification](https://github.com/ircv3/ircv3-specifications/pull/308).
* Upgraded support for the `ACC` command to the [latest draft of the specification](https://github.com/DanielOaks/ircv3-specifications/blob/register-and-verify/extensions/acc-core.md) (#453, #455) * Upgraded support for the `/ACC` command to the [latest draft of the specification](https://github.com/DanielOaks/ircv3-specifications/blob/register-and-verify/extensions/acc-core.md) (#453, #455).
* History buffers and replay now include private messages you sent as well as received (#487) * Removed the `+a` away mode as no other servers use it (#468, thanks [@jesopo](https://github.com/jesopo) and [@jwheare](https://github.com/jwheare)!).
* Removed the `+a` away mode (#468, thanks [@jesopo](https://github.com/jesopo) and [@jwheare](https://github.com/jwheare)!) * Forcing trailing parameters for legacy compatibility can now be disabled in config (#479).
* Forcing trailing parameters for legacy compatibility can now be disabled in config (#479) * `autoreplay-on-join` no longer replays `JOIN` and `PART` lines by default (#474, thanks [@amyspark](https://github.com/amyspark)!).
* `autoreplay-on-join` no longer attempts to replay JOIN and PART lines by default (#474, thanks [@amyspark](https://github.com/amyspark)!) * snomasks are no longer sent for unregistered clients (#362, thanks [@bogdomania](https://github.com/bogdomania)!).
* snomasks are no longer sent for unregistered clients (#362, thanks [@bogdomania](https://github.com/bogdomania)!) * `WHOIS` responses no longer include the `690 RPL_WHOISLANGUAGE` numeric, as it doesn't show anything useful to other users (#516).
* `WHOIS` responses no longer include the `690 RPL_WHOISLANGUAGE` numeric (#516) * `ISON` now reports services (ChanServ/NickServ/etc) as online (#488).
* `ISON` responses are now sent for services (#488) * All times are now reported in UTC (#480).
* All times are now reported in UTC (#480) * `NICKSERV ENFORCE` is deprecated in favor of the new `NICKSERV SET ENFORCE` (the old syntax is still available as an alias).
* `NICKSERV ENFORCE` is deprecated in favor of the new `NICKSERV SET ENFORCE` (the old syntax is still available as an alias) * The `WHO` command is now treated like `PONG` in that it doesn't count as user activity, since client software often uses it automatically (#485).
* The `WHO` command is now treated like `PONG` in that it doesn't count as session activity (#485) * The `NAMES` command now only returns results for the first given channel (#534).
* The `NAMES` command now ignores parameters after the first (#534)
### Internal Notes ### Internal Notes
* Improved build scripts (#409) * Building Oragono is now easier (#409).
* Official builds now use Go 1.12 (#406) * Official builds now use Go 1.12 (#406).
* Minor improvements to the performance of the message building and parsing code (#387) * Our message building and parsing code is slightly faster now (#387).
* Added `oragono.io/nope` capability as a way of encouraging clients to request capabilities safely (#511) * Added the [`oragono.io/nope`](https://oragono.io/nope) capability to encourage clients to request capabilities safely (#511).
* Made some previously untranslatable strings translatable (#407) * Made some previously untranslatable strings translatable (#407).
* Fixed latent portability issues with 32-bit architectures (#527) * Fixed portability issues with 32-bit architectures (#527).
## [1.0.0] - 2019-02-24 ## [1.0.0] - 2019-02-24

8
README.md
View File

@ -22,12 +22,12 @@ Oragono is a fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomad
* UTF-8 nick and channel names with rfc7613 (PRECIS) * UTF-8 nick and channel names with rfc7613 (PRECIS)
* [yaml](http://yaml.org/) configuration * [yaml](http://yaml.org/) configuration
* native TLS/SSL support * native TLS/SSL support
* on-the-fly updating server config and TLS certificates (rehashing) * updating server config and TLS certificates on-the-fly (rehashing)
* client accounts and SASL * user accounts and SASL
* supports [multiple languages](https://crowdin.com/project/oragono) (you can also set a default language for your network) * supports [multiple languages](https://crowdin.com/project/oragono) (you can also set a default language for your network)
* integrated services: NickServ for nickname reservation, ChanServ for channel registration, and HostServ for vhosts * integrated services: NickServ for user accounts, ChanServ for channel registration, and HostServ for vanity hosts
* experimental support for bouncer-like features (storing and replaying history, allowing multiple clients to use the same nickname) * experimental support for bouncer-like features (storing and replaying history, allowing multiple clients to use the same nickname)
* advanced security and privacy features (support for requiring SASL for all logins, cloaking IPs, or running as a Tor hidden service) * advanced security and privacy features (support for requiring SASL for all logins, cloaking IPs, and running as a Tor hidden service)
* an extensible privilege system for IRC operators * an extensible privilege system for IRC operators
* ident lookups for usernames * ident lookups for usernames
* automated client connection limits * automated client connection limits

36
docs/MANUAL.md
View File

@ -5,10 +5,10 @@
▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌ ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
▀█▄▀▪.▀ ▀ ▀ ▀ ·▀▀▀▀ ▀█▄▀ ▀▀ █▪ ▀█▄▀▪ ▀█▄▀▪.▀ ▀ ▀ ▀ ·▀▀▀▀ ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
Oragono IRCd Manual 2019-02-23 Oragono IRCd Manual 2019-06-12
https://oragono.io/ https://oragono.io/
_Copyright © 2018 Daniel Oaks <daniel@danieloaks.net>_ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn@cs.stanford.edu>_
-------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------
@ -49,7 +49,7 @@ _Copyright © 2018 Daniel Oaks <daniel@danieloaks.net>_
This document goes over the Oragono IRC server, how to get it running and how to use it once it is up and running! This document goes over the Oragono IRC server, how to get it running and how to use it once it is up and running!
If you have any suggestions, issues or questions, feel free to submit an issue on our [GitHub repo](https://github.com/oragono/oragono/) or ask in our channel [`#oragono` on Freenode](ircs://irc.freenode.net:6697/#oragono). If you have any suggestions, issues or questions, feel free to submit an issue on our [GitHub repo](https://github.com/oragono/oragono/) or ask in our channel [`#oragono` on freenode](ircs://irc.freenode.net:6697/#oragono).
## Project Basics ## Project Basics
@ -73,15 +73,15 @@ Some of the features that sets Oragono apart from other servers are:
- Support for [multiple languages](https://crowdin.com/project/oragono). - Support for [multiple languages](https://crowdin.com/project/oragono).
- Bouncer-like features, including allowing multiple clients to use the same nickname - Bouncer-like features, including allowing multiple clients to use the same nickname
Oragono has multiple "production" deployments (that is to say, communities using it as a day-to-day chat server) and is fairly mature --- we encourage you to consider it for your community! Oragono has multiple communities using it as a day-to-day chat server and is fairly mature --- we encourage you to consider it for your community!
## Scalability ## Scalability
We believe Oragono should scale comfortably to 10,000 clients and 2,000 clients per channel, making it suitable for small to medium-sized teams and communities. Oragono does not currently support server-to-server linking (federation), meaning that all clients must connect to the same instance. However, since Oragono is implemented in Go, it is reasonably effective at distributing work across multiple cores on a single server; in other words, it should "scale up" rather than "scaling out". We believe Oragono should scale comfortably to 10,000 clients and 2,000 clients per channel, making it suitable for small to medium-sized teams and communities. Oragono does not currently support server-to-server linking (federation), meaning that all clients must connect to the same instance. However, since Oragono is implemented in Go, it is reasonably effective at distributing work across multiple cores on a single server; in other words, it should "scale up" rather than "scaling out".
In the relatively near term, work is planned to make Oragono [highly available](https://github.com/oragono/oragono/issues/343), and in the long term, we hope to support [federation](https://github.com/oragono/oragono/issues/26) as well. In the relatively near term, we plan to make Oragono [highly available](https://github.com/oragono/oragono/issues/343), and in the long term, we hope to support [federation](https://github.com/oragono/oragono/issues/26) as well.
If you're interested in deploying Oragono at scale, or want performance tuning advice, come find us via the abovementioned support channels: we're very interested in what our software can do! If you're interested in deploying Oragono at scale, or want performance tuning advice, come find us on [`#oragono` on freenode](ircs://irc.freenode.net:6697/#oragono), we're very interested in what our software can do!
-------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------
@ -135,14 +135,14 @@ On a non-systemd system, oragono can be configured to log to a file and used [lo
As long as you are using official releases or release candidates of Oragono, any backwards-incompatible changes should be described in the changelog. As long as you are using official releases or release candidates of Oragono, any backwards-incompatible changes should be described in the changelog.
The database has schema versioning; upgrades that involve incompatible changes to the database require schema changes. If you have `datastore.autoupgrade` enabled in your config, any schema changes will be automatically applied the first time you restart your server on the new version. Otherwise, you can apply upgrades manually: The database is versioned; upgrades that involve incompatible changes to the database require updating the database. If you have `datastore.autoupgrade` enabled in your config, the database will be backed up and upgraded when you restart your server when required. Otherwise, you can apply upgrades manually:
1. Stop your server 1. Stop your server
1. Make a backup of your database file 1. Make a backup of your database file
1. Run `oragono upgradedb` (from the same working directory and with the same arguments that you would use when running `oragono run`) 1. Run `oragono upgradedb` (from the same working directory and with the same arguments that you would use when running `oragono run`)
1. Start the server again 1. Start the server again
If you want to run our master branch as opposed to our releases, come find us in #oragono and we can guide you around any potential pitfalls. If you want to run our master branch as opposed to our releases, come find us in our channel and we can guide you around any potential pitfalls.
-------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------
@ -202,7 +202,7 @@ To enable this mode, set the following configs:
The following additional configs may be of interest: The following additional configs may be of interest:
* `accounts.nick-reservation.method = strict` ; we currently recommend strict nickname enforcement as the default, since we've found that it's less disruptive than timeout-based enforcement in real-world settings * `accounts.nick-reservation.method = strict` ; we currently recommend strict nickname enforcement as the default, since we've found that users find it less confusing.
* `accounts.nick-reservation.allow-custom-enforcement = true` ; this allows people to opt into timeout-based enforcement or opt out of enforcement as they wish. For details on how to do this, `/msg NickServ help set`. * `accounts.nick-reservation.allow-custom-enforcement = true` ; this allows people to opt into timeout-based enforcement or opt out of enforcement as they wish. For details on how to do this, `/msg NickServ help set`.
### SASL-only mode ### SASL-only mode
@ -273,26 +273,24 @@ Our language and translation functionality is very early, so feel free to let us
## Bouncer ## Bouncer
Traditionally, every separate client connection to IRC has a separate identity and must use a separate nickname. Middleware programs called [bouncers](https://en.wikipedia.org/wiki/BNC_%28software%29#IRC) are used to work around this, by multiplexing a single connection to an underlying server across multiple clients. With Oragono, if the server is configured to allow it, a new client connection can share a nickname with an old one directly, without needing a bouncer. To use this feature, both connections must authenticate with SASL to the same user account and then request the same nickname during the initial handshake ("registration") --- once you have already logged into the server, you cannot subsequently change to a shared nickname. Traditionally, every connection to an IRC server is separate must use a different nickname. [Bouncers](https://en.wikipedia.org/wiki/BNC_%28software%29#IRC) are used to work around this, by letting multiple clients connect to a single nickname. With Oragono, if the server is configured to allow it, multiple clients can share a single nickname without needing a bouncer. To use this feature, both connections must authenticate with SASL to the same user account and then use the same nickname during connection registration (while connecting to the server) – once you've logged-in, you can't share another nickname.
To enable this functionality as a server administrator, set `accounts.bouncer.enabled` to `true`. You may also want to set `accounts.bouncer.allowed-by-default` to `true`, which makes the behavior opt-out for end users instead of opt-in. End users can opt in or out using `NS SET BOUNCER`. To enable this functionality, set `accounts.bouncer.enabled` to `true`. Setting `accounts.bouncer.allowed-by-default` to `true` will allow this for everyone – by default, users need to opt-in to shared connections using `/msg NickServ SET BOUNCER`.
We are working on a number of initiatives to improve client support for this behavior, in particular [automated history replay](https://github.com/ircv3/ircv3-specifications/pull/349). You can see a list of your active sessions and their idle times with `/msg NickServ sessions` (network operators can use `/msg NickServ sessions nickname` to see another user's sessions).
You can see a list of your active sessions and their idle times with `/msg NickServ sessions` (operators can use `/msg NickServ sessions nickname` to see another user's sessions).
## History ## History
Oragono can store a limited amount of message history in memory and replay it, which is useful for covering brief disconnections from IRC. You can access this history using the `/HISTORY` command (depending on your client, you may need to use `/QUOTE history` instead), for example `/history #mychannel 100` to get the 100 latest messages. Oragono can store a limited amount of message history in memory and replay it, which is useful for covering brief disconnections from IRC. You can access this using the `/HISTORY` command (depending on your client, you may need to use `/QUOTE history` instead), for example `/HISTORY #mychannel 100` to get the 100 latest messages from `#mychannel`.
Server administrators can configure `history.autoreplay-on-join` to automatically send clients a fixed number of history lines when they join a channel. Users can use `/msg NickServ set autoreplay-lines` to opt in or out of this behavior. Server administrators can configure `history.autoreplay-on-join` to automatically send clients a fixed number of history lines when they join a channel. Users can use `/msg NickServ set autoreplay-lines` to opt in or out of this behavior.
We are working on a number of improvements to this functionality: We are working on a number of improvements to this functionality:
* We currently emulate the ZNC playback module for clients that have special ZNC support (see the "ZNC" section below) * We currently emulate the ZNC playback module for clients that have special ZNC support (see the "ZNC" section below)
* [CHATHISTORY](https://github.com/ircv3/ircv3-specifications/pull/349) will be a standardized way for clients to request history lines * The [`/CHATHISTORY`](https://github.com/ircv3/ircv3-specifications/pull/349) command will be a standardized way for clients to request history lines
* [RESUME](https://github.com/ircv3/ircv3-specifications/pull/306), which we support in draft form, automatically replays history lines to clients who return after a brief disconnection * [Connection resuming](https://github.com/ircv3/ircv3-specifications/pull/306), which we support in draft form, automatically replays history lines to clients who return after a brief disconnection
## IP cloaking ## IP cloaking
@ -702,7 +700,7 @@ Instructions on how client software should connect to an .onion address are outs
## ZNC ## ZNC
ZNC 1.6.x has a [bug](https://github.com/znc/znc/issues/1212) where it fails to recognize certain SASL messages. Oragono 1.1.0 and later support a compatibility mode that enables ZNC to complete the SASL handshake: this can be enabled with `server.compatibility.send-unprefixed-sasl`. ZNC 1.6.x (still pretty common in distros that package old versions of IRC software) has a [bug](https://github.com/znc/znc/issues/1212) where it fails to recognize certain SASL messages. Oragono supports a compatibility mode that works around this to let ZNC complete the SASL handshake: this can be enabled with `server.compatibility.send-unprefixed-sasl`.
Oragono can emulate certain capabilities of the ZNC bouncer for the benefit of clients, in particular the third-party [playback](https://wiki.znc.in/Playback) module. This enables clients with specific support for ZNC to receive selective history playback automatically. To configure this in [Textual](https://www.codeux.com/textual/), go to "Server properties", select "Vendor specific", uncheck "Do not automatically join channels on connect", and check "Only play back messages you missed". Other clients with support are listed on ZNC's wiki page. Oragono can emulate certain capabilities of the ZNC bouncer for the benefit of clients, in particular the third-party [playback](https://wiki.znc.in/Playback) module. This enables clients with specific support for ZNC to receive selective history playback automatically. To configure this in [Textual](https://www.codeux.com/textual/), go to "Server properties", select "Vendor specific", uncheck "Do not automatically join channels on connect", and check "Only play back messages you missed". Other clients with support are listed on ZNC's wiki page.
@ -716,4 +714,4 @@ Always, thanks to Jeremy Latt for creating Ergonomadic. Thanks for Edmund Huber
Thanks to Euan Kemp (euank) for the contributions and help with this, along with other projects, and to James Mills, Vegax and Sean Enck for various other help and contributions on the server. Thanks to Euan Kemp (euank) for the contributions and help with this, along with other projects, and to James Mills, Vegax and Sean Enck for various other help and contributions on the server.
And a massive thanks to Shivaram Lingamneni (slingamn) for being an awesome co-maintainer of Oragono! You really convinced me to step up with this and take it forward in a big way, and I'm grateful for that. And a massive thanks to Shivaram Lingamneni (slingamn) for being an amazing co-maintainer of Oragono! You've contributed a lot to Oragono, and really convinced me to step up with this and take the server forward in a big way. I'm grateful for everything you've done, and working with ya' is a pleasure.