aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2022-05-04 22:23:17 +0200
committerGravatar Christian Hesse <mail@eworm.de>2022-05-05 10:44:21 +0200
commit357618a1a545ced696ffbfb87bb72a45b73913f8 (patch)
treee82ba8451035feb9666746f58850b2fee5d6fec7 /README.md
parentaf589df82cfcdbedfbab7d3d8e62b5238d318bb6 (diff)
README: installing custom scripts & modules
(cherry picked from commit ecde864263f8572503eeaba2ad7c806847adb594)
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 215274d..97cf318 100644
--- a/README.md
+++ b/README.md
@@ -246,6 +246,29 @@ Available modules
* [Send notifications via Telegram](doc/mod/notification-telegram.md)
* [Download script and run it once](doc/mod/scriptrunonce.md)
+Installing custom scripts & modules
+-----------------------------------
+
+My scripts cover a lot of use cases, but you may have your own ones. You can
+still use my scripts to manage and deploy yours, by specifying `base-url`
+(and `url-suffix`) for each script.
+
+This will fetch and install a script `hello-world.rsc` from the given url:
+
+ $ScriptInstallUpdate hello-world.rsc "base-url=https://git.eworm.de/cgit/routeros-scripts/plain/README.d/"
+
+![screenshot: install custom script](README.d/12-install-custom-script.avif)
+
+(Yes, the example url still belongs to the repository for easy
+handling - but the url can be what ever you use.)
+
+For a script to be considered valid it has to begin with a *magic token*.
+Have a look at [any script](README.d/hello-world.rsc) and copy the first line
+without modification.
+
+Starting a script's name with `mod/` makes it a module and it is run
+automatically by `global-functions`.
+
Contact
-------