crates/utils/src/settings/structs.rs

   1 use doku::Document;
   2 use serde::{Deserialize, Serialize};
   3 use std::net::{IpAddr, Ipv4Addr};
   4
   5 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
   6 #[serde(default)]
   7 pub struct Settings {
   8   /// settings related to the postgresql database
   9   #[serde(default)]
  10   pub database: DatabaseConfig,
  11   #[default(Some(RateLimitConfig::default()))]
  12   /// rate limits for various user actions, by user ip
  13   pub rate_limit: Option<RateLimitConfig>,
  14   /// Settings related to activitypub federation
  15   #[default(FederationConfig::default())]
  16   pub federation: FederationConfig,
  17   #[default(CaptchaConfig::default())]
  18   pub captcha: CaptchaConfig,
  19   /// Email sending configuration. All options except login/password are mandatory
  20   #[default(None)]
  21   pub email: Option<EmailConfig>,
  22   /// Parameters for automatic configuration of new instance (only used at first start)
  23   #[default(None)]
  24   pub setup: Option<SetupConfig>,
  25   /// the domain name of your instance (mandatory)
  26   #[default("unset")]
  27   #[doku(example = "example.com")]
  28   pub hostname: String,
  29   /// Address where lemmy should listen for incoming requests
  30   #[default(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))]
  31   #[doku(as = "String")]
  32   pub bind: IpAddr,
  33   /// Port where lemmy should listen for incoming requests
  34   #[default(8536)]
  35   pub port: u16,
  36   /// Whether the site is available over TLS. Needs to be true for federation to work.
  37   #[default(true)]
  38   pub tls_enabled: bool,
  39   /// Address where pictrs is available (for image hosting)
  40   #[default(None)]
  41   #[doku(example = "http://localhost:8080")]
  42   pub pictrs_url: Option<String>,
  43   #[default(None)]
  44   #[doku(example = "(\\bThis\\b)|(\\bis\\b)|(\\bsample\\b)")]
  45   pub slur_filter: Option<String>,
  46   /// Maximum length of local community and user names
  47   #[default(20)]
  48   pub actor_name_max_length: usize,
  49   /// Maximum number of HTTP requests allowed to handle a single incoming activity (or a single object fetch through the search).
  50   #[default(25)]
  51   pub http_fetch_retry_limit: i32,
  52 }
  53
  54 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
  55 #[serde(default)]
  56 pub struct CaptchaConfig {
  57   /// Whether captcha is required for signup
  58   #[default(false)]
  59   pub enabled: bool,
  60   /// Can be easy, medium, or hard
  61   #[default("medium")]
  62   pub difficulty: String,
  63 }
  64
  65 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
  66 #[serde(default)]
  67 pub struct DatabaseConfig {
  68   /// Username to connect to postgres
  69   #[default("lemmy")]
  70   pub(super) user: String,
  71   /// Password to connect to postgres
  72   #[default("password")]
  73   pub password: String,
  74   #[default("localhost")]
  75   /// Host where postgres is running
  76   pub host: String,
  77   /// Port where postgres can be accessed
  78   #[default(5432)]
  79   pub(super) port: i32,
  80   /// Name of the postgres database for lemmy
  81   #[default("lemmy")]
  82   pub(super) database: String,
  83   /// Maximum number of active sql connections
  84   #[default(5)]
  85   pub pool_size: u32,
  86 }
  87
  88 #[derive(Debug, Deserialize, Serialize, Clone, Document)]
  89 pub struct EmailConfig {
  90   /// Hostname and port of the smtp server
  91   #[doku(example = "localhost:25")]
  92   pub smtp_server: String,
  93   /// Login name for smtp server
  94   pub smtp_login: Option<String>,
  95   /// Password to login to the smtp server
  96   pub smtp_password: Option<String>,
  97   #[doku(example = "noreply@example.com")]
  98   /// Address to send emails from, eg "noreply@your-instance.com"
  99   pub smtp_from_address: String,
 100   /// Whether or not smtp connections should use tls
 101   pub use_tls: bool,
 102 }
 103
 104 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 105 #[serde(default)]
 106 pub struct FederationConfig {
 107   /// Whether to enable activitypub federation.
 108   #[default(false)]
 109   pub enabled: bool,
 110   /// Allows and blocks are described here:
 111   /// https://join-lemmy.org/docs/en/federation/administration.html///instance-allowlist-and-blocklist
 112   ///
 113   /// list of instances with which federation is allowed
 114   #[default(None)]
 115   #[doku(example = "instance1.tld")]
 116   #[doku(example = "instance2.tld")]
 117   pub allowed_instances: Option<Vec<String>>,
 118   /// Instances which we never federate anything with (but previously federated objects are unaffected)
 119   #[default(None)]
 120   pub blocked_instances: Option<Vec<String>>,
 121   /// If true, only federate with instances on the allowlist and block everything else. If false,
 122   /// use allowlist only for remote communities, and posts/comments in local communities
 123   /// (meaning remote communities will show content from arbitrary instances).
 124   #[default(true)]
 125   pub strict_allowlist: bool,
 126 }
 127
 128 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 129 #[serde(default)]
 130 pub struct RateLimitConfig {
 131   /// Maximum number of messages created in interval
 132   #[default(180)]
 133   pub message: i32,
 134   /// Interval length for message limit, in seconds
 135   #[default(60)]
 136   pub message_per_second: i32,
 137   /// Maximum number of posts created in interval
 138   #[default(6)]
 139   pub post: i32,
 140   /// Interval length for post limit, in seconds
 141   #[default(600)]
 142   pub post_per_second: i32,
 143   /// Maximum number of registrations in interval
 144   #[default(3)]
 145   pub register: i32,
 146   /// Interval length for registration limit, in seconds
 147   #[default(3600)]
 148   pub register_per_second: i32,
 149   /// Maximum number of image uploads in interval
 150   #[default(6)]
 151   pub image: i32,
 152   /// Interval length for image uploads, in seconds
 153   #[default(3600)]
 154   pub image_per_second: i32,
 155   /// Maximum number of comments created in interval
 156   #[default(6)]
 157   pub comment: i32,
 158   /// Interval length for comment limit, in seconds
 159   #[default(600)]
 160   pub comment_per_second: i32,
 161 }
 162
 163 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 164 pub struct SetupConfig {
 165   /// Username for the admin user
 166   #[doku(example = "admin")]
 167   pub admin_username: String,
 168   /// Password for the admin user. It must be at least 10 characters.
 169   #[doku(example = "my_passwd_longer_than_ten_characters")]
 170   pub admin_password: String,
 171   /// Name of the site (can be changed later)
 172   #[doku(example = "My Lemmy Instance")]
 173   pub site_name: String,
 174   /// Email for the admin user (optional, can be omitted and set later through the website)
 175   #[default(None)]
 176   pub admin_email: Option<String>,
 177   #[default(None)]
 178   pub sidebar: Option<String>,
 179   #[default(None)]
 180   pub description: Option<String>,
 181   #[default(None)]
 182   pub icon: Option<String>,
 183   #[default(None)]
 184   pub banner: Option<String>,
 185   #[default(None)]
 186   pub enable_downvotes: Option<bool>,
 187   #[default(None)]
 188   pub open_registration: Option<bool>,
 189   #[default(None)]
 190   pub enable_nsfw: Option<bool>,
 191   #[default(None)]
 192   pub community_creation_admin_only: Option<bool>,
 193 }