Struct SettingsWeb 

pub struct SettingsWeb {
    pub auto_start: bool,
    pub base_path: String,
    pub bind_address: String,
    pub bind_port: i64,
    pub log_lines: i64,
    pub port_attempts: i64,
    pub sse_poll_interval: String,
}

The web.* (web UI) settings.

Fields

auto_start: bool

Automatically start web UI when supervisor starts

When enabled, the web UI server will automatically start alongside the supervisor.

By default, this is disabled. You can also start the web UI manually with:

pitchfork supervisor start --web-port=3120

base_path: String

URL path prefix for the web UI (e.g. “ps” serves at /ps/)

Serves the web UI under a sub-path prefix, useful when running behind a reverse proxy that routes a path prefix to pitchfork.

Examples:

• "" - Serve at root / (default)
• "ps" - Serve at /ps/
• "tools/pitchfork" - Serve at /tools/pitchfork/

Equivalent to the --web-path CLI flag. The CLI flag takes priority over this setting.

bind_address: String

Web server bind address

IP address for the web UI to listen on.

Security Warning: The default 127.0.0.1 only allows local connections. Setting this to 0.0.0.0 will expose the web UI to your network.

Examples:

• "127.0.0.1" - Local only (default, recommended)
• "0.0.0.0" - All interfaces (use with caution)
• "192.168.1.100" - Specific interface

bind_port: i64

Default web server port

The port number for the web UI. If this port is in use, pitchfork will try subsequent ports up to port_attempts times.

log_lines: i64

Initial number of log lines to display

How many lines of logs to show initially when viewing daemon logs in the web UI. More lines means slower initial load but more history visible.

port_attempts: i64

Number of ports to try if default is in use

If the default port is occupied, pitchfork will try this many consecutive ports before giving up.

For example, with bind_port = 3120 and port_attempts = 10, it will try ports 3120, 3121, 3122, … up to 3129.

sse_poll_interval: String

Server-Sent Events poll interval for log streaming

How often the web UI checks for new log lines when streaming logs. Lower values provide more real-time updates but use more resources.

Implementations

impl SettingsWeb

pub const SETTINGS_PROPS: &'static [PropMeta] = <Self as ::usage_config::Props>::PROPS

Every setting this struct declares, one entry per field, flattened groups included. The registry a build.rs used to generate, generated from the struct instead — there is no second declaration to keep in step.

pub const SETTINGS_REGISTRY: Registry

The registry over Self::SETTINGS_PROPS, for resolve, drift, and the layers.

pub const SETTINGS_SPEC: ConfigSpec

Metadata used only when lowering this declaration into a usage spec.

pub fn read(__usage_resolved: &Resolved) -> Result<Self, ReadErrors>

This resolution’s values, as the struct.

Every field is read before anything is returned, so the error is the whole list of what is wrong rather than the first thing found.

pub fn read_lossy(__usage_resolved: &Resolved) -> (Option<Self>, ReadErrors)

This resolution’s values, keeping every setting that reads.

Self::read is all or nothing, which leaves a CLI two moves when one field is bad: refuse to start, or fall back to a struct of declared defaults and lose the environment and every config file along with the offending value. Neither is a choice this crate should be making.

So: a field that will not read falls back to its own declared default and the rest keep what the merge gave them, with every failure returned alongside for the CLI to raise, log, or ignore as it sees fit. The errors are the same ::usage_config::ReadErrors Self::read returns, so a caller that decides a bad value is fatal has lost nothing by asking.

None only where a setting has no value and no declared default — a hole in the declaration rather than a bad value, and nothing to fall back to.

pub fn spec_kdl() -> String

The spec config block for these settings, as KDL.

What documents, JSON schema and completions read. A CLI deriving usage::Cli names this type in #[usage(config = ...)] instead of calling this, and its to_kdl carries the block.

Trait Implementations

impl Clone for SettingsWeb

fn clone(&self) -> SettingsWeb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsWeb

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

Formats the value using the given formatter.

impl PartialEq for SettingsWeb

fn eq(&self, other: &SettingsWeb) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Props for SettingsWeb

const PROPS: &'static [PropMeta]

This group’s settings, in declaration order.

const PROP_SPECS: &'static [PropSpec]

Spec-only metadata parallel to Props::PROPS.

impl StructuralPartialEq for SettingsWeb