Struct ServeArgs 

pub struct ServeArgs {

    pub listen: String,
    pub auth_token: Option<String>,
    pub no_auth: bool,
    pub auth_config: Option<PathBuf>,
    pub max_concurrent_runs: Option<usize>,
    pub max_queued_runs: Option<usize>,
    pub default_config: Option<PathBuf>,
    pub history: Option<String>,
    pub cors_origin: Vec<String>,
    pub body_limit_bytes: usize,
    pub shutdown_grace_secs: u64,
    pub retain_terminal_runs_secs: u64,
    pub idempotency_retention_secs: u64,
    pub lease_ttl_secs: u64,
    pub probe_timeout_secs: u64,
    pub env_file: Option<PathBuf>,
    pub no_env_file: bool,
    pub no_ui: bool,
    pub cluster: bool,
    pub cluster_poll_secs: u64,
    pub cluster_max_attempts: u32,
    pub triggers: Option<PathBuf>,
    pub mcp: bool,
    pub mcp_allow_mutations: bool,
}

Available on crate feature serve only.

faucet serve arguments.

Fields

listen: String

Bind address. Defaults to loopback; set 0.0.0.0:PORT to expose externally.

auth_token: Option<String>

Bearer token required on /v1/* requests. Prefer the env var (avoids ps leakage).

no_auth: bool

Explicitly disable authentication. Required if no token is set, so an unauthenticated server is never accidental.

auth_config: Option<PathBuf>

Path to an RBAC auth config (YAML/JSON) defining principals — each a { name, token, role } where role is viewer / operator / admin. Enables role-based access control + an audit log. Mutually exclusive with --auth-token / --no-auth.

max_concurrent_runs: Option<usize>

Max pipeline runs executing at once. Default: min(16, cpu count).

max_queued_runs: Option<usize>

Max queued (not-yet-running) runs before POST /v1/runs returns 429. Default: 8 × max-concurrent-runs.

default_config: Option<PathBuf>

Workspace-default config merged under every submitted run.

history: Option<String>

Run-history backend URL: omitted = in-memory; postgres://… ; sqlite:… .

cors_origin: Vec<String>

CORS allow-list origin (repeatable). Omitted = CORS disabled.

body_limit_bytes: usize

Max POST /v1/runs body size in bytes (413 on exceed).

shutdown_grace_secs: u64

SIGTERM/SIGINT drain window in seconds.

retain_terminal_runs_secs: u64

Retain terminal run records this long (seconds).

idempotency_retention_secs: u64

Idempotency-key replay window (seconds).

lease_ttl_secs: u64

Run-ownership lease TTL in seconds (multi-instance orphan fencing). A run is owned by the instance executing it and its lease is heartbeated at ~⅓ of this interval; only a run whose lease has expired (owner presumed dead) is recovered as failed. Make this comfortably larger than expected GC/IO stalls so a healthy-but-slow instance is never falsely reclaimed. Only relevant with a persistent (postgres/sqlite) history backend.

probe_timeout_secs: u64

Per-probe timeout for doctor_first preflight (seconds).

env_file: Option<PathBuf>

Path to a .env file loaded for the server’s own startup interpolation.

no_env_file: bool

Skip auto-loading .env from cwd at startup.

no_ui: bool

Disable serving the embedded web console (only meaningful in a build that includes the serve-ui feature; the API is unaffected).

cluster: bool

Enable clustered execution: run a claim loop that pulls Pending runs from the shared history DB so N instances pull-balance and fail over. Requires a postgres/sqlite –history backend.

cluster_poll_secs: u64

Claim-loop poll interval (seconds) in cluster mode. Also the cross-instance cancel-propagation lag. Must be > 0.

cluster_max_attempts: u32

Max failover re-runs of an orphaned run before it is marked Failed (poison). Must be > 0.

triggers: Option<PathBuf>

Path to a triggers file (YAML/JSON) defining event-driven pipeline triggers (object-arrival / webhook / queue-depth). Requires a build with the triggers feature. See faucet schema triggers.

mcp: bool

Mount the MCP (Model Context Protocol) endpoint at /mcp, exposing faucet as agent tool calls. Effective only in a build with the mcp feature; the endpoint inherits serve’s bearer-auth + RBAC + audit.

mcp_allow_mutations: bool

Allow the MCP endpoint’s mutating tools (run_pipeline). Off by default: only read-only tools are exposed. A caller still needs the RunWrite RBAC scope. Only meaningful together with --mcp.

Trait Implementations

impl Args for ServeArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for ServeArgs

fn clone(&self) -> ServeArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ServeArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ServeArgs

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

Formats the value using the given formatter.

impl FromArgMatches for ServeArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ServeArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.