Generate config docs from code (#1786)

* Generate config docs from code

* update library

* move settings comments from config.hjson to code

* updte doku to 0.10

* update doku

Cargo.toml

@@ -64,6 +64,7 @@ activitystreams = "0.7.0-alpha.11"
 actix-rt = { version = "2.2.0", default-features = false }
 serde_json = { version = "1.0.68", features = ["preserve_order"] }
 clokwerk = "0.3.5"
+doku = "0.10.1"
 
 [dev-dependencies.cargo-husky]
 version = "1.5.0"

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 "[email protected]"
-#    smtp_from_address: ""
-#    # whether or not smtp connections should use tls
-#    use_tls: true
-#  }
-  # additional_slurs:
-  #  '''
-  #  (\bThis\b)|(\bis\b)|(\bsample\b)
-  #  '''
 }

crates/utils/Cargo.toml

@@ -39,3 +39,4 @@ deser-hjson = "1.0.2"
 smart-default = "0.6.0"
 webpage = { version = "1.3.0", default-features = false, features = ["serde"] }
 jsonwebtoken = "7.2.0"
+doku = "0.10.1"

crates/utils/src/settings/mod.rs

@@ -11,6 +11,16 @@ static DEFAULT_CONFIG_FILE: &str = "config/config.hjson";
 lazy_static! {
   static ref SETTINGS: RwLock<Settings> =
     RwLock::new(Settings::init().expect("Failed to load settings file"));
+  static ref WEBFINGER_COMMUNITY_REGEX: Regex = Regex::new(&format!(
+    "^group:([a-z0-9_]{{3,}})@{}$",
+    Settings::get().hostname
+  ))
+  .expect("compile webfinger regex");
+  static ref WEBFINGER_USER_REGEX: Regex = Regex::new(&format!(
+    "^acct:([a-z0-9_]{{3,}})@{}$",
+    Settings::get().hostname
+  ))
+  .expect("compile webfinger regex");
 }
 
 impl Settings {
@@ -21,22 +31,12 @@ impl Settings {
   /// Warning: Only call this once.
   pub fn init() -> Result<Self, LemmyError> {
     // Read the config file
-    let mut config = from_str::<Settings>(&Self::read_config_file()?)?;
+    let config = from_str::<Settings>(&Self::read_config_file()?)?;
 
     if config.hostname == "unset" {
       return Err(anyhow!("Hostname variable is not set!").into());
     }
 
-    // Initialize the regexes
-    config.webfinger_community_regex = Some(
-      Regex::new(&format!("^group:([a-z0-9_]{{3,}})@{}$", config.hostname))
-        .expect("compile webfinger regex"),
-    );
-    config.webfinger_username_regex = Some(
-      Regex::new(&format!("^acct:([a-z0-9_]{{3,}})@{}$", config.hostname))
-        .expect("compile webfinger regex"),
-    );
-
     Ok(config)
   }
 
@@ -106,17 +106,11 @@ impl Settings {
   }
 
   pub fn webfinger_community_regex(&self) -> Regex {
-    self
-      .webfinger_community_regex
-      .to_owned()
-      .expect("compile webfinger regex")
+    WEBFINGER_COMMUNITY_REGEX.to_owned()
   }
 
   pub fn webfinger_username_regex(&self) -> Regex {
-    self
-      .webfinger_username_regex
-      .to_owned()
-      .expect("compile webfinger regex")
+    WEBFINGER_USER_REGEX.to_owned()
   }
 
   pub fn slur_regex(&self) -> Regex {