From 8861ca3e0b57e98936a30eef9bc1e8894210b242 Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Mon, 21 Mar 2022 10:41:04 +0100 Subject: [PATCH] docs: v2.7.0 [skip ci] --- docs/content/configuration/command-line-arguments.md | 20 ++++++++++++++------ docs/content/configuration/environment-variables.md | 3 +++ docs/content/download-and-install.md | 72 ++++++++++++++++++++++++++++++++++++------------------------------------ 3 files changed, 53 insertions(+), 42 deletions(-) diff --git a/docs/content/configuration/command-line-arguments.md b/docs/content/configuration/command-line-arguments.md index a48ff2c..6883189 100644 --- a/docs/content/configuration/command-line-arguments.md +++ b/docs/content/configuration/command-line-arguments.md @@ -10,12 +10,12 @@ The server can be configured via the following command-line arguments. ``` $ static-web-server -h -static-web-server 2.5.0 +static-web-server 2.7.0 Jose Quintana A blazing fast and asynchronous web server for static files-serving. USAGE: - static-web-server [OPTIONS] + sws [OPTIONS] FLAGS: -h, --help Prints help information @@ -31,6 +31,10 @@ OPTIONS: -x, --compression Gzip, Deflate or Brotli compression on demand determined by the Accept-Encoding header and applied to text- based web file types only [env: SERVER_COMPRESSION=] [default: true] + -j, --cors-allow-headers + Specify an optional CORS list of allowed headers separated by comas. Default "origin, content-type". It + requires `--cors-allow-origins` to be used along with [env: SERVER_CORS_ALLOW_HEADERS=] [default: origin, + content-type] -c, --cors-allow-origins Specify an optional CORS list of allowed origin hosts separated by comas. Host ports or protocols aren't being checked. Use an asterisk (*) to allow any host [env: SERVER_CORS_ALLOW_ORIGINS=] [default: ] @@ -67,12 +71,16 @@ OPTIONS: -g, --log-level Specify a logging level in lower case. Values: error, warn, info, debug or trace [env: SERVER_LOG_LEVEL=] [default: error] + --page-fallback + HTML file path that is used for GET requests when the requested path doesn't exist. The fallback page is + served with a 200 status code, useful when using client routers. If the path is not specified or simply + doesn't exist then this feature will not be active [env: SERVER_FALLBACK_PAGE=] [default: ] --page404 - HTML file path for 404 errors. If path is not specified or simply don't exists then server will use a - generic HTML error message [env: SERVER_ERROR_PAGE_404=] [default: ./public/404.html] + HTML file path for 404 errors. If the path is not specified or simply doesn't exist then the server will use + a generic HTML error message [env: SERVER_ERROR_PAGE_404=] [default: ./public/404.html] --page50x - HTML file path for 50x errors. If path is not specified or simply don't exists then server will use a - generic HTML error message [env: SERVER_ERROR_PAGE_50X=] [default: ./public/50x.html] + HTML file path for 50x errors. If the path is not specified or simply doesn't exist then the server will use + a generic HTML error message [env: SERVER_ERROR_PAGE_50X=] [default: ./public/50x.html] -p, --port Host port [env: SERVER_PORT=] [default: 80] -d, --root Root directory path of static files [env: SERVER_ROOT=] [default: ./public] diff --git a/docs/content/configuration/environment-variables.md b/docs/content/configuration/environment-variables.md index 043a18d..9cedec0 100644 --- a/docs/content/configuration/environment-variables.md +++ b/docs/content/configuration/environment-variables.md @@ -27,6 +27,9 @@ Specify a logging level in lower case. Possible values are `error`, `warn`, `inf ### SERVER_ERROR_PAGE_404 HTML file path for 404 errors. If path is not specified or simply don't exists then server will use a generic HTML error message. Default `./public/404.html`. +### SERVER_FALLBACK_PAGE +HTML file path that is used for `GET` requests when the requested path doesn't exist. The fallback page is served with a `200` status code, useful when using client routers (E.g `React Router`). If the path is not specified or simply doesn't exist then this feature will not be active. + ### SERVER_ERROR_PAGE_50X HTML file path for 50x errors. If path is not specified or simply don't exists then server will use a generic HTML error message. Default `./public/50x.html` diff --git a/docs/content/download-and-install.md b/docs/content/download-and-install.md index 59f8650..ef002d6 100644 --- a/docs/content/download-and-install.md +++ b/docs/content/download-and-install.md @@ -1,12 +1,12 @@ # Download and Install -Latest **v2.6.0** release `2022-02-28` ([changelog](https://github.com/joseluisq/static-web-server/releases/tag/v2.6.0)) +Latest **v2.7.0** release `2022-03-21` ([changelog](https://github.com/joseluisq/static-web-server/releases/tag/v2.7.0))
-Linux 64-bit macOS 64-bit -Windows 64-bit -FreeBSD 64-bit +Linux 64-bit macOS 64-bit +Windows 64-bit +FreeBSD 64-bit
@@ -36,47 +36,47 @@ yay -S static-web-server-bin ### x86_64 -- [static-web-server-v2.6.0-x86_64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-apple-darwin.tar.gz)
-**SHA256SUM:** `5931631ab3065be3251444212a8801838e23ca4aabf47ff81746b0982473c994` -- [static-web-server-v2.6.0-x86_64-pc-windows-gnu.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-pc-windows-gnu.zip)
-**SHA256SUM:** `0a42a21480288084b94285b0ffb33caa1799f172782706cdd76af1fc5628d1be` -- [static-web-server-v2.6.0-x86_64-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-pc-windows-msvc.zip)
-**SHA256SUM:** `864d2b938a20992a65808464d0f93157fd3ec6053a8c46c81d2f259f083659f7` -- [static-web-server-v2.6.0-x86_64-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-unknown-freebsd.tar.gz)
-**SHA256SUM:** `ed6ff39617ae86eed81b25b0fb7ce32875221407331eedaf0e3553f2afff3958` -- [static-web-server-v2.6.0-x86_64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-unknown-linux-gnu.tar.gz)
-**SHA256SUM:** `9ddfc88b9f525603de6cbf3a6dc14bf8963fa01e101ff31d0e80bea9fb1884ce` -- [static-web-server-v2.6.0-x86_64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-x86_64-unknown-linux-musl.tar.gz)
-**SHA256SUM:** `05d20d6272deaf6d349b80a783a065851e09fe7a41013e2db4ea13a1907e46b6` +- [static-web-server-v2.7.0-x86_64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-apple-darwin.tar.gz)
+**SHA256SUM:** `33f3364347c5ba36cb0aa636cd1ab8b2bbd42026de8ed8eaa49d88e9c02abba6` +- [static-web-server-v2.7.0-x86_64-pc-windows-gnu.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-pc-windows-gnu.zip)
+**SHA256SUM:** `21ede4d5827bbb116ace146abb64885c4e60f678fc7d758452b8487009198603` +- [static-web-server-v2.7.0-x86_64-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-pc-windows-msvc.zip)
+**SHA256SUM:** `a1336542aa15ce73f2ff056357a617c2a05bd23706cd13d68ca1836cfd17fb97` +- [static-web-server-v2.7.0-x86_64-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-unknown-freebsd.tar.gz)
+**SHA256SUM:** `2e259fce5029e841556e41cfb35fde618e31d989a6685f3d8753ce6face836e5` +- [static-web-server-v2.7.0-x86_64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `fda97a753069fefeebee82e13cfe170c13f08398d2f4f8c43bf94995c3a77d47` +- [static-web-server-v2.7.0-x86_64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-x86_64-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `f37d6f476a8907d6dbc23b2c500f827e6d8aed906b30ad04f732da336475f0ed` ### ARM64 -- [static-web-server-v2.6.0-aarch64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-aarch64-unknown-linux-gnu.tar.gz)
-**SHA256SUM:** `bbc24fd8ac66c77903017a4a9ee2497cd584d1a1f4cfd997e15052e493b2d06a` -- [static-web-server-v2.6.0-aarch64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-aarch64-unknown-linux-musl.tar.gz)
-**SHA256SUM:** `857fd71ec7aa5472b6066290f2eebb192fd7edae00cffbd3c3be2b570375c869` -- [static-web-server-v2.6.0-aarch64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-aarch64-apple-darwin.tar.gz)
-**SHA256SUM:** `a6c00cbe7205e7e167f6ed348ea7b64b98a46d78b2e553fc07436328c2648c5e` +- [static-web-server-v2.7.0-aarch64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-aarch64-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `86d573738f007efbbede5d82536a21443b00314bc95270111bc6adb6a02ff4e0` +- [static-web-server-v2.7.0-aarch64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-aarch64-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `7fc1b37d4ea77a850e6dafee9fe582a5f04d3f3f9b4c608efbb6b9bb65f4c20b` +- [static-web-server-v2.7.0-aarch64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-aarch64-apple-darwin.tar.gz)
+**SHA256SUM:** `255fd92178577745c045e5e016d433a7c02611fe39f75e5b87b8f366b16fdb45` ### x86 -- [static-web-server-v2.6.0-i686-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-i686-pc-windows-msvc.zip)
-**SHA256SUM:** `dad2ccdb8d3f1e19d96114cb53813a96300792f9515ef89764e5c57d824043a8` -- [static-web-server-v2.6.0-i686-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-i686-unknown-freebsd.tar.gz)
-**SHA256SUM:** `3ae10ea90929341db519b8304da085bc434f388e7334e3fa38eaf9c761f54aac` -- [static-web-server-v2.6.0-i686-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-i686-unknown-linux-gnu.tar.gz)
-**SHA256SUM:** `43cb2467ab7459ac43f6ef933a4439b119fedfc0fe6548e1c4eca7d9fed8d464` -- [static-web-server-v2.6.0-i686-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-i686-unknown-linux-musl.tar.gz)
-**SHA256SUM:** `c8b4f8b7db34ece01926fbd63e4e13f92310feea27aaed3665e0b943f9ed45f1` +- [static-web-server-v2.7.0-i686-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-i686-pc-windows-msvc.zip)
+**SHA256SUM:** `169f119f48a0b23936e595547c0dffe94b89e0474a515febd3357003b272f2ea` +- [static-web-server-v2.7.0-i686-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-i686-unknown-freebsd.tar.gz)
+**SHA256SUM:** `7848c1783cd79147923348b4f1a480ba6f258f5cfb180178501943098386178b` +- [static-web-server-v2.7.0-i686-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-i686-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `c7901a302b05d6688a89edccc09309ae331654fe23c5a6b8e00bd14ca748fe7a` +- [static-web-server-v2.7.0-i686-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-i686-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `128acbabbf9bb30c9ab800405b2d43595a62cc1e8059a3c190f950d8ef13a426` ### ARM -- [static-web-server-v2.6.0-arm-unknown-linux-gnueabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-arm-unknown-linux-gnueabihf.tar.gz)
-**SHA256SUM:** `ac053b636f3b03382404da6610b7958311abf36d223e907760f7ff2b6697acba` -- [static-web-server-v2.6.0-arm-unknown-linux-musleabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-arm-unknown-linux-musleabihf.tar.gz)
-**SHA256SUM:** `70a8ca35465e2ed505b2c1faad02b65aad49805f2abd767d3bb7d337a09ecc21` -- [static-web-server-v2.6.0-armv7-unknown-linux-musleabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.6.0/static-web-server-v2.6.0-armv7-unknown-linux-musleabihf.tar.gz)
-**SHA256SUM:** `1f753716a4db904643b0cc53124b7c37ab4a6d2ee841ee97fe51f4cb3b4de919` +- [static-web-server-v2.7.0-arm-unknown-linux-gnueabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-arm-unknown-linux-gnueabihf.tar.gz)
+**SHA256SUM:** `c60cc15c7c57bc3b07f137536c9054b8b951c2cfcb598fb9468e5829f650552b` +- [static-web-server-v2.7.0-arm-unknown-linux-musleabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-arm-unknown-linux-musleabihf.tar.gz)
+**SHA256SUM:** `a0154f7d2d2a93a77016759023e3eba705684dc72c6810beb40a9d0a14b55dcb` +- [static-web-server-v2.7.0-armv7-unknown-linux-musleabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.7.0/static-web-server-v2.7.0-armv7-unknown-linux-musleabihf.tar.gz)
+**SHA256SUM:** `d4d3d4296843a1a93613c08368166272ee65d26fbac056830ac07cffbf3ecc21` ## All Releases -- libgit2 1.7.2