Struct ServerConfig 

pub struct ServerConfig {

    pub bind_to: String,
    pub proxy_url: String,
    pub include_paths: Vec<String>,
    pub exclude_paths: Vec<String>,
    pub enable_websocket: bool,
    pub forward_get_only: bool,
    pub cache_404_capacity: usize,
    pub use_404_meta: bool,
    pub cache_strategy: CacheStrategy,
    pub compress_strategy: CompressStrategy,
    pub cache_storage_mode: CacheStorageMode,
    pub cache_directory: Option<PathBuf>,
    pub proxy_mode: ProxyModeConfig,
    pub pre_generate_paths: Vec<String>,
    pub pre_generate_fallthrough: bool,
}

Per-server configuration block (one [server.NAME] entry).

Fields

bind_to: String

Axum router mount point.

• "*" (default): catch-all fallback, bound via Router::fallback_service.
• Any other value (e.g. "/api"): specific prefix, bound via Router::nest.

When multiple specific paths are registered, longer paths are nested first so Axum can match them before shorter prefixes.

Note: Router::nest strips the prefix before the inner proxy handler sees the path. Set proxy_url accordingly if the upstream expects the full path.

proxy_url: String

The URL of the backend to proxy to.

include_paths: Vec<String>

Paths to include in caching (empty means include all). Supports wildcards: ["/api/*", "/*/users"]

exclude_paths: Vec<String>

Paths to exclude from caching (empty means exclude none). Supports wildcards: ["/admin/*", "/*/private"]. Exclude overrides include.

enable_websocket: bool

Enable WebSocket / protocol-upgrade support (default: true).

When true, upgrade requests bypass the cache and establish a direct bidirectional TCP tunnel to the backend — but only when the proxy mode supports it (i.e. Dynamic, or PreGenerate with pre_generate_fallthrough = true). Pure SSG servers (proxy_mode = "pre_generate" with the default pre_generate_fallthrough = false) always return 501 for upgrade requests, regardless of this flag.

forward_get_only: bool

Only allow GET requests, reject all others (default: false).

cache_404_capacity: usize

Capacity for the 404 cache (default: 100).

use_404_meta: bool

Detect 404 pages via <meta name="phantom-404"> in addition to HTTP status.

cache_strategy: CacheStrategy

Controls which response types should be cached.

compress_strategy: CompressStrategy

Controls how cached responses are compressed in memory.

cache_storage_mode: CacheStorageMode

Controls where cached response bodies are stored.

cache_directory: Option<PathBuf>

Optional directory override for filesystem-backed cache bodies.

proxy_mode: ProxyModeConfig

Proxy operating mode. Set to "pre_generate" to enable SSG mode.

pre_generate_paths: Vec<String>

Paths to pre-generate at startup when proxy_mode = "pre_generate".

pre_generate_fallthrough: bool

In PreGenerate mode, fall through to the upstream backend on a cache miss. Defaults to false (return 404 on miss).

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.