nostr/strfry
1
0
Fork 0
mirror of https://github.com/hoytech/strfry.git synced 2025-06-18 01:08:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

only attempt to monitor the modification time of a plugin if the command does not contain spaces

Browse Source
This commit is contained in:
Doug Hoyte
2023-09-08 17:57:08 -04:00
parent b2a128d2f3
commit 7da862eb91
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/plugins.md
View File

@ -1,6 +1,6 @@
# Write policy plugins
# Event-sifter plugins
In order to reduce complexity, strfry's design attempts to keep policy logic out of its core relay functionality. Instead, this logic can be implemented by operators by installing a write policy plugin. Among other things, plugins can be used for the following:
In order to reduce complexity, strfry's design attempts to keep policy logic out of its core relay functionality. Instead, this logic can be implemented by operators by installing policy plugins to decide which events to store. Among other things, plugins can be used for the following:
* White/black-lists (particular pubkeys can/can't post events)
* Rate-limits
@ -8,7 +8,9 @@ In order to reduce complexity, strfry's design attempts to keep policy logic out
A plugin can be implemented in any programming language that supports reading lines from stdin, decoding JSON, and printing JSON to stdout. If a plugin is installed, strfry will send the event (along with some other information like IP address) to the plugin over stdin. The plugin should then decide what to do with it and print out a JSON object containing this decision.
Whenever the script's modification-time changes, or the plugin settings in `strfry.conf` change, the plugin will be reloaded upon the next write attempt.
The plugin command can be any shell command, which lets you set environment variables, command-line switches, etc. If the plugin command contains no spaces, it is assumed to be a path to a script. In this case, whenever the script's modification-time changes, the plugin will be reloaded upon the next write attempt.
If the plugin's command in `strfry.conf` (or a router config file) change, then the plugin will also be reloaded.
## Input messages