move settings comments from config.hjson to code

config/config.hjson

@@ -1,95 +1,5 @@
+# See the documentation for available config fields and descriptions:
+# https://join-lemmy.org/docs/en/administration/configuration.html
 {
-#  # optional: parameters for automatic configuration of new instance (only used at first start)
-#  setup: {
-#    # username for the admin user
-#    admin_username: ""
-#    # password for the admin user
-#    admin_password: ""
-#    # optional: email for the admin user (can be omitted and set later through the website)
-#    admin_email: ""
-#    # name of the site (can be changed later)
-#    site_name: ""
-#  }
-  # settings related to the postgresql database
-  database: {
-    # username to connect to postgres
-    user: "lemmy"
-    # password to connect to postgres
-    password: "password"
-    # host where postgres is running
-    host: "localhost"
-    # port where postgres can be accessed
-    port: 5432
-    # name of the postgres database for lemmy
-    database: "lemmy"
-    # maximum number of active sql connections
-    pool_size: 5
-  }
-  # the domain name of your instance (eg "lemmy.ml")
   hostname: lemmy-alpha
-  # address where lemmy should listen for incoming requests
-  bind: "0.0.0.0"
-  # port where lemmy should listen for incoming requests
-  port: 8536
-  # whether tls is required for activitypub. only disable this for debugging, never for producion.
-  tls_enabled: true
-  # address where pictrs is available
-  pictrs_url: "http://pictrs:8080"
-  # maximum length of local community and user names
-  actor_name_max_length: 20
-  # rate limits for various user actions, by user ip
-  rate_limit: {
-    # maximum number of messages created in interval
-    message: 180
-    # interval length for message limit
-    message_per_second: 60
-    # maximum number of posts created in interval
-    post: 6
-    # interval length for post limit
-    post_per_second: 600
-    # maximum number of registrations in interval
-    register: 3
-    # interval length for registration limit
-    register_per_second: 3600
-    # maximum number of image uploads in interval
-    image: 6
-    # interval length for image uploads
-    image_per_second: 3600
-  }
-  # settings related to activitypub federation
-  federation: {
-    # whether to enable activitypub federation.
-    enabled: false
-    # Allows and blocks are described here:
-    # https://join-lemmy.org/docs/en/federation/administration.html#instance-allowlist-and-blocklist
-    #
-    # list of instances with which federation is allowed
-    # allowed_instances: ["instance1.tld","instance2.tld"]
-    # instances which we never federate anything with (but previously federated objects are unaffected)
-    # blocked_instances: []
-    # If true, only federate with instances on the allowlist and block everything else. If false,
-    # use allowlist only for remote communities, and posts/comments in local communities.
-    # strict_allowlist: true
-  }
-  captcha: {
-    enabled: true
-    difficulty: medium # Can be easy, medium, or hard
-  }
-#  # email sending configuration
-#  email: {
-#    # hostname and port of the smtp server
-#    smtp_server: ""
-#    # login name for smtp server
-#    smtp_login: ""
-#    # password to login to the smtp server
-#    smtp_password: ""
-#    # address to send emails from, eg "noreply@your-instance.com"
-#    smtp_from_address: ""
-#    # whether or not smtp connections should use tls
-#    use_tls: true
-#  }
-  # additional_slurs:
-  #  '''
-  #  (\bThis\b)|(\bis\b)|(\bsample\b)
-  #  '''
 }

crates/utils/src/settings/structs.rs

@@ -5,33 +5,45 @@ use std::net::{IpAddr, Ipv4Addr};
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct Settings {
+  /// settings related to the postgresql database
   #[serde(default)]
   pub database: DatabaseConfig,
   #[default(Some(RateLimitConfig::default()))]
+  /// rate limits for various user actions, by user ip
   pub rate_limit: Option<RateLimitConfig>,
+  /// Settings related to activitypub federation
   #[default(FederationConfig::default())]
   pub federation: FederationConfig,
   #[default(CaptchaConfig::default())]
   pub captcha: CaptchaConfig,
+  /// Email sending configuration. All options except login/password are mandatory
   #[default(None)]
   pub email: Option<EmailConfig>,
+  /// Parameters for automatic configuration of new instance (only used at first start)
   #[default(None)]
   pub setup: Option<SetupConfig>,
+  /// the domain name of your instance (mandatory)
   #[default("unset")]
   #[doku(example = "example.com")]
   pub hostname: String,
+  /// Address where lemmy should listen for incoming requests
   #[default(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))]
   #[doku(as = "String")]
   pub bind: IpAddr,
+  /// Port where lemmy should listen for incoming requests
   #[default(8536)]
   pub port: u16,
+  /// Whether the site is available over TLS. Needs to be true for federation to work.
   #[default(true)]
   pub tls_enabled: bool,
+  /// Address where pictrs is available (for image hosting)
   #[default(None)]
   #[doku(example = "http://localhost:8080")]
   pub pictrs_url: Option<String>,
+  /// Regex for slurs which are prohibited. Example: `(\bThis\b)|(\bis\b)|(\bsample\b)`
   #[default(None)]
   pub additional_slurs: Option<String>,
+  /// Maximum length of local community and user names
   #[default(20)]
   pub actor_name_max_length: usize,
 }
@@ -39,8 +51,10 @@ pub struct Settings {
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct CaptchaConfig {
+  /// Whether captcha is required for signup
   #[default(false)]
   pub enabled: bool,
+  /// Can be easy, medium, or hard
   #[default("medium")]
   pub difficulty: String,
 }
@@ -48,40 +62,61 @@ pub struct CaptchaConfig {
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct DatabaseConfig {
+  /// Username to connect to postgres
   #[default("lemmy")]
   pub(super) user: String,
+  /// Password to connect to postgres
   #[default("password")]
   pub password: String,
   #[default("localhost")]
+  /// Host where postgres is running
   pub host: String,
+  /// Port where postgres can be accessed
   #[default(5432)]
   pub(super) port: i32,
+  /// Name of the postgres database for lemmy
   #[default("lemmy")]
   pub(super) database: String,
+  /// Maximum number of active sql connections
   #[default(5)]
   pub pool_size: u32,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, Document)]
 pub struct EmailConfig {
+  /// Hostname and port of the smtp server
   #[doku(example = "localhost:25")]
   pub smtp_server: String,
+  /// Login name for smtp server
   pub smtp_login: Option<String>,
+  /// Password to login to the smtp server
   pub smtp_password: Option<String>,
   #[doku(example = "noreply@example.com")]
+  /// Address to send emails from, eg "noreply@your-instance.com"
   pub smtp_from_address: String,
+  /// Whether or not smtp connections should use tls
   pub use_tls: bool,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct FederationConfig {
+  /// Whether to enable activitypub federation.
   #[default(false)]
   pub enabled: bool,
+  /// Allows and blocks are described here:
+  /// https://join-lemmy.org/docs/en/federation/administration.html///instance-allowlist-and-blocklist
+  ///
+  /// list of instances with which federation is allowed
   #[default(None)]
+  #[doku(example = "[\"instance1.tld\",\"instance2.tld\"]")]
   pub allowed_instances: Option<Vec<String>>,
+  /// Instances which we never federate anything with (but previously federated objects are unaffected)
   #[default(None)]
   pub blocked_instances: Option<Vec<String>>,
+  /// If true, only federate with instances on the allowlist and block everything else. If false,
+  /// use allowlist only for remote communities, and posts/comments in local communities
+  /// (meaning remote communities will show content from arbitrary instances).
   #[default(true)]
   pub strict_allowlist: bool,
 }
@@ -89,32 +124,44 @@ pub struct FederationConfig {
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct RateLimitConfig {
+  /// Maximum number of messages created in interval
   #[default(180)]
   pub message: i32,
+  /// Interval length for message limit, in seconds
   #[default(60)]
   pub message_per_second: i32,
+  /// Maximum number of posts created in interval
   #[default(6)]
   pub post: i32,
+  /// Interval length for post limit, in seconds
   #[default(600)]
   pub post_per_second: i32,
+  /// Maximum number of registrations in interval
   #[default(3)]
   pub register: i32,
+  /// Interval length for registration limit, in seconds
   #[default(3600)]
   pub register_per_second: i32,
+  /// Maximum number of image uploads in interval
   #[default(6)]
   pub image: i32,
+  /// Interval length for image uploads, in seconds
   #[default(3600)]
   pub image_per_second: i32,
 }
 
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 pub struct SetupConfig {
+  /// Username for the admin user
   #[doku(example = "admin")]
   pub admin_username: String,
+  /// Password for the admin user
   #[doku(example = "my_passwd")]
   pub admin_password: String,
+  /// Name of the site (can be changed later)
   #[doku(example = "My Lemmy Instance")]
   pub site_name: String,
+  /// Email for the admin user (optional, can be omitted and set later through the website)
   #[default(None)]
   pub admin_email: Option<String>,
   #[default(None)]