Browse Source

Merge pull request #1489 from slingamn/documentation_stopgap

stopgap documentation update for SASL
tags/v2.5.0-rc1
Shivaram Lingamneni 3 years ago
parent
commit
8769e2d92a
No account linked to committer's email address
2 changed files with 9 additions and 6 deletions
  1. 7
    6
      README.md
  2. 2
    0
      docs/MANUAL.md

+ 7
- 6
README.md View File

@@ -103,15 +103,16 @@ oragono genpasswd
103 103
 
104 104
 With this, you receive a blob of text which you can plug into your configuration file.
105 105
 
106
-### How to register a channel
106
+### Nickname and channel registration
107 107
 
108
-1. Register your account with `/NS REGISTER <password>`
109
-2. Join the channel with `/join #channel`
110
-3. Register the channel with `/CS REGISTER #channel`
108
+Oragono relies heavily on user accounts to enable its distinctive features (such as allowing multiple clients per nickname). As a user, you can register your current nickname as an account using `/msg NickServ register <password>`. Once you have done so, you should [enable SASL in your clients](https://freenode.net/kb/answer/sasl), ensuring that you will be automatically logged into your account on each connection. This will prevent [problems claiming your registered nickname](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#nick-equals-account).
111 109
 
112
-After this, your channel will remember the fact that you're the owner, the topic, and any modes set on it!
110
+Once you have registered your nickname, you can use it to register channels:
111
+
112
+1. Join the channel with `/join #channel`
113
+2. Register the channel with `/CS REGISTER #channel`
113 114
 
114
-Make sure to setup [SASL](https://freenode.net/kb/answer/sasl) in your client to automatically login to your account when you next join the server.
115
+After this, your channel will remember the fact that you're the owner, the topic, and any modes set on it!
115 116
 
116 117
 
117 118
 # Credits

+ 2
- 0
docs/MANUAL.md View File

@@ -261,6 +261,8 @@ In this mode (the default), registering an account gives you privileges over the
261 261
 1. You must use your nickname, i.e., if you are logged into your account, then the server will require you to use your account name as your nickname
262 262
 1. If you unregister your account, your nickname will be permanently unreclaimable (thus preventing people from impersonating you)
263 263
 
264
+In this mode, it is very important that end users authenticate to their accounts as part of the initial IRC handshake (traditionally referred to as "connection registration"); otherwise they will not be able to use their registered nicknames. The preferred mechanism for this is [SASL](https://freenode.net/kb/answer/sasl), which is supported by most modern clients. As a fallback, this can also be done via the `PASS` (server password) command; set the "server password" field of the client to `AzureDiamond:hunter2`, where `AzureDiamond` is the account name and `hunter2` is the account password.
265
+
264 266
 As an end user, if you want to change your nickname, you can register a new account and transfer any channel ownerships to it using `/msg ChanServ transfer`.
265 267
 
266 268
 To enable this mode as the server operator, set the following configs (note that they are already set in `default.yaml`):

Loading…
Cancel
Save