Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub addr: SocketAddr,
    pub database_url: String,
    pub agents: String,
    pub max_batch_days: usize,
    pub max_body_bytes: usize,
    pub admin: String,
    pub admin_email: String,
    pub secure_cookies: bool,
    pub demo: bool,
}
Expand description

Runtime configuration, read from the environment.

Fields§

§addr: SocketAddr

Address the HTTP server binds to (KASL_SERVER_ADDR).

§database_url: String

PostgreSQL connection string (DATABASE_URL).

§agents: String

Agents to provision on startup (KASL_AGENTS), as email:token pairs. The bootstrap way in until the admin UI issues tokens.

§max_batch_days: usize

Days one batch upload may carry (KASL_MAX_BATCH_DAYS).

§max_body_bytes: usize

Largest request body accepted (KASL_MAX_BODY_BYTES).

§admin: String

Bootstrap administrator (KASL_ADMIN), as email:password.

§admin_email: String

Email for the administrator generated on a first run (KASL_ADMIN_EMAIL).

Only used when KASL_ADMIN is unset and the installation has no administrator at all: the server makes one with a random password and prints it once. The default is deliberately obvious rather than clever - an operator who never sets this should still recognize the account.

§secure_cookies: bool

Whether session cookies carry Secure (KASL_SECURE_COOKIES).

On by default, because a server holding a team’s hours belongs behind TLS. Turned off only for a stand reached over plain http, where a Secure cookie is dropped by the browser and login silently does nothing at all.

§demo: bool

Whether to seed a fictional team on an empty database (KASL_DEMO).

Off by default. On, the server fills an empty database with the demo team and refuses to start on one that holds anybody real (ADR 0013).

Implementations§

Source§

impl Config

Source

pub fn from_env() -> Result<Self>

Source

pub fn defaults_for_database(database_url: String) -> Self

A configuration with every limit at its default. Used where the limits are not the subject - the router built for tests, for instance - so the defaults live in one place rather than being restated.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

Formats the value using the given formatter. 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> 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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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