static-web-server

Fourth beta release v2.0.0-beta.4 with notable changes.

Updates

• a8b937911a5402d1e7498e258017ab81402368d1 Binaries compiled with latest Rust 1.52.1 release.
• c3389cc173e969a54b46b9f16f1e49cd2a822343 Update dependencies including latest Hyper, Tokio and related crates. (also 7cbe483f84d9deee9091ef3bd80580c55c7bfde6)

Features

• 21bdf8c26abd5d11b704b9345e539abadf4ff18a Support inheriting TCP listener from parent process via file descriptor (-f, --fd). PR #40 by @tim-seoss.
• 5428eb363b693f74285ba8d66edf4bad1778b3ba Redefined directory listing (-z, --directory-listing). PR #41
• d389803b8a455be057ff31a3f4e61f5770751a6e Opt-in response body auto compression (Gzip, Deflate, Brotli) based on Accept-Encoding header (-x, --compression).
• 74b9eaf151668980a34a98420e6d7d8ead9dc20f Just one file associated metadata per request as possible.
• af9a32951c866e180dee6c8c359be13cc1f79d29 CORS support (-c, --cors-allow-origins).
• 6ed3fe5250129feba03211188d6901a87a5a0c1e Unix-like termination signals handling.

Refactorings

• a8d462aa70ecc21cb8b33cd04e40834c7254f39b Drop Warp in favor of just Hyper + Tokio. PR #38
• 04ec1b1fd65383ba787e008670ff065085d820bd One worker thread per available core by default (-n, --threads-multiplier).
• 991d4b8deefade61d35ef278efa28ed7fcb79bed Introduce a custom Hyper service implementation for the HTTP1 & HTTP2 web servers.
• 58ff9b7b3f20d7631be3b16fee4839e9fe92d5e5 Reject non HEAD or GET requests on static assets and error page handlers.
• 5cede7e92ab17ad51e93db7ad2b00edd88bf0cbd Log info for compression and directory listing features.

Docs

All feature flags as well as their equivalent environment variables are described on the updated README file.

Updates

• b0593ffba1b6e92214b8f451f0ebce6e2dadb2e5 Binaries compiled with latest Rust 1.52.1 release.
• c96cd4851a7263a9e06dac73e1b325f8b072e663 Update dependencies 26.05.2021

Third beta release v2.0.0-beta.3 with notable changes.

Updates

• 7f29c90e0d296c4124d7936f0cbeaf3b9d733fa3 Binaries compiled with latest Rust 1.51.0 release.
• 97d75e0cb4b1382865844dcf971d2501810520f2 Alpine 3.13 Docker image.
• 97d75e0cb4b1382865844dcf971d2501810520f2 Update dependencies including latest Tokio v1, Warp v0.3 (with Hyper v0.14) and related crates (also e9384e9548362d0bbdf6932bb62e7ff0ec33089b, 5d4421da61e4ff547dc7409174c62918884ac977)

Refactorings

• 5d8b26632986bc656ae90e46460023abaf9adc8f Static server configuration and static default error pages content.
• e853410e4d3a9d4faa65c80d134fdddfc5be737b Drop support for Deflate compression.
• bbb5a8f09bf2c82506c5ca639d2fbd5807bdb4dd Improve log information on server runtime setup.
• c05471f63f2c303d528ab7c97e9c149afb1ea1af Tokio server tasks simplifications.
• 7ea40a713ab60236dd7982ea857ca936d58ae9d8 Minor CLI typos.

Fixes

• 99b8b7e03c98960cbfa288eb9958e0a468e02b93 Linking error for ring crate during Darwin build.

Docs

• 3c36c9b3d7f04794629fba1b62cd8a781ea53538 Minor README description improvements.

Features

• 8cf7909a3a0d7d3424d3cc159c973095d845445a Binaries compiled with latest Rust 1.51.0 release.
• cfbffb8db6b0fa58d9caccbb1f787f3e36b22f28 Alpine 3.13 Docker image.

Updates

• 12824ed74212114548c477d15708211d0cbf8224 Update dependencies 20.04.2021 (also 996c181c4a3800e2b97ed7afc4f5d48d508ac383, c383b8a99281422fb2217808f61193faa976e39d). Upgrades also include a OpenSSL security upgrade to 1.1.1k which fixes CVE-2021-3450. More details on https://www.openssl.org/news/secadv/20210325.txt

Docs

• 304288cd83612ed9fe4a83bb0fe3c82b909b7055 Minor README clarifications.

Features

• 252406daf376435013a5597c7c05ffabf3c5c8bc Binaries compiled with latest Rust v1.50.0 release.
• feac82e1e8b0015c364e721b139d4661acc7852e Directory listing support via new -i, --directory-listing boolean flag (equivalent SERVER_DIRECTORY_LISTING env variable) which is disabled by default. PR #32 resolves #31.
• 5026bfed7c0d9506eaf632ad81a0adf4c8c85c48 Windows x86_64 binary support (.exe). See binary file attached to this release. PR #33 resolves #29.
• 116cbbfcfe052808b0305a67a77eeb4f411f62c0 UTF-8 URL decoding support (also cfcb6cba91ef7ff84f2f5e3fdb8eaad10991cd3d for directory listing)

Refactorings

• 4fe89c5d91c2eda8bda7d0457e8f3ebaff039809 Trim CORS comma-separated allowed hosts (CORS server argument).
• 8733d2aac2085b416d4f72327953673943a3bc4c Simplify public example asset files.
• 1c1c2afef5c473bf4889bb49ea498221cd8f83b6 Better 4xx/50x status code checks and more concise default error page content.
• db51d7776907c12db9192e9543487adbe5e7a854 Option type used for certain server arguments.
• 6551018818e39c1fc437dc11670ffb964d8f5888 Static file middleware searching optimizations which increases web server performance.
• a6cca088dde07df7f801a9c571a77a3d4205d0cb Improved static file path resolving.
• 5fed730516005f9c494fb3ba6edc782647963a0e Improved error handling on directory listing feature.
• d5e6bdd136a3094ab8cc2e1ade16fdf221e49cd2 Improve error handling on static files module.
• b16703099b3397f71be9d9412f329725ffe95b81 Optimize few dependencies features which reduces binary size.
• dd59cd3564e7f1425f86bed0db04ee0276d3f73f Explicit OS target for signals handling (just Unix-like & Windows distinction)

Updates

• a664866f09695fef1a3d7016611d202c858fdb6c Update dependencies 14.02.2021

Codebase

• 533006fc36d16441e80482f221a01ddbdd134a04 Refactor project modules structure & incorporate the static file middleware into the project.

Docs

• 68876243657f6ae55fccd52bb72c91365834b5d9 Remove whitespace description for CORS option.

Second beta release v2.0.0-beta.2 with notable changes.

Updates

• 9867d71749c6113e65b03dae370e90f33406b2df Update dependencies including latest Tokio v1, Warp v0.3 (with Hyper v0.14) and related crates. (also a4421c62a07f24e69a7029c67f8d667ffd2290a5, 960a681575fa687ca88db0359922df66e5f0b7bd, 960a681575fa687ca88db0359922df66e5f0b7bd)

Features

• 3007e74e5dd1749968d8db6572c8d0645147801a Project sponsor support. Consider to support the project via github.com/sponsors/joseluisq or paypal.me/joseluisqs.
• 360ae996c5366c6ab03b476ffc903728acebb58a Worker threads multiplier option --threads-multiplier which provides the ability to customize number of worker threads.
• ed0d6ac9989a14704c414eefd1aca16315e2fcca Custom error pages support.
• 4667b10c0a720f996110060fa456f491635b87d2 HTTP/2 + TLS support.
• 8c4ce94abb8d77b89a19575d260d4747a386c0e5 CORS support.

More details about features on README file.

Refactorings

• 6d3e2d19f8b3f6212020595d067935dc7ac2bb13 Remove redundant 'static lifetime on constants.
• 866c7cdd48b8f8467e09794025052e4a883b2027 Remove Tokio macros feature.
• f7f2bf662bbf1bfec88750f44b509b3da9ce5441 Some improvement suggestions by Clippy.
• bff49a0adcf7e68159d5b2eaeb7504f02a0ed0ca Few improvement on filter and helper modules.

Codebase

• 7265f6b93fbd5bd41b615e189d7b3b099f0414f4 Github Actions as new CI.
• c63b5495d3bc19d7879c6ddd1f7368cf4474cd37 Remove Travis CI.
• 65250c0feaff02e64f4f24c5415c1bc67dafbf8d Minor simplications on server module.
• b94fe72c9c26962e00382fa21f46d4774b56d781 Update core modules structure.
• da5bdc3cfed3895f8e6c27b93029896cdbbc4a2d Re-export few core lib modules.
• 57c27f4eaab4d01d1ffbd0207a59fe8949cc5754 Deny(warnings) on lib
• a3744d49263b37f38edb6bc934ba178433703d05 Simplify conditionals on rejection filter.

Docs

• 933a3c494210dda3fceaf903cd0e65bd44b49a7e Feature documentations updates (also 0ef21c4a0550caa65117da3bf421518626343020)
• 78033d06b5584582e15419e8592c04233869fb38 CLI arguments and environment variables descriptions.

First major beta release v2.0.0-beta.1 with notable changes.

Built-in features

It uses Tokio v0.2 and Warp v0.2 (Hyper v0.13).
PR #28

• Environment variables and CLI arguments setup
• Lightweight and configurable logging
• Head responses support
• GZip, Deflate and Brotli compression support
• Compression for text-based web file only
• Termination signal handling.
• Default error pages (404, 500x, etc)
• GZip, Deflate or Brotli compression can be optional
• Compression on demand via Accept-Encoding header
• Cache control headers for assets
• Docker scratch & Alpine images
• MacOs binary support

Bugfixes

• Resolves #24 - Error on 8GB file

Additional features

• Resolves #17 - Make assets directory path optional. Since this release major doesn't include an assets dir just a root.

Updates

• 300337ec2e39253a92283e636bb91b6b44b02cbf Update dependencies 24.01.2021 (also a72b31d5b606cece2188d03598d745e5659a8d1d)

Features

• Github Sponsor support. Consider to support this project via Github Sponsor or Paypal paypal.me/joseluisqs.
• 63a05faebf5bd584a555e78bf69cefd67e8b253b HTTP to HTTPS redirection support. PR #26 resolves #25 by @HenningHolmDE. See README file for more details.
• 77b07be018ef22894fc0337de6d70ae19067a5ae CLI argument aliases for some options. See README file for more details.

Refactorings

• 61d819da00ed621db2bf1a08acc04ea748750028 Minor server log info tweaks.
• d595219ee959a1f0d7eea7c438a8df93bb9a22d1 Prefer &[] instead of Vec ptr as arg type for on_server_running function.

Codebase

• f3008f36fe2957977b90e79d22a4452bc3ef5f77 Github Actions as new CI.

Updates

• c3583f3c29cad7de26d9bd9c5f8118254cfa3d9a Binaries compiled with latest Rust v1.49.0 release.
• 2732bd359ac3a4cca0de77048ef6fc9abaad9e70 Update dependencies 02.01.2021 (also acef3996d80d1baf123518da01f524bf362328ad, a7b3f40f01afb5e12e842440a15fbc12e3101c10)

Bug fixes

• c3583f3c29cad7de26d9bd9c5f8118254cfa3d9a Server error response during large file downloads (Macos/Linux). Issue #24 reported by @lukasa1993.
  The Rust 1.49.0 upgrade solves the issue which was published on 1.48.0

Features

• 62c8fc2a1a9293b1f13211276830cf8b78b91631 Alpine 1.12 Docker image.

Darwin

• Binary compiled on Mac OS X SDK 10.15 with a minimum 10.14 version. joseluisq/[email protected]

Binary sizes

• Linux: Static binary size has no changed (4.8M) on current version v1.12.0.
• Darwin: Dynamic binary size was decreased (0.1M). From 1.7M (v1.11.0) to 1.6M (current version v1.12.0)

Codebase

• 7581c99a9f5ed26c60047eda84bed0059b69739e Ignore some project directories.

Updates

• d4e32ca6771d6e6d24f4f79968645ac83695f421 Binaries compiled with latest Rust v1.47.0 release.
• dd20c3e9237bbc8b5607157c30af026ddc3b8406 Update dependencies 15.10.2020 (also d4e32ca6771d6e6d24f4f79968645ac83695f421, c4db7c6a9c6ef6715a306dcc44d7e14da5a419fa)

Improvements

• 6d3dc45b6b97ddafde7435c2111b9af98f8ae492 Shrink Darwin binary size.
• 2401b2471e539367508ffef220af4c9577c85b4f Include a SERVER_VERSION (server release version) env on every Docker image (also ee47f76bad9e947509ae23b0376ec5f2c6caa53c, 74040cfab7a60eb9c1ca0652f316dcb3316f4d15).

Binary sizes

• Linux: Static binary size was increased (0.5M). From 4.3M (v1.10.0) to 4.8M (current version v1.11.0)
• Darwin: Dynamic binary size was decreased (0.4M). From 2.1M (v1.10.0) to 1.7M (current version v1.11.0)

Codebase

• cbe17838c2ec84ce03012f5d22040e81c1e694f8 Automate Docker images versioning with Drone pipelines.

Updates

• ff2f2ba52e291847bdb19b0ca7c66ffbc81f766e Binaries compiled with latest Rust v1.44.1 release.
• 9732d477538496ad04d066299c3dcf551dccf7ca Update dependencies 07.07.2020 (also eb30e1114b847021882f7d87d95f0edd8dfa34ef)

Improvements

• 93aecf25e4c0cc0cf76ed0be3345d7ef7b826fba Use jemalloc as global allocator on Linux Musl 64-bit systems. Which increases the web server performance (also 0fda53f404337d5b6da91fb1ff361e95a44faeb1). See more details on PR #22.

Linux binary size

Static binary size was increased (0.2M). From 4.1M (v1.9.2) to 4.3M (current version v1.10.0)

Codebase

• 8e5a3c73ab4193622b7e4fcced93bcf78fda8e84 Refactor project dev structure.

Bugfixes

• 034263eebfb7272cdeb8f5981e9bb909b9c3074a Fix regression introduced by commit c0d2891 which displays wrong content type text/plain instead of text/html for 404/50x error pages.

Updates

• d87dafd3a2d7761210988c7488d05cd0e19656e6 Binaries compiled with latest Rust v1.43.1 release.
• 0d7038fb0c3ee09f5253066470e90d9a9016081b Update dependencies 08.06.20 (also 044b4a975da6034f3096924a5fe1b195bd9618be)

Improvements

• Update iron-staticfile-middleware to v0.4.2 which increases slightly performance on every check of text-based mime types array.

Refactors

• c0d28918d45f0b523cea50ebc51abb794c334334 Prefer const for the default content type on Error Page middeware.
• c3a7d73643a14bea4ae3f45a78fe68850f289982 Minor syntax improvements on the Gzip middeware and the Staticfile handler.
• f7564f65846601f02ba1c9eaf1e53e2cbcec50dc Remove unnecessary to_string conversion on server address.
• 23a6a15a7def6c1d2c2838ac08f56552e8704d09 Remove git tag latest of release tag target.

Features

• Binaries compiled with latest Rust v1.43.0 and OpenSSL v1.1.1g. More details on rust-linux-darwin-builder release.
• b2d2f40e30c4ca309d5fe8db9fddc5f167a33e9f Partial Content Delivery support. Which allows to serve bytes of large files. Resolves #15.
• 1af7d280132ebf42e7160d61f483c0fe5174236e CORS support via --cors-allow-origins option and its equivalent env. Resolves #18.
• ed94c4ba0f0fdf2859e44fc3f84bbd8686217d55 Enable Gzip compression only for known text-based file types. View file content types on issue #19.
• 77bf53829b7a713cd5130531e620547f8b2d6d55 Update dependencies 10.05.2020 (also b2d2f40e30c4ca309d5fe8db9fddc5f167a33e9f, 7a0fed08fd32f65f67bded2cf66f1de138813ef9)

Linux binary size

Static binary size was increased (0.1M). From 4.0M (v1.8.0) to 4.1M (current version v1.9.0)

Documentation

• e37d5136a3dd6d43a5e61965ca50f061a827a101 Corresponding documentation updates reflecting changes and features.

Codebase

• 1b1174d1d021d0959b04a6a8fe396436985cd365 Prefer const over static on default error page content.
• 4bda5f3280b387810c84fed7df5910544077ab6d Simplify Gzip middleware.
• 9a109d7244c9824ccc06bf8b4da68043ddbdb1b0 Staging CI pipeline.

Overview

This minor release v1.8.0 introduces the following:

• assets directory path configurable and independent (no more relative to the root). This contains a "breaking change". (Please see below).
• assets directory route is always the directory name. That means if you have /public/my-assets then the route will be /my-assets.
• New option for configurable logging levels. error log level by default. (More details below).

• Reply with an empty response body on HEAD requests.
• Skip Gzip compression on HEAD requests.
• root and assets directory paths checking before to start the server.
• Improve logging server information.

Please view the details involved about this minor release.

Features

• 2f7d042 - Configurable assets directory. (minor breaking change).
• 0dd2abe - Configurable logging levels (resolves #16) via --log-level option or its equivalent env. Now error log level is enabled by default. Use info level if you want requests details. Check out the documentation for more options.
• 0a9f66b - Update iron_staticfile_middleware to v0.3.0.
• 925c58a - Update dependencies (April 21th 2020).

Breaking change

This minor release contains one "breaking change" due to the feature "configurable assets directory" (2f7d042).

1. Configurable assets directory

This feature makes assets directory (--assets option and its equivalent SERVER_ASSETS env) configurable and independent.

It means that assets directory is no more restricted to be relative to root directory. So absolute paths work now.

1.1. Caveat and solution for relative assets directory

If you are using an assets directory path relative to root (v1.7.0 or early). For example if you have a root ./my-root and assets ./my-assets directories. Just adjust your assets directory path to ./my-root/my-assets or use another absolute path if you want.

This is necessary because from now, the assets directory is treated as an independent path. So an absolute path is recomendable for both directories (root and assets).

Otherwise, if you are using the default values provided by the server, you don't need to modify anything. Unless you had specified them yourself. If so, please proceed as explained above.

Refactorings

• 59777d7 - Empty response body on HEAD requests (also 07bf49b).
• 57184a5 - Skip Gzip compression on HEAD requests.
• e40016d - Root and assets directory paths checking.
• 597fa97 - Improve logging server information.

Documentation

New options and modifications details were updated, please take a look the documentation on README file.

• 8a5cf79 - Clarify assets default option value.
• 0767071 - Docker stack notes about assets directory functionality.

Codebase

• a449eb3 - Refactor path helpers implementation.
• 2e2a6ac - Simplify error page implementation.
• ff4ec6e - Static file unit test cases.
• 48b92ef - Skip files of Docker build context.

Features

• 052c18dda9ec138150e4c44c29902d82296e2235 Binaries compiled with latest Rust v1.42.0
• 4ae5b1a50b0f314df619d951fe72c6f2fccef84f Update dependencies (April 4th 2020)

Linux binary size

Static binary size was increased (0.1M). From 3.9M (v1.6.0) to 4.0M (current version v1.7.0)

Codebase

• 18a6cd58b49b5469d1ea6e92e6ddd6621da9419a - Simplify makefile build tagets. Includes checksum task (also 1c3abdf3b97d519add74e2bfb55e31aaba23bec9)
• Among other project structural improvements

Features

• d0e7a7fc05f74dbea760f7668acf76648248c3e5 Binaries compiled with latest Rust v1.41.1.
• a2a4e989a2f28ffe47ee479c5c7e6f680a3c920e Signals termination support. View feature issue #13 resolved by PR #14.
• 08d5847c96067d81fd71cf4bfff697dbe40425c4 Docker Alpine image upgraded to latest v3.11.
• 20b9fd25c98504a0ae68b6a002b5d76ba1b5fc9a Docker entrypoint shell script for Alpine image. It gives the ability to pass flag arguments on a docker run execution or via the command option in a docker-compose file. Example: docker run --rm static-web-server:alpine --help. Flag arguments (with dashes) will be passed to static-web-server, otherwise they will be treated as shell commands. Example of an interactive run: docker run --rm -it static-web-server:alpine sh.
• 881f37cc8b510699d578a51f0ebee551f755a102 Dependency updates 03.03.2020. (also a96e03194cc77414afeb15613ba20ec962be1a8e, c0e96e892eb78a1aaf423a54d59550b9e2216f61)

Linux binary size

Static binary size was reduced (0.3M). From 4.2M (v1.5.0) to 3.9M (current version v1.6.0)

Codebase

• bac391449dff3ef78665401bb16ba30e386ded86 openssl as dev-dependency vendored.
• 27dd9ff7b2fd8e25da09f909e0e03802515bc71d Update makefile cross-compiling tasks using rust-linux-darwin-builder (also 38808fb493535d3fa25610503560f4264ff931b8).
• 478d1009756ca2fe514ed857f60218998012ea6d Rename Docker file templates. (also ba105e451608f9312350040ccbbe773460fed5a7)
• 2adc5db8513b62bd660f85d117b59e418f6328b6 Relocate Docker templates version script.
• 34e0c597ec4a9e93ad0df20ebe39732c97a9942d Minor documentation updates.

Features

• 6dc5056e58e1b7312ce8e4625ed9a88c7b1e5b7a Feat: gzip compression on demand via accept-encoding header (PR #12 resolves #10).
• eaebf823320d63735465e05b6170c220e84cddfb Feat: Update dependencies Feb 02, 2020. It also resolves #11 head request method feature.

Features

• d195e74927d83f6f0165a3d5c241a064b0df7f63 Feat: Add TLS/SSL support (PR #9 resolves #2). Introducing three new options such as --tls, --tls-pkcs12 and --tls-pkcs12-passwd as well as their corresponding environment variables.
• 63f2c82f4434c6a942b4791da9bb0a92b5f38440 Docs: Add TLS/SSL section. View usage on readme file.
• 9c58c9cb3d0e695a7f229f5c39b446a3b1bcfab9 Feat: Update to latest dependencies Jun 15, 2020.
• Due TLS/SSL feature the Linux binary size has incremented (2,3MB) from 1.8MB to 4.1MB.

Misc

• cf0fb5349d64b1319805b6f1ee4147f3f302ea42 Docs: Update new options usage in readme file
• a7d55ade85d7a0e2e2716a0db8afaede7796491e Fix: Permissions for Rust project directory
• 86f8d8a7261246f597b42f7d12c87a9f9cace7df Feat: Add more sections to Cargo manifest file

Features

• 9179bc353e91cb119188b336b11a67d3b43ee1a5 Add binary support for Macos x86_64-apple-darwin thanks to Rust Linux / Darwin Builder. Resolves issue #8.
• 1509f5fb14aa1e021c77946739d441306e122c69 Update dependencies Jan 7, 2020

Misc

• 92b04e17de1246f24cc80a56c19798a2426d4832 Add Linux and Darwin makefile tasks
• a7a6d617c044b76686cb51363e3dd9223ddbe1ea Fix tarball and shrinking makefile tasks
• 56c425ad4c1dd66f3c8ab7abf6125d8271c1cf7c Remove Github release step from Drone pipeline