aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-06-24 06:46:35 -0700
committerFuwn <[email protected]>2024-06-24 06:47:33 -0700
commitb3ff004393aa8ead2a75c195c247228e97cccacf (patch)
tree119f64095c04d1d3c5cb974e1b03b413c1d62fcc /README.md
parent6413247030dc55a0b0d24455ae1b88baff342ca9 (diff)
downloadgigi-b3ff004393aa8ead2a75c195c247228e97cccacf.tar.xz
gigi-b3ff004393aa8ead2a75c195c247228e97cccacf.zip
docs(readme): add dynamic mode information
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 304e6c2..8e09278 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
This project is licensed with the [GNU General Public License v3.0](./LICENSE).