aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2024-10-11 05:13:17 +0000
committerGitHub <noreply@github.com>2024-10-11 05:13:17 +0000
commitfde3a7019d0b34dfa1ee3782f4dd6960f0aba495 (patch)
treeea6fe8fab1dad64d446c37dd9e1d12f199d8befc
parentBump deps (diff)
parentMention environment variables in the systemd section (diff)
downloadminiserve-fde3a7019d0b34dfa1ee3782f4dd6960f0aba495.tar.gz
miniserve-fde3a7019d0b34dfa1ee3782f4dd6960f0aba495.zip
Merge pull request #1458 from lahwaacz/readme
Small README improvements
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index bff3de7..9f8f109 100644
--- a/README.md
+++ b/README.md
@@ -287,7 +287,7 @@ Options:
-o, --overwrite-files
Enable overriding existing files during file upload
- [env: OVERWRITE_FILES=]
+ [env: MINISERVE_OVERWRITE_FILES=]
-r, --enable-tar
Enable uncompressed tar archive generation
@@ -473,10 +473,19 @@ In case you want to customize the particular flags that miniserve launches with,
and set the `[Service]` part in the resulting `override.conf` file. For instance:
[Service]
+ ExecStart=
ExecStart=/usr/bin/miniserve --enable-tar --enable-zip --no-symlinks --verbose -i ::1 -p 1234 --title hello --color-scheme monokai --color-scheme-dark monokai -- %I
-Make sure to leave the `%I` at the very end in place or the wrong path might be served. You
-might additionally have to override `IPAddressAllow` and `IPAddressDeny` if you plan on making
+Make sure to leave the `%I` at the very end in place or the wrong path might be served.
+Alternatively, you can configure the service via environment variables:
+
+ [Service]
+ Environment=MINISERVE_ENABLE_TAR=true
+ Environment=MINISERVE_ENABLE_ZIP=true
+ Environment="MINISERVE_TITLE=hello world"
+ ...
+
+You might additionally have to override `IPAddressAllow` and `IPAddressDeny` if you plan on making
miniserve directly available on a public interface.
## Binding behavior