From c85d9e316fc8e3cc1505126014690537ca2637ec Mon Sep 17 00:00:00 2001 From: orwithout Date: Fri, 26 Apr 2024 18:00:23 +0800 Subject: Improve documentation for the --header parameter (#1389) * Improve documentation for the --header parameter * Add Support for HSTS to Enhance HTTPS Security --------- Co-authored-by: orwithout --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e9e7ef0..bff3de7 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,22 @@ Sometimes this is just a more practical and quick way than doing things properly miniserve -i 192.168.0.1 -i 10.13.37.10 -i ::1 /tmp/myshare +### Insert custom headers + + miniserve --header "Cache-Control:no-cache" --header "X-Custom-Header:custom-value" -p 8080 /tmp/myshare + # Check headers in another terminal + curl -I http://localhost:8080 + +If a header is already set or previously inserted, it will not be overwritten. + ### Start with TLS: miniserve --tls-cert my.cert --tls-key my.key /tmp/myshare + # Fullchain TLS and HTTP Strict Transport Security (HSTS) + miniserve --tls-cert fullchain.pem --tls-key my.key --header "Strict-Transport-Security: max-age=31536000; includeSubDomains; preload" /tmp/myshare + +If the parameter value has spaces, be sure to wrap it in quotes. +(To achieve an A+ rating at https://www.ssllabs.com/ssltest/, enabling both fullchain TLS and HSTS is necessary.) ### Upload a file using `curl`: @@ -314,7 +327,12 @@ Options: [env: MINISERVE_TITLE=] --header
- Set custom header for responses + Inserts custom headers into the responses. Specify each header as a 'Header:Value' pair. + This parameter can be used multiple times to add multiple headers. + + Example: + --header "Header1:Value1" --header "Header2:Value2" + (If a header is already set or previously inserted, it will not be overwritten.) [env: MINISERVE_HEADER=] -- cgit v1.2.3