Skip to main content

ServerConfig

Struct ServerConfig 

Source
pub struct ServerConfig {
Show 17 fields pub bind: String, pub auth_token: Option<SecretString>, pub content_token_secret: SecretString, pub writer_id: String, pub runtime_cache: RuntimeCacheConfigOverrides, pub grep: GrepConfig, pub maintenance: MaintenanceMode, pub min_publish_interval_ms: u64, pub max_upload_bytes: u64, pub max_download_bytes: u64, pub max_concurrent_uploads: usize, pub max_concurrent_downloads: usize, pub max_concurrent_maintenance: usize, pub allow_unauthenticated_remote: bool, pub allow_remote_without_tls: bool, pub tls: Option<TlsServerConfig>, pub store: StoreConfig,
}
Expand description

The server config file.

§Secret precedence

auth_token and content_token_secret may be supplied through the LOONFS_AUTH_TOKEN and LOONFS_CONTENT_TOKEN_SECRET environment variables instead of the file, and the S3-compatible store credentials through the standard AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN. A non-blank value in the file always takes precedence; the environment variable fills the field only when the file leaves it unset (blank environment values are ignored).

Fields§

§bind: String§auth_token: Option<SecretString>§content_token_secret: SecretString

Signs content tokens; unset or empty here falls back to LOONFS_CONTENT_TOKEN_SECRET.

§writer_id: String§runtime_cache: RuntimeCacheConfigOverrides§grep: GrepConfig

What this server does about grep, plus the bounded-step budgets its index maintenance runs under. A config with no [grep] table composes no grep at all; a table that names no mode both serves queries and maintains the index.

§maintenance: MaintenanceMode

Whether this server maintains the namespaces it touches by itself. Automatic by default; see MaintenanceMode.

§min_publish_interval_ms: u64

Minimum interval between publication starts per namespace, in milliseconds. A cold namespace publishes immediately; the interval paces follow-up batches so hot namespaces amortize into fewer, larger WAL segments. The server default favors batch economy over the embedded default’s latency bias.

§max_upload_bytes: u64

Largest request body accepted for service-proxied upload content requests (PUT .../uploads/{upload_id}/content). Enforced incrementally while the body streams to the store, so it bounds the accepted transfer size, not per-request memory (streamed writes hold at most one internal part). Clients may use direct_put or direct multipart for larger transfers when the capability is advertised. Advertised as the upload.max_content_bytes capability limit.

§max_download_bytes: u64

Largest file content a service-proxied read (GET .../filesystem/ content and inode revision content) will buffer and return. Checked against resolved metadata before any content fetch; over-limit reads answer content_too_large. Advertised to clients as the download.max_content_bytes capability limit.

§max_concurrent_uploads: usize

How many proxied upload bodies the server will stream at once; requests past the cap answer server_busy before any transfer. Worst-case upload memory is this times one streamed part, since bodies forward to the store incrementally instead of buffering.

§max_concurrent_downloads: usize

How many proxied content reads the server will materialize at once; requests past the cap answer server_busy before any fetch. Worst-case download memory is this times max_download_bytes.

§max_concurrent_maintenance: usize

How many writer-scheduled maintenance steps may run at once across every job and namespace. Each job runs at most one step per namespace at a time; this bounds the fan-out when a write burst crosses thresholds in many namespaces together. A step that waits for a permit takes the next one that frees.

§allow_unauthenticated_remote: bool

Allows serving on a non-loopback address with auth_token unset. Off by default: exposing every endpoint unauthenticated is almost always a misconfiguration, so validation rejects it unless this is explicitly set.

§allow_remote_without_tls: bool

Allows serving on a non-loopback address in plaintext. Off by default for the same reason as allow_unauthenticated_remote: the wire carries the bearer token and the presigned object-store URLs the upload routes hand back, so plaintext beyond localhost is almost always a misconfiguration rather than a choice. Set it where TLS terminates in front of this process.

§tls: Option<TlsServerConfig>

Terminates TLS in this process when present. Absent means plaintext HTTP, which validation only accepts on a loopback bind or with allow_remote_without_tls.

§store: StoreConfig

Implementations§

Trait Implementations§

Source§

impl Clone for ServerConfig

Source§

fn clone(&self) -> ServerConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more