/>A blazing fast and asynchronous web server for static files-serving ⚡[](https://github.com/joseluisq/static-web-server/actions?query=workflow%3ACI) [](https://hub.docker.com/r/joseluisq/static-web-server/) [](https://hub.docker.com/r/joseluisq/static-web-server/tags) [](https://hub.docker.com/r/joseluisq/static-web-server/)Static Web Server (or SWS abbreviated) is a very small and fast production-ready web server suitable to serve static web files or assets.--------------------------------------------------| `SERVER_PORT` | Host port | Default `80`. || `SERVER_LISTEN_FD` | Optional file descriptor number (e.g. `0`) to inherit an already-opened TCP listener on (instead of using `SERVER_HOST` and/or `SERVER_PORT` ). || `SERVER_ROOT` | Root directory path of static files | Default `./public`. || `SERVER_LOG_LEVEL` | Specify a logging level in lower case. (Values `error`, `warn`, `info`, `debug`, `trace`). | Default `error` || `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_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_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. || `SERVER_HTTP2_TLS` | Enable HTTP/2 with TLS support. Make sure also to adjust current server port. | Default `false` || `SERVER_HTTP2_TLS_CERT` | Specify the file path to read the certificate. | Default empty || `SERVER_HTTP2_TLS_KEY` | Specify the file path to read the private key. | Default empty || `SERVER_CORS_ALLOW_ORIGINS` | Specify a 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. | Default empty (which means CORS is disabled) || `SERVER_COMPRESSION` | Gzip, Deflate or Brotli compression on demand determined by the *Accept-Encoding* header and applied to text-based web file types only. See | Default `true` (enabled) || `SERVER_DIRECTORY_LISTING` | Enable directory listing for all requests ending with the slash character (‘/’) | Default `false` (disabled) || `SERVER_SECURITY_HEADERS` | Enable security headers by default when HTTP/2 feature is activated. Headers included: `Strict-Transport-Security: max-age=63072000; includeSubDomains; preload` (2 years max-age), `X-Frame-Options: DENY`, `X-XSS-Protection: 1; mode=block` and `Content-Security-Policy: frame-ancestors 'self'` | Default `false` (disabled) || `SERVER_CACHE_CONTROL_HEADERS` | Enable cache control headers for incoming requests based on a set of file types. The file type list can be found on file. | Default `true` (enabled) || `SERVER_BASIC_AUTH` | It provides using credentials as `user-id:password` pairs, encoded using `Base64`. Password must be encoded using the password-hashing function. | Default empty (disabled) |static-web-server 2.0.3Jose Quintana <https://git.io/joseluisq>A blazing fast and asynchronous web server for static files-serving.USAGE:static-web-server [OPTIONS]FLAGS:-h, --help Prints help information-V, --version Prints version informationOPTIONS:--basic-auth <basic-auth>It provides The "Basic" HTTP Authentication scheme using credentials as "user-id:password" pairs. Passwordmust be encoded using the "BCrypt" password-hashing function [env: SERVER_BASIC_AUTH=] [default: ]-e, --cache-control-headers <cache-control-headers>Enable cache control headers for incoming requests based on a set of file types. The file type list can befound on `src/control_headers.rs` file [env: SERVER_CACHE_CONTROL_HEADERS=] [default: true]-x, --compression <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]-c, --cors-allow-origins <cors-allow-origins>Specify an optional CORS list of allowed origin hosts separated by comas. Host ports or protocols aren'tbeing checked. Use an asterisk (*) to allow any host [env: SERVER_CORS_ALLOW_ORIGINS=] [default: ]-z, --directory-listing <directory-listing>Enable directory listing for all requests ending with the slash character (‘/’) [env:SERVER_DIRECTORY_LISTING=] [default: false]-f, --fd <fd>Instead of binding to a TCP port, accept incoming connections to an already-bound TCP socket listener on thespecified file descriptor number (usually zero). Requires that the parent process (e.g. inetd, launchd, orsystemd) binds an address and port on behalf of static-web-server, before arranging for the resulting filedescriptor to be inherited by static-web-server. Cannot be used in conjunction with the port and hostarguments. The included systemd unit file utilises this feature to increase security by allowing the static-web-server to be sandboxed more completely [env: SERVER_LISTEN_FD=]-a, --host <host>Host address (E.g 127.0.0.1 or ::1) [env: SERVER_HOST=] [default: ::]-t, --http2 <http2>Enable HTTP/2 with TLS support [env: SERVER_HTTP2_TLS=] [default: false]--http2-tls-cert <http2-tls-cert>Specify the file path to read the certificate [env: SERVER_HTTP2_TLS_CERT=] [default: ]--http2-tls-key <http2-tls-key>Specify the file path to read the private key [env: SERVER_HTTP2_TLS_KEY=] [default: ]-g, --log-level <log-level>Specify a logging level in lower case. Values: error, warn, info, debug or trace [env: SERVER_LOG_LEVEL=][default: error]--page404 <page404>HTML file path for 404 errors. If path is not specified or simply don't exists then server will use ageneric HTML error message [env: SERVER_ERROR_PAGE_404=] [default: ./public/404.html]--page50x <page50x>HTML file path for 50x errors. If path is not specified or simply don't exists then server will use ageneric HTML error message [env: SERVER_ERROR_PAGE_50X=] [default: ./public/50x.html]-p, --port <port> Host port [env: SERVER_PORT=] [default: 80]-d, --root <root>Root directory path of static files [env: SERVER_ROOT=] [default: ./public]--security-headers <security-headers>Enable security headers by default when HTTP/2 feature is activated. Headers included: "Strict-Transport-Security: max-age=63072000; includeSubDomains; preload" (2 years max-age), "X-Frame-Options: DENY", "X-XSS-Protection: 1; mode=block" and "Content-Security-Policy: frame-ancestors'self'" [env: SERVER_SECURITY_HEADERS=] [default: false]-n, --threads-multiplier <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 0or 1 then one thread per core is used. Number of worker threads result should be a number between 1 and32,768 though it is advised to keep this value on the smaller side [env: SERVER_THREADS_MULTIPLIER=][default: 1]using `inetd`, its "`wait`" option should be used in conjunction with static-web-server's `--fd 0`option.useful - especially for testing e.g. `systemfd --no-pid -s http::8091 -- path/to/static-web-server --fd 0`# Scratch image (just the binary)# Or Alpine image# Scratch image (just the binary)FROM joseluisq/static-web-server:2# Or Alpine imageFROM joseluisq/static-web-server:2-alpineversion: "3.3"services:web:image: joseluisq/static-web-server:2environment:# Note: those envs are customizable but also optional- SERVER_HOST=127.0.0.1- SERVER_PORT=80- SERVER_ROOT=/publicvolumes:- ./some-dir-path:/publiclabels:- "traefik.enable=true"- "traefik.frontend.entryPoints=https"- "traefik.backend=localhost_dev"- "traefik.frontend.rule=Host:localhost.dev"- "traefik.port=80"networks:- traefik_netnetworks:traefik_net:external: true
index : static-web-server.git
ascending towards madness