Struct Config

pub struct Config {

    pub port: u16,
    pub name: String,
    pub description: String,
    pub static_dir: PathBufD,
    pub media_dir: PathBufD,
    pub captcha: HCaptchaConfig,
    pub real_ip_header: Option<String>,
    pub registration_enabled: bool,
    pub host: String,
    pub snowflake_server_id: usize,
    pub blocked_hosts: Vec<String>,
    pub tiers: Tiers,
    pub alert: String,
    pub templates: TemplatesConfig,
    pub plugin_verify: bool,
}

Configuration file

Fields

port: u16

The port to serve the server on

name: String

The name of the site

description: String

The description of the site

static_dir: PathBufD

The location of the static directory, should not be supplied manually as it will be overwritten with ./.config/static

media_dir: PathBufD

The location of media uploads on the file system

captcha: HCaptchaConfig

HCaptcha configuration

real_ip_header: Option<String>

The name of the header used for reading user IP address

registration_enabled: bool

If new profile registration is enabled

host: String

The origin of the public server (ex: “https://rainbeam.net”)

Used in embeds and links.

snowflake_server_id: usize

The server ID for ID generation

blocked_hosts: Vec<String>

A list of image hosts that are blocked

tiers: Tiers

Tiered benefits

alert: String

A global site announcement shown at the top of the page

templates: TemplatesConfig

Template configuration.

plugin_verify: bool

If plugins are verified through Neospring assets. Disabling this removed plugin verification, but will ensure your server doesn’t communicate with the main Neospring server at all.

Implementations

impl Config

pub fn read(contents: String) -> Config

Read configuration file into Config

pub fn get_config() -> Config

Pull configuration file

pub fn update_config(contents: Config) -> Result<(), Error>

Update configuration file

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.