Selaa lähdekoodia

update manual

tags/v2.1.0-rc1
Shivaram Lingamneni 4 vuotta sitten
vanhempi
commit
1653d4cf08
1 muutettua tiedostoa jossa 15 lisäystä ja 6 poistoa
  1. 15
    6
      docs/MANUAL.md

+ 15
- 6
docs/MANUAL.md Näytä tiedosto

@@ -206,7 +206,7 @@ To enable this mode, set the following configs:
206 206
 The following additional configs may be of interest:
207 207
 
208 208
 * `accounts.nick-reservation.method = strict` ; we currently recommend strict nickname enforcement as the default, since we've found that users find it less confusing.
209
-* `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`.
209
+* `accounts.nick-reservation.force-nick-equals-account = true` ; this allows nicknames to be treated as account names for most purposes, including for controlling access to channels (see the discussion of private channels below)
210 210
 
211 211
 ### SASL-only mode
212 212
 
@@ -221,9 +221,10 @@ To enable this mode, set the following configs:
221 221
 * `accounts.require-sasl.enabled = true`
222 222
 * `accounts.nick-reservation.enabled = true`
223 223
 
224
-Additionally, the following config is recommended:
224
+Additionally, the following configs are recommended:
225 225
 
226 226
 * `accounts.nick-reservation.method = strict`
227
+* `accounts.nick-reservation.force-nick-equals-account = true`
227 228
 
228 229
 
229 230
 ## Channel Registration
@@ -346,13 +347,21 @@ Otherwise, in the Oragono config file, you'll want to enable raw line logging by
346 347
 
347 348
 ## How do I make a private channel?
348 349
 
349
-More complete support for account-based private channels is [planned](https://github.com/oragono/oragono/issues/69). In the meantime, here's a workaround:
350
+We recommend that server administrators set the following recommended defaults:
350 351
 
351
-1. Register your channel (`/msg ChanServ register #example`)
352
+1. `nick-reservation-method: strict`
353
+1. `force-nick-equals-account: true`
354
+
355
+These settings imply that any registered account name can be treated as synonymous with a nickname; anyone using the nickname is necessarily logged into the account, and anyone logged intot he account is necessarily using the nickname.
356
+
357
+Under these circumstances, users can follow the following steps:
358
+
359
+1. Register a channel (`/msg ChanServ register #example`)
352 360
 1. Set it to be invite-only (`/mode #example +i`)
353
-1. Grant persistent half-operator status to the desired account names (`/msg ChanServ amode #example +h alice`)
361
+1. Add the desired nick/account names to the invite exception list (`/mode #example +I alice`)
362
+1. Anyone with persistent half-operator status or higher will also be able to join without an invite (`/msg ChanServ amode #example +h alice`)
354 363
 
355
-Anyone with persistent half-operator privileges or higher will be able to join without an invite.
364
+Similarly, for a public channel (one without `+i`), users can ban nick/account names with `/mode #example +b bob`. (To restrict the channel to users with valid accounts, set it to registered-only with `/mode #example +R`.)
356 365
 
357 366
 -------------------------------------------------------------------------------------------
358 367
 

Loading…
Peruuta
Tallenna