aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod/scriptrunonce.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-02-22 22:31:49 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-22 22:31:49 +0100
commitd50f6ffb79c448b8ffef246a0e7ef90d51c8dadb (patch)
tree10da76ce2a719326b1b4cdbaf8e3a2573dbc7ed1 /doc/mod/scriptrunonce.md
parent8e401bf498065814442c4c39e2fcc949f73bfc3b (diff)
doc/mod/scriptrunonce: document optional configuration
Diffstat (limited to 'doc/mod/scriptrunonce.md')
-rw-r--r--doc/mod/scriptrunonce.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/mod/scriptrunonce.md b/doc/mod/scriptrunonce.md
index 190ed03..aaa64a9 100644
--- a/doc/mod/scriptrunonce.md
+++ b/doc/mod/scriptrunonce.md
@@ -19,10 +19,23 @@ Just install the module:
$ScriptInstallUpdate mod/scriptrunonce;
+Configuration
+-------------
+
+The optional configuration goes to `global-config-overlay`.
+
+* `ScriptRunOnceBaseUrl`: base url, prepended to parameter
+* `ScriptRunOnceUrlSuffix`: url suffix, appended to parameter
+
+If the parameter passed to the function is not a complete URL (starting
+with protocol `ftp://`, `http://`, `https://` or `sftp://`) the values are
+prepended and appended.
+
Usage and invocation
--------------------
-The function `$ScriptRunOnce` expects an url pointing to a script as parameter.
+The function `$ScriptRunOnce` expects an URL (or name if
+`ScriptRunOnceBaseUrl` is given) pointing to a script as parameter.
$ScriptRunOnce https://git.eworm.de/cgit/routeros-scripts/plain/doc/mod/scriptrunonce.d/hello-world.rsc