Skip to content

Commit

Permalink
Merge pull request #1458 from lahwaacz/readme
Browse files Browse the repository at this point in the history
Small README improvements
  • Loading branch information
svenstaro authored Oct 11, 2024
2 parents 1a0e3c3 + 1c49200 commit fde3a70
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fde3a70

Please sign in to comment.