aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-06-24 13:46:35 +0000
committerFuwn <[email protected]>2024-06-24 13:46:35 +0000
commitfeaf056ed65e63a78cd299f2b7394211b369a267 (patch)
treef7df35c4b63abcb2c97f82f683360decfe873ff9
parentdocs(readme): add screenshot (diff)
downloadgigi-feaf056ed65e63a78cd299f2b7394211b369a267.tar.xz
gigi-feaf056ed65e63a78cd299f2b7394211b369a267.zip
docs(readme): add dynamic mode information
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 571b665..948dba2 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,8 @@ Gigi is configured through the `./gigi` directory.
Dynamic response mode is disabled by default in [`gigi.c`](./gigi.c)
because it is very unsafe. If you wish to live on the edge, uncomment the
-`GIGI_DYNAMIC` macro.
+`GIGI_DYNAMIC` macro. Dropping Gigi into a container is significantly safer
+than running it on a host machine, so consider that as an option, too.
Dynamic mode runs any and all executables located at the path `./gigi/do`, and
passes any arguments from the Finger request to the executable.
@@ -37,6 +38,9 @@ Static mode is enabled by default. A Finger request for `test` will return the
contents of `./gigi/test`. A Finger request of nothing will return the contents
of `./gigi/default`.
+To emulate dynamic mode, minus the arguments you can setup a service of some
+kind to periodically update the contents of one of the static files.
+
## Licence
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or