index : static-web-server.git

ascending towards madness

author Jose Quintana <joseluisquintana20@gmail.com> 2023-06-02 22:19:37.0 +00:00:00
committer Jose Quintana <joseluisquintana20@gmail.com> 2023-06-02 22:19:37.0 +00:00:00
commit
82237a70d6865d4970be0457170ea0ca74bef476 [patch]
tree
fff1466f1f216880908f634df7a8d1fe3e19b8f5
parent
880eaf4d251814953f5a79ffec99e6e485f6d156
download
82237a70d6865d4970be0457170ea0ca74bef476.tar.gz

v2.17.0



Diff

 CHANGELOG.md                                         | 35 +++++++++++++++++++++-
 Cargo.lock                                           |  2 +-
 Cargo.toml                                           |  2 +-
 docs/content/configuration/command-line-arguments.md |  2 +-
 docs/content/contributions.md                        |  2 +-
 docs/content/index.md                                |  4 +-
 docs/content/license.md                              |  2 +-
 docs/content/migration.md                            |  5 ++-
 docs/mkdocs.yml                                      |  2 +-
 9 files changed, 50 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 870534b..a041e39 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

_**Note:** See changelog for v1 under the [1.x]https://github.com/static-web-server/static-web-server/blob/1.x/CHANGELOG.md branch._

## v2.17.0 - 2023-06-03

This new `v2.17.0` release brings several dependency updates/bug fixes, ECC private keys support for the `tls` feature, HTTP to HTTPS redirect support, several Cargo features for controlling the SWS `compression` and `compression-static`, dependency migrations like the `clap` CLI parser and `tokio-rustls` as well as various refactorings and improvements.

__Fixes__

- [b685cda]https://github.com/static-web-server/static-web-server/commit/b685cda Bugfix/security dependency updates including tokio, tracing, chrono, serde, h2, libc, pin-project, windows-sys and other crates.

__Features__

- [946b4e5]https://github.com/static-web-server/static-web-server/commit/946b4e5 HTTP to HTTPS redirect support. PR [#203]https://github.com/static-web-server/static-web-server/pull/203 resolves [#202]https://github.com/static-web-server/static-web-server/issues/202 suggested by [@micsama]https://github.com/micsama. See [docs]https://static-web-server.net/features/http-https-redirect/.
- [0f66443]https://github.com/static-web-server/static-web-server/commit/0f66443 ECC private keys support for the `tls` feature. PR [#208]https://github.com/static-web-server/static-web-server/pull/208 resolves [#207]https://github.com/static-web-server/static-web-server/issues/207 suggested by [@mac-chaffee]https://github.com/mac-chaffee. See [docs]https://static-web-server.net/features/http2-tls/#private-key-file-formats.
- [af77e4a]https://github.com/static-web-server/static-web-server/commit/af77e4a Lib: Cargo features for `compression` and `compression-static`. PR [#201]https://github.com/static-web-server/static-web-server/pull/201.
- [f8fca0a]https://github.com/static-web-server/static-web-server/commit/f8fca0a Misc: Include SPDX license identifiers in every source file.
- [a345df3]https://github.com/static-web-server/static-web-server/commit/a345df3 Misc: Benchmarks 2023-04. See [repository]https://github.com/static-web-server/benchmarks.
- [1894474]https://github.com/static-web-server/static-web-server/commit/1894474 CI: Workflow to automate checksums.

__Refactorings__

- [4e01de6]https://github.com/static-web-server/static-web-server/commit/4e01de6 Migrate `clap` CLI parser to v3. PR [#211]https://github.com/static-web-server/static-web-server/pull/211 by [@mac-chaffee]https://github.com/mac-chaffee.
- [e8560a0]https://github.com/static-web-server/static-web-server/commit/e8560a0 Update `tokio-rustls` to `0.24`.
- [20de5d0]https://github.com/static-web-server/static-web-server/commit/20de5d0 HTTP to HTTPS redirect feature improvements.
- [647e9b0]https://github.com/static-web-server/static-web-server/commit/647e9b0 Lib: Include missing `rustls-pemfile` in Cargo `tls` feature.
- [53ef76e]https://github.com/static-web-server/static-web-server/commit/53ef76e Lib: Improve Rust docs for Cargo features.
- [6b81c48]https://github.com/static-web-server/static-web-server/commit/6b81c48 Lib: Simplify `http2` Cargo feature.
- [ae17023]https://github.com/static-web-server/static-web-server/commit/ae17023 CI: Simplify workflow scripts.

__Docs__

- [d3fa602]https://github.com/static-web-server/static-web-server/commit/d3fa602 HTTP to HTTPS redirect feature page. See [docs]https://static-web-server.net/features/http-https-redirect/.
- [880eaf4]https://github.com/static-web-server/static-web-server/commit/880eaf4 HTTP/2 and TLS feature page improvements. See [docs]https://static-web-server.net/features/http-https-redirect/. See [docs]https://static-web-server.net/features/http2-tls/.
- [e0ae5a7]https://github.com/static-web-server/static-web-server/commit/e0ae5a7 Blocking threads feature page. See [docs]https://static-web-server.net/features/blocking-threads/.
- [c64e3d6]https://github.com/static-web-server/static-web-server/commit/c64e3d6 Safe TLS defaults description. See [docs]https://static-web-server.net/features/http2-tls/#safe-tls-defaults.
- [6876a75]https://github.com/static-web-server/static-web-server/commit/6876a75 Enable content editing option and revision. See [docs]https://static-web-server.net/.

## v2.16.0 - 2023-04-25

This new `v2.16.0` release brings several dependency updates/bug fixes including the Alpine Docker image, a new Android ARM64 target, Zstandard (zstd) auto-compression and pre-compressed files support, `static-web-server` available as a crate, as well as other additions and improvements.
diff --git a/Cargo.lock b/Cargo.lock
index 1b19c2e..e2c3d05 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1120,7 +1120,7 @@ checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"

[[package]]
name = "static-web-server"
version = "2.16.0"
version = "2.17.0"
dependencies = [
 "anyhow",
 "async-compression",
diff --git a/Cargo.toml b/Cargo.toml
index 3387d6e..bc9e4c5 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "static-web-server"
version = "2.16.0"
version = "2.17.0"
authors = ["Jose Quintana <https://joseluisq.net>"]
license = "MIT OR Apache-2.0"
description = "A cross-platform, high-performance and asynchronous web server for static files-serving."
diff --git a/docs/content/configuration/command-line-arguments.md b/docs/content/configuration/command-line-arguments.md
index 11632ae..bef89b5 100644
--- a/docs/content/configuration/command-line-arguments.md
+++ b/docs/content/configuration/command-line-arguments.md
@@ -10,7 +10,7 @@ The server can be configured via the following command-line arguments.
```
$ static-web-server -h

static-web-server 2.16.0
static-web-server 2.17.0
Jose Quintana <https://joseluisq.net>
A cross-platform, high-performance and asynchronous web server for static files-serving.

diff --git a/docs/content/contributions.md b/docs/content/contributions.md
index 599c207..264c0da 100644
--- a/docs/content/contributions.md
+++ b/docs/content/contributions.md
@@ -3,3 +3,5 @@
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the [Apache License (Version 2.0)]https://github.com/static-web-server/static-web-server/blob/master/LICENSE-APACHE license, shall be dual licensed as described below, without any additional terms or conditions.

Feel free to send some [Pull request]https://github.com/static-web-server/static-web-server/pulls or file an [issue]https://github.com/static-web-server/static-web-server/issues.

Or for feedback or questions feel free to reach us on [the discussions page]https://github.com/static-web-server/static-web-server/discussions.
diff --git a/docs/content/index.md b/docs/content/index.md
index e93ac7e..8108973 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -75,4 +75,6 @@ It's cross-platform and available for `Linux`, `macOS`, `Windows` and `FreeBSD` 

<img title="SWS - Benchmarks April 2023" src="https://raw.githubusercontent.com/static-web-server/benchmarks/master/data/2023-04/benchmark-2023-04.png" width="860">

For more details see [benchmarks repository]https://github.com/static-web-server/benchmarks
For more details see [benchmarks repository]https://github.com/static-web-server/benchmarks.

For feedback or questions feel free to reach us on [the discussions page]https://github.com/static-web-server/static-web-server/discussions.
diff --git a/docs/content/license.md b/docs/content/license.md
index 048321b..3db1353 100644
--- a/docs/content/license.md
+++ b/docs/content/license.md
@@ -3,3 +3,5 @@
This work is primarily distributed under the terms of both the [MIT license]https://github.com/static-web-server/static-web-server/blob/master/LICENSE-MIT and the [Apache License (Version 2.0)]https://github.com/static-web-server/static-web-server/blob/master/LICENSE-APACHE.

© 2019-present [Jose Quintana]https://github.com/joseluisq

For feedback or questions feel free to reach us on [the discussions page]https://github.com/static-web-server/static-web-server/discussions.
diff --git a/docs/content/migration.md b/docs/content/migration.md
index 911a276..46fa9f8 100644
--- a/docs/content/migration.md
+++ b/docs/content/migration.md
@@ -7,7 +7,7 @@ However, it still tries to keep the same principles of its `v1`: lightness and e

## v2 breaking changes

This major `v2` has few breaking changes. However, migration should not represent a problem.
This major `v2` has a few breaking changes. However, migration should not represent a problem.

!!! tip "Tip"
    It is always worth recommending that you test a major server version upgrade like this first with your application(s) in a development environment or similar.
@@ -17,5 +17,8 @@ Please have in mind the following changes in `v2`:
- The server now supports only a root directory path (via `--root` or its equivalent env) so an assets path option is no longer required.
- Cache-control headers are arbitrarily applied to assets. See [control headers examples]./features/cache-control-headers.md for more details.
- OpenSSL TLS for HTTP/1 is no longer supported, instead for the HTTP/2 & TLS (via `--http2` option) the server uses [h2]https://github.com/hyperium/h2 which is on top of [Rustls]https://github.com/ctz/rustls. It means that instead of using a `.p12` or `.pfx` file you can now use only a certificate file along with its private key. See [HTTP/2 & TLS examples]./features/http2-tls.md for more details.
- If using HTTP to HTTPS redirect, then check out [the new feature page]./features/http-https-redirect.md to adjust the options accordingly.

The rest of the known options are equivalent to `v1` (except the new ones of course).

For feedback or questions feel free to reach us on [the discussions page]https://github.com/static-web-server/static-web-server/discussions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 147640d..2c2f785 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -140,7 +140,7 @@ nav:
    - 'HTTP/1': 'features/http1.md'
    - 'HTTP Methods': 'features/http-methods.md'
    - 'HTTP/2 and TLS': 'features/http2-tls.md'
    - 'HTTP to HTTP redirect': 'features/http-https-redirect.md'
    - 'HTTP to HTTPS redirect': 'features/http-https-redirect.md'
    - 'Logging': 'features/logging.md'
    - 'Compression': 'features/compression.md'
    - 'Pre-compressed files serving': 'features/compression-static.md'