index : static-web-server.git

3a7753fdbe539a2f21225b22b86b018ed4dd4462 [patch]

e44acaeae591c440fb6cca5141b53a2e36e378c8

8861ca3e0b57e98936a30eef9bc1e8894210b242

3a7753fdbe539a2f21225b22b86b018ed4dd4462.tar.gz

docs: minor typos [skip ci]

Diff

 docs/content/configuration/command-line-arguments.md | 2 +-
 docs/content/configuration/environment-variables.md  | 6 +++---
 docs/content/features/error-pages.md                 | 2 +-
 docs/content/features/security-headers.md            | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/content/configuration/command-line-arguments.md b/docs/content/configuration/command-line-arguments.md
index 6883189..00c6e3c 100644
--- a/docs/content/configuration/command-line-arguments.md
+++ b/docs/content/configuration/command-line-arguments.md
@@ -15,7 +15,7 @@ Jose Quintana <https://git.io/joseluisq>
A blazing fast and asynchronous web server for static files-serving.

USAGE:
    sws [OPTIONS]
    static-web-server [OPTIONS]

FLAGS:
    -h, --help       Prints help information
diff --git a/docs/content/configuration/environment-variables.md b/docs/content/configuration/environment-variables.md
index 9cedec0..07f715a 100644
--- a/docs/content/configuration/environment-variables.md
+++ b/docs/content/configuration/environment-variables.md
@@ -27,12 +27,12 @@ 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`

### 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_THREADS_MULTIPLIER
Number of worker threads multiplier that'll be multiplied by the number of system CPUs using the formula: `worker threads = number of CPUs * n` where `n` is the value that changes here. When multiplier value is 0 or 1 then the `number of CPUs` is used. Number of worker threads result should be a number between 1 and 32,768 though it is advised to keep this value on the smaller side. Default one thread per core.

diff --git a/docs/content/features/error-pages.md b/docs/content/features/error-pages.md
index b772cfb..4b2a685 100644
--- a/docs/content/features/error-pages.md
+++ b/docs/content/features/error-pages.md
@@ -5,7 +5,7 @@
This feature is enabled by default and can be controlled either by the string `--page404` ([SERVER_ERROR_PAGE_404](./../configuration/environment-variables.md#server_error_page_404)) or the `--page50x` ([SERVER_ERROR_PAGE_50X](./../configuration/environment-variables.md#server_error_page_50x)) arguments.

!!! info "Tip"
Either `--page404` and `--page50x` have defaults (optional values) so they can be specified or omitted as required.
    Either `--page404` and `--page50x` have defaults (optional values) so they can be specified or omitted as required.

Below an example of how to customize those HTML pages.

diff --git a/docs/content/features/security-headers.md b/docs/content/features/security-headers.md
index 1a8e3b3..63b85f6 100644
--- a/docs/content/features/security-headers.md
+++ b/docs/content/features/security-headers.md
@@ -2,7 +2,7 @@

**`SWS`** provides several [security headers](https://web.dev/security-headers/) support.

When the [HTTP/2](../features/http2-tls.md) feature is activated *security headers* is enabled automatically.
When the [HTTP/2](../features/http2-tls.md) feature is activated *security headers* are enabled automatically.

This feature is disabled by default on HTTP/1 and can be controlled by the boolean `--security-headers` option or the equivalent [SERVER_SECURITY_HEADERS](./../configuration/environment-variables.md#server_security_headers) env.