changelog and documentation updates for 1.1.0rc1

CHANGELOG.md

@@ -3,6 +3,84 @@ All notable changes to Oragono will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/). For the purposes of versioning, we consider the "public API" to refer to the configuration files, CLI interface and database format.
 
+## [1.1.0-rc1] - 2019-06-03
+We have a number of exciting improvements in 1.1.0:
+
+Highlights include:
+
+* Support for attaching multiple clients to the same nickname
+* Support for running Oragono as a Tor hidden service
+* Support for IP cloaking
+* Simplified commands for registering new accounts with NickServ
+
+### Config changes
+* `tor-listeners` section added, for configuring listeners for use by Tor
+* `compatibility` section added for toggling compatibility behaviors for legacy clients
+* `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)
+* `check-ident` now has recommended value `false`
+* `nick-reservation.method` now has recommended value `strict`
+* `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)
+
+### Security
+* Eliminated the possibility of using confusable Unicode characters to impersonate network services like NickServ (#519, thanks [@csmith](https://github.com/csmith)!)
+* Improved privacy properties of secret (mode `+s`) channels (#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)!)
+* Limited the total length of the registration sequence (handshake) to mitigate potential DoS attacks (#505)
+
+### Fixed
+* 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)
+* More consistent handling of channel privileges, in particular halfop (#400)
+* More consistent assignment of message IDs and timestamps to messages (#388, #477, #483)
+* Client-only tags are now stored for replay (#437)
+* Fixed various error numerics with incorrect parameters (#425, thanks [@Ascrod](https://github.com/Ascrod)!)
+* Fixed bugs in how the `RENAME` command worked with legacy clients (#300, thanks [@jesopo](https://github.com/jesopo)!)
+* Fixed a bug where clients could receive tags they hadn't enabled (#434)
+* History playback is batched when applicable (#456, thanks [@transitracer](https://github.com/oragono/oragono/issues/456)!)
+* Improved display of notices from NickServ etc. in some clients (#496, thanks [@jwheare](https://github.com/jwheare))
+* Fixed nickname timer warnings not displaying correctly under some circumstances (#449, thanks [@bogdomania](https://github.com/bogdomania)!)
+* Fixed confusing output from `/HISTORY` when history is disabled (#429, thanks [@bogdomania](https://github.com/bogdomania)!)
+* Fixed confusing output from `/HOSTSERV ON` when no vhost is available (#404, thanks [@bogdomania](https://github.com/bogdomania)!)
+* Fixed confusing snomask from `/SANICK` command (#360, thanks [@bogdomania](https://github.com/bogdomania)!)
+
+### Added
+* Support for attaching multiple clients to the same nickname (see the manual for details) (#403)
+* Support for running Oragono as a Tor hidden service (see the manual for details) (#369)
+* Support for IP cloaking (see the manual for details) (#108)
+* Support for `znc.in/playback`, which can automate history playback on rejoin for clients that support it (#486)
+* 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)
+* TAGMSG and NICK are now replayable (#457)
+* Added the [SETNAME](https://github.com/ircv3/ircv3-specifications/pull/361) command for changing the user's realname (#372)
+
+### 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)
+* 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`
+* Support for 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)
+* 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`
+* 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)
+* History buffers and replay now include private messages you sent as well as received (#487)
+* Removed the `+a` away mode (#468, thanks [@jesopo](https://github.com/jesopo) and [@jwheare](https://github.com/jwheare)!)
+* Attempting to reauthenticate with SASL while already authenticated now returns an error
+* `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
+* `WHOIS` responses no longer include the `690 RPL_WHOISLANGUAGE` numeric (#516)
+* `ISON` responses are now sent for services (#488)
+* 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)
+
+### Internal Notes
+* Improved build scripts (#409)
+* Official builds now use Go 1.12 (#406)
+* Minor improvements to the performance of the message building and parsing code (#387)
+* Added `oragono.io/nope` capability as a way of encouraging clients to request capabilities safely (#511)
+* Fixed latent portability issues with 32-bit architectures (#527)
+
 
 ## [1.0.0] - 2019-02-24
 We've finally made it to v1.0.0! With this release, our list of need-to-haves is rounded out, and we reckon the software's ready for production use in smaller networks. slingamn and I have been working with our contributors and translators to prepare a cracker of a release. Thanks to [@csmith](https://github.com/csmith) our [Docker builds](https://hub.docker.com/r/oragono/oragono/) have been updated, with automatic rebuilds as we develop the software. Thanks to [@bogdomania](https://github.com/bogdomania) our translation workflow has been improved a lot.

README.md

@@ -22,15 +22,17 @@ Oragono is a fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomad
 * UTF-8 nick and channel names with rfc7613 (PRECIS)
 * [yaml](http://yaml.org/) configuration
 * native TLS/SSL support
-* server password (`PASS` command)
+* on-the-fly updating server config and TLS certificates (rehashing)
+* client accounts and SASL
+* 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
+* 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)
 * an extensible privilege system for IRC operators
 * ident lookups for usernames
 * automated client connection limits
-* on-the-fly updating server config and TLS certificates (rehashing)
-* client accounts and SASL
-* passwords stored with [bcrypt](https://godoc.org/golang.org/x/crypto) (client account passwords also salted)
+* passwords stored with [bcrypt](https://godoc.org/golang.org/x/crypto)
 * banning ips/nets and masks with `KLINE` and `DLINE`
-* supports [multiple languages](https://crowdin.com/project/oragono) (you can also set a default language for your network)
 * [IRCv3 support](http://ircv3.net/software/servers.html)
 * a heavy focus on developing with [specifications](https://oragono.io/specs.html)
 

docs/MANUAL.md

@@ -18,6 +18,7 @@ _Copyright © 2018 Daniel Oaks <daniel@danieloaks.net>_
 
 - Introduction
     - Project Basics
+    - Scalability
 - Installing
     - Windows
     - macOS / Linux / Raspberry Pi
@@ -26,6 +27,8 @@ _Copyright © 2018 Daniel Oaks <daniel@danieloaks.net>_
         - Nickname reservation
     - Channel Registration
     - Language
+    - Bouncer
+    - History
     - IP cloaking
 - Frequently Asked Questions
 - Modes
@@ -53,7 +56,7 @@ If you have any suggestions, issues or questions, feel free to submit an issue o
 
 Let's go over some basics, for those new to Oragono. My name's Daniel, and I started the project (it was forked off a server called [Ergonomadic](https://github.com/edmund-huber/ergonomadic) that'd been around for a number of years). In addition to Oragono, I also do a lot of IRC specification work with the [various](https://modern.ircdocs.horse) [ircdocs](https://defs.ircdocs.horse) [projects](https://ircdocs.horse/specs/) and with the [IRCv3 Working Group](https://ircv3.net/).
 
-Oragono's a new IRC server, written from scratch. My main goals when starting the project was to write a server that:
+My main goals when starting the project were to write a server that:
 
 - Is fully-functional.
 - I can use to very easily prototype new [IRCv3](https://ircv3.net/) proposals and features.
@@ -68,6 +71,17 @@ Some of the features that sets Oragono apart from other servers are:
 - Integrated user account and channel registration system (no services required!).
 - Native Unicode support (including appropriate casemapping).
 - Support for [multiple languages](https://crowdin.com/project/oragono).
+- 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!
+
+## 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".
+
+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.
+
+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!
 
 
 --------------------------------------------------------------------------------------------
@@ -243,6 +257,28 @@ The above will change the server language to Romanian, with a fallback to Chines
 Our language and translation functionality is very early, so feel free to let us know if there are any troubles with it! If you know another language and you'd like to contribute, we've got a CrowdIn project here: [https://crowdin.com/project/oragono](https://crowdin.com/project/oragono)
 
 
+## 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.
+
+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`.
+
+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).
+
+
+## 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.
+
+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 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
+* [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
+
+
 ## IP cloaking
 
 Unlike many other chat and web platforms, IRC traditionally exposes the user's IP and hostname information to other users. This is in part because channel owners and operators (who have privileges over a single channel, but not over the server as a whole) need to be able to ban spammers and abusers from their channels, including via hostnames in cases where the abuser tries to evade the ban.
@@ -648,6 +684,13 @@ Instructions on how client software should connect to an .onion address are outs
 1. Pidgin should work with [torsocks](https://trac.torproject.org/projects/tor/wiki/doc/torsocks).
 
 
+## 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`.
+
+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.
+
+
 --------------------------------------------------------------------------------------------