diff options
| author |  Christian Hesse <mail@eworm.de> | 2022-02-22 22:31:49 +0100 |
|---|---|---|
| committer | Christian Hesse <mail@eworm.de> | 2022-02-22 22:32:46 +0100 |
| commit | 3f6b5595f39044cf26700b2ac9a88dde5fa4b8ac (patch) | |
| tree | 602f32993361b21e46dbf234ff41b29021225ada | |
| parent | 82d45eca088d6fd42f3d8c6a667a7d7517878d63 (diff) | |
doc/mod/scriptrunonce: document optional configuration
(cherry picked from commit d50f6ffb79c448b8ffef246a0e7ef90d51c8dadb)
| -rw-r--r-- | doc/mod/scriptrunonce.md | 15 |
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 |