Struct Config

pub struct Config {

    pub name: String,
    pub description: String,
    pub color: String,
    pub port: u16,
    pub banned_hosts: Vec<String>,
    pub host: String,
    pub lw_host: String,
    pub security: SecurityConfig,
    pub dirs: DirsConfig,
    pub database: DatabaseConfig,
    pub no_track: Vec<String>,
    pub banned_usernames: Vec<String>,
    pub policies: PoliciesConfig,
    pub turnstile: TurnstileConfig,
    pub town_square: usize,
    pub town_square_forum: usize,
    pub town_square_forum_topic: usize,
    pub system_user: usize,
    pub connections: ConnectionsConfig,
    pub html_footer_path: String,
    pub stripe: Option<StripeConfig>,
    pub manuals: ManualsConfig,
    pub banned_data: Vec<StringBan>,
    pub enable_user_ads: bool,
}

Configuration file

Fields

name: String

The name of the app.

description: String

The description of the app.

color: String

The theme color of the app.

port: u16

The port to serve the server on.

banned_hosts: Vec<String>

A list of hosts which cannot be proxied through the image proxy.

They will return the default banner image instead of proxying.

It is recommended to put the host of your own public server in this list in order to prevent a way too easy DOS.

host: String

The main public host of the server. Not used to check against banned hosts, so this host should be included in there as well.

lw_host: String

The main public host of the littleweb server. Not used to check against banned hosts, so this host should be included in there as well.

security: SecurityConfig

Database security.

dirs: DirsConfig

The locations where different files should be matched.

database: DatabaseConfig

Database configuration.

no_track: Vec<String>

A list of files (just their name, no full path) which are NOT updated to match the version built with the server binary.

banned_usernames: Vec<String>

A list of usernames which cannot be used. This also includes community names.

policies: PoliciesConfig

Configuration for your site’s policies (terms of service, privacy).

turnstile: TurnstileConfig

Configuration for Cloudflare Turnstile.

town_square: usize

The ID of the “town square” community. This community is required to allow people to post from their profiles.

This community must have open write access.

town_square_forum: usize

The ID of the town square forum community.

town_square_forum_topic: usize

The ID of the topic within the town square forum community that users are prompted to post in by default. This should be some sort of “general” topic.

system_user: usize

The ID of the “system” user which will send system mails to users.

connections: ConnectionsConfig

html_footer_path: String

The path to the HTML footer file. The contents of this file are embedded into every HTML template. They support access to template fields like {{ user }}.

stripe: Option<StripeConfig>

manuals: ManualsConfig

The relative paths to manuals.

banned_data: Vec<StringBan>

A list of banned content in posts.

enable_user_ads: bool

If user ads are enabled.

Implementations

impl Config

pub fn read(contents: String) -> Self

Read configuration file into Config

pub fn get_config() -> Self

Pull configuration file

pub fn update_config(contents: Self) -> Result<()>

Update configuration file

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for Config

fn db_config(&self) -> DatabaseConfig

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.