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

Merge pull request #1489 from slingamn/documentation_stopgap

Browse Source 
stopgap documentation update for SASL
This commit is contained in:
Shivaram Lingamneni 2021-01-18 06:21:10 -05:00 committed by GitHub
commit 8769e2d92a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -103,16 +103,17 @@ oragono genpasswd
With this, you receive a blob of text which you can plug into your configuration file. With this, you receive a blob of text which you can plug into your configuration file.
### How to register a channel ### Nickname and channel registration
1. Register your account with `/NS REGISTER <password>` 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).
2. Join the channel with `/join #channel`
3. Register the channel with `/CS REGISTER #channel` Once you have registered your nickname, you can use it to register channels:
1. Join the channel with `/join #channel`
2. Register the channel with `/CS REGISTER #channel`
After this, your channel will remember the fact that you're the owner, the topic, and any modes set on it! After this, your channel will remember the fact that you're the owner, the topic, and any modes set on it!
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.
# Credits # Credits

2
docs/MANUAL.md
View File

@ -261,6 +261,8 @@ In this mode (the default), registering an account gives you privileges over the
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 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
1. If you unregister your account, your nickname will be permanently unreclaimable (thus preventing people from impersonating you) 1. If you unregister your account, your nickname will be permanently unreclaimable (thus preventing people from impersonating you)
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.
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`. 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`.
To enable this mode as the server operator, set the following configs (note that they are already set in `default.yaml`): To enable this mode as the server operator, set the following configs (note that they are already set in `default.yaml`):