Struct General

Source

pub struct General {Show 57 fields
    pub host: String,
    pub port: u16,
    pub fd: Option<usize>,
    pub unix_socket: Option<PathBuf>,
    pub unix_socket_mode: Option<u32>,
    pub unix_socket_force: bool,
    pub threads_multiplier: usize,
    pub max_blocking_threads: usize,
    pub root: PathBuf,
    pub use_relative_root: bool,
    pub page50x: PathBuf,
    pub page404: PathBuf,
    pub page_fallback: PathBuf,
    pub log_level: String,
    pub log_format: LogFormat,
    pub log_with_ansi: bool,
    pub log_file: Option<PathBuf>,
    pub cors_allow_origins: String,
    pub cors_allow_headers: String,
    pub cors_expose_headers: String,
    pub tls: bool,
    pub tls_cert: Option<PathBuf>,
    pub tls_key: Option<PathBuf>,
    pub http2: bool,
    pub https_redirect: bool,
    pub https_redirect_host: String,
    pub https_redirect_from_port: u16,
    pub https_redirect_from_hosts: String,
    pub index_files: String,
    pub compression: bool,
    pub compression_level: CompressionLevel,
    pub compression_static: bool,
    pub directory_listing: bool,
    pub directory_listing_order: u8,
    pub directory_listing_format: DirListFmt,
    pub directory_listing_download: Vec<DirDownloadFmt>,
    pub security_headers: bool,
    pub cache_control_headers: bool,
    pub etag: bool,
    pub basic_auth: String,
    pub grace_period: u8,
    pub config_file: PathBuf,
    pub log_remote_address: bool,
    pub log_x_real_ip: bool,
    pub log_forwarded_for: bool,
    pub trusted_proxies: Vec<IpAddr>,
    pub redirect_trailing_slash: bool,
    pub include_hidden: bool,
    pub follow_symlinks: bool,
    pub accept_markdown: bool,
    pub text_charset: bool,
    pub health: bool,
    pub metrics: bool,
    pub maintenance_mode: bool,
    pub maintenance_mode_status: StatusCode,
    pub maintenance_mode_file: PathBuf,
    pub commands: Option<Commands>,
    /* private fields */
}

Expand description

General server configuration available in CLI and config file options.

Fields§

§host: String

Host address (E.g 127.0.0.1 or ::1)

§port: u16

Host port

§fd: Option<usize>

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.

§unix_socket: Option<PathBuf>

Available on Unix only.

Bind the server to a Unix Domain Socket (UDS) at the given filesystem path instead of a TCP host/port. Useful for reverse-proxy setups (e.g. nginx) on the same host where TCP/IP overhead is undesirable and filesystem-based access control is preferred. Cannot be combined with --host, --port, --fd, or TLS-related options. The socket file is removed on a graceful shutdown.

§unix_socket_mode: Option<u32>

Available on Unix only.

Filesystem permission bits applied to the Unix socket file after binding, expressed in octal (e.g. 660, 0660, or 0o660). When omitted the socket is created with the process umask. Only meaningful together with --unix-socket.

§unix_socket_force: bool

Available on Unix only.

When true, remove an existing socket file at --unix-socket before binding. This is useful when the server was previously killed abruptly and left a stale socket behind. Defaults to false to avoid clobbering an unrelated file.

§threads_multiplier: usize

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.

§max_blocking_threads: usize

Maximum number of blocking threads

§root: PathBuf

Root directory path of static files.

§use_relative_root: bool

Resolve the web root directory at request time rather than at startup, allowing symlinked root directories to be swapped at runtime.

§page50x: PathBuf

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. If a relative path is used then it will be resolved under the root directory.

§page404: PathBuf

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. If a relative path is used then it will be resolved under the root directory.

§page_fallback: PathBuf

Available on crate feature fallback-page only.

A HTML file path (not relative to the root) 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 doesn’t exist then the feature is not activated.

§log_level: String

Specify a logging level in lower case. Values: error, warn, info, debug or trace

§log_format: LogFormat

Specify the logging output format. Values: json (structured single-line JSON for production) or pretty (human-readable text for development)

§log_with_ansi: bool

Enable or disable ANSI escape codes for colors and other text formatting of the log output. Only effective when --log-format pretty is used.

§log_file: Option<PathBuf>

Optional filesystem path to stream log records to in addition to stderr. When set, logs are written asynchronously through a background worker thread (non-blocking I/O), so the request path is never delayed by disk writes. Missing parent directories are created on startup. ANSI escape codes are always disabled for file output regardless of --log-with-ansi. The file uses the format selected by --log-format (JSON by default). The file is opened in append mode and is not rotated by SWS, use an external tool (e.g. logrotate) for rotation.

§cors_allow_origins: String

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.

§cors_allow_headers: String

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.

§cors_expose_headers: String

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.

§tls: bool