Merge pull request #401 from oragono/rc1

documentation and other changes for rc1

CHANGELOG.md

@@ -4,12 +4,15 @@ 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.
 
 
-## [0.13.0-rc]
-This release has a wide range of improvements and new features. Highlights include:
-* Support for storing and replaying message history, via various protocol extensions: the `draft/resume-0.2` capability, the `CHATHISTORY` command, and a custom `HISTORY` command
-* Confusables prevention for Unicode nicknames and account names
-* User-customizable nickname protection schemes
-* A SASL-only mode in which all clients must authenticate with SASL
+## [1.0.0-rc] - 2019-02-18
+Our v1.0.0 is finally here! Well, almost. The final v1.0.0 should be released in a week or two, after our last bits of testing is complete and the documentation has been double and triple-checked. This version rounds out most of our need-to-haves, and leaves us with a bunch of nice-to-haves that we'll be looking at going forward. Thanks to all of our amazing translators and contributors for the work they've done this release (we'll have a proper thanks section when v1.0.0 drops).
+
+Highlights include:
+
+* Support for storing and replaying message history with: the [`draft/resume-0.3` capability](https://github.com/ircv3/ircv3-specifications/pull/306), the `CHATHISTORY` command, and a custom `HISTORY` command.
+* Better detection of confusing nick/account/channel names.
+* User-customizable nickname protection methods.
+* An account-only mode in which all clients must have an account and login to it (using SASL) before they can join the server.
 
 ### Config Changes
 * `allow-custom-enforcement` key added under `accounts`.
@@ -20,14 +23,17 @@ This release has a wide range of improvements and new features. Highlights inclu
 * `method` key now under `accounts` now allows the value `"optional"`.
 * Logging type `server` has been added, replacing the `startup`, `rehash`, and `shutdown` types.
 * We no longer listen on port `6668` by default (this fixes Docker installs).
-* The default logging configuration now logs to stderr only, rather than to both stderr and a file
+* The default logging configuration now logs to stderr only, rather than to both stderr and a file.
+* `max-channels-per-client` key added under `channels` (limiting the number of channels that can be joined).
+* `max-channels-per-account` key added under `channels.registration` (limiting the number of channels that can be registered).
+* Exemption lists now accept `localhost` as a value, meaning any loopback IPV4, loopback IPV6, or unix domain address.
 
 ### Security
-* Added a SASL-only mode in which all clients must authenticate with SASL
-* Added login throttling as a hardening measure against password guessing
+* Added a SASL-only mode in which all clients must authenticate with SASL.
+* Added login throttling as a hardening measure against password guessing.
+* Configurable limits are imposed on how many channels clients can join or register.
 
 ### Added
-* `oragono genpasswd` now works when piping input in (fixes Docker installs).
 * Added automagic datastore creation on `oragono run`.
 * Added limited message history for connection resuming (to be extended in future).
 * Added new Español (es) translation (thanks to Mauropek!)).
@@ -38,8 +44,9 @@ This release has a wide range of improvements and new features. Highlights inclu
 * Added new subcommands to `NICKSERV`, including:
     * `PASSWD` to change account passwords.
     * `ENFORCE` to set a specific enforcement mechanism on your nick.
-    * `SAREGISTER` to allow operators to manually create new user accounts
+    * `SAREGISTER` to allow operators to manually create new user accounts.
 * Added Unicode confusable detection and prevention when changing nicknames and registering accounts.
+* Added proposed IRCv3 capability [`draft/setname`](https://github.com/ircv3/ircv3-specifications/pull/361).
 
 ### Changed
 * `SASL PLAIN` logins now log more correctly.
@@ -48,8 +55,10 @@ This release has a wide range of improvements and new features. Highlights inclu
 * In addition to the founder, now auto-ops (halfop and higher) automatically bypass channel join restrictions.
 * Log lines now display time down to milliseconds, instead of just seconds.
 * Updated all translation files (thanks to our amazing translators!).
-* Updated proposed IRCv3 capability to version [`draft/resume-0.2`](https://github.com/ircv3/ircv3-specifications/pull/306).
+* Updated proposed IRCv3 capability to version [`draft/resume-0.3`](https://github.com/ircv3/ircv3-specifications/pull/306).
 * When nick ownership is enabled, users can now select which enforcement mechanism to use with their nickname.
+* Improved compatibility with ZNC's nickserv module.
+* Halfops can now kick unprivileged users.
 
 ### Removed
 
@@ -67,14 +76,17 @@ This release has a wide range of improvements and new features. Highlights inclu
 * Prevent logging in multiple times when using `/NS IDENTIFY`.
 * Prevented the db handler from automagically creating the database without initializing it (thanks @enckse!). We also now automatically create the datastore on `run`.
 * Updated internal command line parsing (thanks @iNecas!).
-* Fixed handling of CIDR width in connection limiting/throttling
+* `oragono genpasswd` now works when piping input in (fixes Docker installs).
+* Fixed handling of CIDR width in connection limiting/throttling.
+* Fixed many responses that violated the specifications (thanks to Ascrod, bogdomania, csmith, jesopo, jwheare).
+* Fixed incorrect behavior of `CHANSERV OP` command.
 
 ### Internal Notes
 * `DLINE` and `KLINE` refactored, and expired bans are now removed from the database.
 * Logging system optimised.
 * Services handlers refactored.
 * Translations are now sent to/PR'd from CrowdIn automagically as we develop the software.
-* Direct responses to client commands are now sent "synchronously", bypassing the sendq
+* Direct responses to client commands are now sent "synchronously", bypassing the sendq.
 
 
 ## [0.12.0] - 2018-10-15

Gopkg.toml

@@ -31,7 +31,7 @@
 
 [[constraint]]
   name = "github.com/docopt/docopt-go"
-  version = "0.6.2"
+  branch = "master"
 
 [[constraint]]
   branch = "master"

docs/MANUAL.md

@@ -590,6 +590,11 @@ connregex = ".+-.+CONNECT.+-.+ Client Connected \\[([^ ]+)\\] \\[u:([^ ]+)\\] \\
 kline = "DLINE ANDKILL 2h %i :Open proxy found on your host.";
 ````
 
+## ZNC
+
+Versions of ZNC prior to 1.7 have a [bug](https://github.com/znc/znc/issues/1212) in their SASL implementation that renders them incompatible with Oragono. However, you should be able to authenticate from ZNC using its [nickserv](https://wiki.znc.in/Nickserv) module.
+
+
 --------------------------------------------------------------------------------------------
 
 

irc/constants.go

@@ -9,7 +9,7 @@ import "fmt"
 
 const (
 	// SemVer is the semantic version of Oragono.
-	SemVer = "0.13.0-unreleased"
+	SemVer = "1.0.0-rc1"
 )
 
 var (