summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Busby <noreply+git@benbusby.com>2021-11-15 20:09:34 -0700
committerBen Busby <noreply+git@benbusby.com>2021-11-15 20:09:34 -0700
commitd4581797e7a06cf4c89cf03def30e19726f26d11 (patch)
treea5bac6c35011d8f384bbb361c2aa7565629f057d /README.md
parent5904c7cce4d42cf29d775dc39e51183a9be2d82f (diff)
downloadfarside-d4581797e7a06cf4c89cf03def30e19726f26d11.tar.gz
Allow bypassing app router with `FARSIDE_NO_ROUTER`
Setting the aforementioned env var skips creation of the app router, which is useful for running update.exs when the main app is already running (otherwise there's a port conflict).
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 54b40dc..a2dd1da 100644
--- a/README.md
+++ b/README.md
@@ -73,3 +73,9 @@ request per second per IP.
- Run Farside: `mix run --no-halt`
- Uses localhost:4001
+### Environment Variables
+
+| Name | Purpose |
+| -- | -- |
+| FARSIDE_TEST | If enabled, skips the instance availability check in `update.exs`. |
+| FARSIDE_NO_ROUTER | If enabled, skips creation of the router. Useful for running `update.exs` with `mix run` when the app is already running. |