From d50f6ffb79c448b8ffef246a0e7ef90d51c8dadb Mon Sep 17 00:00:00 2001 From: Christian Hesse Date: Tue, 22 Feb 2022 22:31:49 +0100 Subject: doc/mod/scriptrunonce: document optional configuration --- doc/mod/scriptrunonce.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'doc') 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 -- cgit v1.2.3-70-g09d2