GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-24 11:42:51 +01:00
Code Issues Projects Releases Wiki Activity

Quick refresh of exttarget docs

Browse Source 
- Mention that the $pylinkirc: prefix is implied as of 2.0
- Link to the exttargets reference in example-conf
- docs/exttargets: wording tweaks for the lead section
This commit is contained in:
James Lu 2018-07-14 21:06:56 -07:00
parent d844ff5186
commit f1ce8351b9
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/exttargets.md
View File

@ -1,8 +1,8 @@
# Exttargets Guide
In PyLink, **extended targets** or **exttargets** *replace* regular hostmasks with conditional matching based on specific situations. PyLink exttargets are supported by most plugins in the place of `nick!user@host` masks (provided they use the `IRCNetwork.match_host()` API with a user object).
**Extended targets** or **exttargets** extend regular hostmask matching by checking users against specific conditions. PyLink exttargets are supported by most plugins in the place of `nick!user@host` masks (provided they use `IRCNetwork.match_host()` as their backend).
Exttargets were introduced in PyLink 0.9 alongside [Automode](automode.md), with the goal of making user/ACL matching more versatile. As of PyLink 2.0-dev, the following exttargets are supported:
Exttargets were introduced in PyLink 0.9 alongside [Automode](automode.md), with the goal of making user/ACL matching more versatile. As of PyLink 2.0, the following exttargets are supported:
### The "$account" target (PyLink 0.9+)
Used to match users by their services account.
@ -55,7 +55,7 @@ Used to match users on specific IRC servers.
- `$server:1XY` -> Returns True if the target's is connected on the server with the given SID. Note: SIDs ARE case sensitive.
### The "$pylinkacc" target (PyLink 0.9+)
Used to match users logged in to *PyLink* (i.e. via the `identify` command).
Used to match users logged in to *PyLink* (i.e. via the `identify` command). **As of PyLink 2.0, The "$pylinkirc:" prefix is implied if you specify a PyLink account name without it.**
- `$pylinkacc` -> Returns True if the target is logged in to PyLink.
- `$pylinkacc:accountname` -> Returns True if the target's PyLink login matches the one given (case insensitive).

8
example-conf.yml
View File

@ -106,7 +106,8 @@ login:
permissions:
# Permissions blocks in PyLink are define as a mapping of PyLink targets (i.e. hostmasks or
# exttargets) to lists of permission nodes. You can find a list of permissions that PyLink and
# its plugins define in docs/permissions-reference.md.
# its plugins define in docs/permissions-reference.md. Exttargets (extended targets) are
# documented further in docs/exttargets.md
# Permissions blocks look something like this:
#"*!user@host":
@ -114,8 +115,9 @@ permissions:
# - "permission.node.2"
# - "someplugin.*" # Wildcards are also supported in names
# Replace ABC123 with your PyLink account name (configured above)
# in order to give yourself admin access.
# Replace ABC123 with your PyLink account name (configured above in order to give yourself admin
# access. As of PyLink 2.0, specifying a bare account name is synonymous with
# "$pylinkirc:<accountname>" (i.e. the "$pylinkirc:" prefix is implied).
"ABC123":
- "*"