Browse Source

clean up and clarify example operator blocks

See #1426
tags/v2.5.0-rc1
Shivaram Lingamneni 3 years ago
parent
commit
c8d999c95f
2 changed files with 28 additions and 42 deletions
  1. 14
    21
      default.yaml
  2. 14
    21
      traditional.yaml

+ 14
- 21
default.yaml View File

576
 
576
 
577
 # operator classes
577
 # operator classes
578
 oper-classes:
578
 oper-classes:
579
-    # local operator
580
-    "local-oper":
579
+    # IRC operator: can ban and unban users from the server
580
+    "irc-oper":
581
         # title shown in WHOIS
581
         # title shown in WHOIS
582
-        title: Local Operator
582
+        title: IRC Operator
583
 
583
 
584
         # capability names
584
         # capability names
585
         capabilities:
585
         capabilities:
590
             - "roleplay"
590
             - "roleplay"
591
             - "relaymsg"
591
             - "relaymsg"
592
 
592
 
593
-    # network operator
594
-    "network-oper":
595
-        # title shown in WHOIS
596
-        title: Network Operator
597
-
598
-        # oper class this extends from
599
-        extends: "local-oper"
600
-
601
-        # capability names
602
-        capabilities:
603
-            - "remote_kill"
604
-            - "remote_ban"
605
-            - "remote_unban"
606
-
607
-    # server admin
593
+    # server admin: has full control of application-level privileges, including
594
+    # nickname and channel registrations
608
     "server-admin":
595
     "server-admin":
609
         # title shown in WHOIS
596
         # title shown in WHOIS
610
         title: Server Admin
597
         title: Server Admin
611
 
598
 
612
         # oper class this extends from
599
         # oper class this extends from
613
-        extends: "local-oper"
600
+        extends: "irc-oper"
614
 
601
 
615
         # capability names
602
         # capability names
616
         capabilities:
603
         capabilities:
617
             - "rehash"
604
             - "rehash"
618
-            - "die"
619
             - "accreg"
605
             - "accreg"
620
             - "sajoin"
606
             - "sajoin"
621
             - "samode"
607
             - "samode"
626
 
612
 
627
 # ircd operators
613
 # ircd operators
628
 opers:
614
 opers:
629
-    # operator named 'admin'; log in with /OPER admin [password]
615
+    # default operator named 'admin'; log in with /OPER admin <password>
630
     admin:
616
     admin:
631
         # which capabilities this oper has access to
617
         # which capabilities this oper has access to
632
         class: "server-admin"
618
         class: "server-admin"
661
         # granted automatically as soon as you connect with the right fingerprint.
647
         # granted automatically as soon as you connect with the right fingerprint.
662
         #auto: true
648
         #auto: true
663
 
649
 
650
+    # example of a second, less privileged operator named 'alice'
651
+    # (log in with /OPER alice <password>):
652
+    #alice:
653
+    #    class: "irc-oper"
654
+    #    whois-line: "can help with moderation issues"
655
+    #    password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
656
+
664
 # logging, takes inspiration from Insp
657
 # logging, takes inspiration from Insp
665
 logging:
658
 logging:
666
     -
659
     -

+ 14
- 21
traditional.yaml View File

548
 
548
 
549
 # operator classes
549
 # operator classes
550
 oper-classes:
550
 oper-classes:
551
-    # local operator
552
-    "local-oper":
551
+    # IRC operator: can ban and unban users from the server
552
+    "irc-oper":
553
         # title shown in WHOIS
553
         # title shown in WHOIS
554
-        title: Local Operator
554
+        title: IRC Operator
555
 
555
 
556
         # capability names
556
         # capability names
557
         capabilities:
557
         capabilities:
562
             - "roleplay"
562
             - "roleplay"
563
             - "relaymsg"
563
             - "relaymsg"
564
 
564
 
565
-    # network operator
566
-    "network-oper":
567
-        # title shown in WHOIS
568
-        title: Network Operator
569
-
570
-        # oper class this extends from
571
-        extends: "local-oper"
572
-
573
-        # capability names
574
-        capabilities:
575
-            - "remote_kill"
576
-            - "remote_ban"
577
-            - "remote_unban"
578
-
579
-    # server admin
565
+    # server admin: has full control of application-level privileges, including
566
+    # nickname and channel registrations
580
     "server-admin":
567
     "server-admin":
581
         # title shown in WHOIS
568
         # title shown in WHOIS
582
         title: Server Admin
569
         title: Server Admin
583
 
570
 
584
         # oper class this extends from
571
         # oper class this extends from
585
-        extends: "local-oper"
572
+        extends: "irc-oper"
586
 
573
 
587
         # capability names
574
         # capability names
588
         capabilities:
575
         capabilities:
589
             - "rehash"
576
             - "rehash"
590
-            - "die"
591
             - "accreg"
577
             - "accreg"
592
             - "sajoin"
578
             - "sajoin"
593
             - "samode"
579
             - "samode"
598
 
584
 
599
 # ircd operators
585
 # ircd operators
600
 opers:
586
 opers:
601
-    # operator named 'admin'; log in with /OPER admin [password]
587
+    # default operator named 'admin'; log in with /OPER admin <password>
602
     admin:
588
     admin:
603
         # which capabilities this oper has access to
589
         # which capabilities this oper has access to
604
         class: "server-admin"
590
         class: "server-admin"
633
         # granted automatically as soon as you connect with the right fingerprint.
619
         # granted automatically as soon as you connect with the right fingerprint.
634
         #auto: true
620
         #auto: true
635
 
621
 
622
+    # example of a second, less privileged operator named 'alice'
623
+    # (log in with /OPER alice <password>):
624
+    #alice:
625
+    #    class: "irc-oper"
626
+    #    whois-line: "can help with moderation issues"
627
+    #    password: "$2a$04$0123456789abcdef0123456789abcdef0123456789abcdef01234"
628
+
636
 # logging, takes inspiration from Insp
629
 # logging, takes inspiration from Insp
637
 logging:
630
 logging:
638
     -
631
     -

Loading…
Cancel
Save