Struct df_st_core::config::ServerConfig

pub struct ServerConfig {
    pub address: Option<String>,
    pub port: Option<u16>,
    pub workers: Option<u16>,
    pub keep_alive: Option<u32>,
    pub log_level: Option<String>,
    pub secret_key: Option<String>,
    pub tls: Option<TLSConfig>,
    pub limits: Option<LimitsConfig>,
}

Everything in the configuration under df_storyteller-config.json.server.

Fields

address: Option<String>

Default is set to "127.0.0.1". To allow other devices to access the API use "0.0.0.0". Note: This comes with some advantages and security implications, like allowing traffic from other devices on the network (example phones). But if device is not behind NAT or port forwarding is set up, This can expose the interface to the internet and should be avoided! Using "localhost" or "127.0.0.1" can prevent these security implications. DO NOT USE "0.0.0.0" WHEN YOU ARE ON PUBLIC WIFI!

port: Option<u16>

Default is set to 20350

workers: Option<u16>

Default is set to None, if None, uses Rocket default = [number_of_cpus * 2]

keep_alive: Option<u32>

Default is set to None

log_level: Option<String>

This only effects logging from Rocket (server), not DF_Storyteller Allowed values: "Critical", "Normal", "Debug" and "Off" Default is set to None

secret_key: Option<String>

Secret key for private cookies. Should not be set in almost all cases. From Rocket Docs:

When manually specifying the secret key, the value should a 256-bit base64 encoded string. Such a string can be generated with the openssl command line tool: openssl rand -base64 32

If set this should be exactly 44 chars long. Default is None.

tls: Option<TLSConfig>

Set TLS settings, if not set, no TLS is used (just HTTP, no HTTPS) Default is None.

limits: Option<LimitsConfig>

Map from data type (string) to data limit (integer: bytes) The maximum size in bytes that should be accepted by a Rocket application for that data type. For instance, if the limit for "forms" is set to 256, only 256 bytes from an incoming form request will be read. Default is None.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy 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 PartialEq<ServerConfig> for ServerConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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.

impl StructuralPartialEq for ServerConfig