//! The server CLI options use std::path::PathBuf; use structopt::StructOpt; use crate::directory_listing::DirListFmt; /// General server configuration available in CLI and config file options. #[derive(Debug, StructOpt)] #[structopt(about, author)] pub struct General { #[structopt(long, short = "a", default_value = "::", env = "SERVER_HOST")] /// Host address (E.g 127.0.0.1 or ::1) pub host: String, #[structopt(long, short = "p", default_value = "80", env = "SERVER_PORT")] /// Host port pub port: u16, #[structopt( long, short = "f", env = "SERVER_LISTEN_FD", conflicts_with_all(&["host", "port"]) )] /// Instead of binding to a TCP port, accept incoming connections to an already-bound TCP /// socket listener on the specified file descriptor number (usually zero). Requires that the /// parent process (e.g. inetd, launchd, or systemd) binds an address and port on behalf of /// static-web-server, before arranging for the resulting file descriptor to be inherited by /// static-web-server. Cannot be used in conjunction with the port and host arguments. The /// included systemd unit file utilises this feature to increase security by allowing the /// static-web-server to be sandboxed more completely. pub fd: Option, #[structopt( long, short = "n", default_value = "1", env = "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 one thread per core 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. pub threads_multiplier: usize, #[structopt(long, short = "d", default_value = "./public", env = "SERVER_ROOT")] /// Root directory path of static files. pub root: PathBuf, #[structopt( long, default_value = "./public/50x.html", env = "SERVER_ERROR_PAGE_50X" )] /// 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. pub page50x: PathBuf, #[structopt( long, default_value = "./public/404.html", env = "SERVER_ERROR_PAGE_404" )] /// 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. pub page404: PathBuf, #[structopt(long, env = "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. If the path is not specified or simply doesn't exist then this feature will not be active. pub page_fallback: Option, #[structopt(long, short = "g", default_value = "error", env = "SERVER_LOG_LEVEL")] /// Specify a logging level in lower case. Values: error, warn, info, debug or trace pub log_level: String, #[structopt( long, short = "c", default_value = "", env = "SERVER_CORS_ALLOW_ORIGINS" )] /// Specify an optional CORS list of allowed origin hosts separated by commas. Host ports or protocols aren't being checked. Use an asterisk (*) to allow any host. pub cors_allow_origins: String, #[structopt( long, short = "j", default_value = "origin, content-type", env = "SERVER_CORS_ALLOW_HEADERS" )] /// Specify an optional CORS list of allowed headers separated by commas. Default "origin, content-type". It requires `--cors-allow-origins` to be used along with. pub cors_allow_headers: String, #[structopt( long, default_value = "origin, content-type", env = "SERVER_CORS_EXPOSE_HEADERS" )] /// Specify an optional CORS list of exposed headers separated by commas. Default "origin, content-type". It requires `--cors-expose-origins` to be used along with. pub cors_expose_headers: String, #[structopt( long, short = "t", parse(try_from_str), default_value = "false", env = "SERVER_HTTP2_TLS" )] /// Enable HTTP/2 with TLS support. pub http2: bool, #[structopt(long, required_if("http2", "true"), env = "SERVER_HTTP2_TLS_CERT")] /// Specify the file path to read the certificate. pub http2_tls_cert: Option, #[structopt(long, required_if("http2", "true"), env = "SERVER_HTTP2_TLS_KEY")] /// Specify the file path to read the private key. pub http2_tls_key: Option, #[structopt( long, short = "x", parse(try_from_str), default_value = "true", env = "SERVER_COMPRESSION" )] /// Gzip, Deflate or Brotli compression on demand determined by the Accept-Encoding header and applied to text-based web file types only. pub compression: bool, #[structopt( long, parse(try_from_str), default_value = "false", env = "SERVER_COMPRESSION_STATIC" )] /// Look up the pre-compressed file variant (`.gz` or `.br`) on disk of a requested file and serves it directly if available. /// The compression type is determined by the `Accept-Encoding` header. pub compression_static: bool, #[structopt( long, short = "z", parse(try_from_str), default_value = "false", env = "SERVER_DIRECTORY_LISTING" )] /// Enable directory listing for all requests ending with the slash character (‘/’). pub directory_listing: bool, #[structopt( long, required_if("directory_listing", "true"), default_value = "6", env = "SERVER_DIRECTORY_LISTING_ORDER" )] /// Specify a default code number to order directory listing entries per `Name`, `Last modified` or `Size` attributes (columns). Code numbers supported: 0 (Name asc), 1 (Name desc), 2 (Last modified asc), 3 (Last modified desc), 4 (Size asc), 5 (Size desc). Default 6 (unordered) pub directory_listing_order: u8, #[structopt( long, required_if("directory_listing", "true"), possible_values = &DirListFmt::variants(), default_value = "html", env = "SERVER_DIRECTORY_LISTING_FORMAT", case_insensitive = true )] /// Specify a content format for directory listing entries. Formats supported: "html" or "json". Default "html". pub directory_listing_format: DirListFmt, #[structopt( long, parse(try_from_str), required_if("http2", "true"), default_value_if("http2", Some("true"), "true"), default_value = "false", env = "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'". pub security_headers: bool, #[structopt( long, short = "e", parse(try_from_str), default_value = "true", env = "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 `src/control_headers.rs` file. pub cache_control_headers: bool, /// It provides The "Basic" HTTP Authentication scheme using credentials as "user-id:password" pairs. Password must be encoded using the "BCrypt" password-hashing function. #[structopt(long, default_value = "", env = "SERVER_BASIC_AUTH")] pub basic_auth: String, #[structopt(long, short = "q", default_value = "0", env = "SERVER_GRACE_PERIOD")] /// Defines a grace period in seconds after a `SIGTERM` signal is caught which will delay the server before to shut it down gracefully. The maximum value is 255 seconds. pub grace_period: u8, #[structopt(long, short = "w", env = "SERVER_CONFIG_FILE")] /// Server TOML configuration file path. pub config_file: Option, #[structopt( long, parse(try_from_str), default_value = "false", env = "SERVER_LOG_REMOTE_ADDRESS" )] /// Log incoming requests information along with its remote address if available using the `info` log level. pub log_remote_address: bool, #[structopt( long, parse(try_from_str), default_value = "true", env = "SERVER_REDIRECT_TRAILING_SLASH" )] /// Check for a trailing slash in the requested directory URI and redirect permanently (308) to the same path with a trailing slash suffix if it is missing. pub redirect_trailing_slash: bool, #[structopt( long, parse(try_from_str), default_value = "false", env = "SERVER_IGNORE_HIDDEN_FILES" )] /// Ignore hidden files/directories (dotfiles), preventing them to be served and being included in auto HTML index pages (directory listing). pub ignore_hidden_files: bool, // // Windows specific arguments and commands // #[cfg(windows)] #[structopt( long, short = "s", parse(try_from_str), default_value = "false", env = "SERVER_WINDOWS_SERVICE" )] /// Tell the web server to run in a Windows Service context. Note that the `install` subcommand will enable this option automatically. pub windows_service: bool, // Windows commands #[cfg(windows)] #[structopt(subcommand)] pub commands: Option, } #[cfg(windows)] #[derive(Debug, StructOpt)] pub enum Commands { /// Install a Windows Service for the web server. #[structopt(name = "install")] Install {}, /// Uninstall the current Windows Service. #[structopt(name = "uninstall")] Uninstall {}, }