mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-10-31 22:18:59 +00:00
040770d7ba
* Fix retry infinite loops. Fixes #1964 * Moving retry_limit to settings
193 lines
6.4 KiB
Rust
193 lines
6.4 KiB
Rust
use doku::Document;
|
|
use serde::{Deserialize, Serialize};
|
|
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>,
|
|
#[default(None)]
|
|
#[doku(example = "(\\bThis\\b)|(\\bis\\b)|(\\bsample\\b)")]
|
|
pub slur_filter: Option<String>,
|
|
/// Maximum length of local community and user names
|
|
#[default(20)]
|
|
pub actor_name_max_length: usize,
|
|
/// Maximum number of HTTP requests allowed to handle a single incoming activity (or a single object fetch through the search).
|
|
#[default(25)]
|
|
pub http_fetch_retry_limit: i32,
|
|
}
|
|
|
|
#[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,
|
|
}
|
|
|
|
#[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")]
|
|
#[doku(example = "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,
|
|
}
|
|
|
|
#[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,
|
|
/// Maximum number of comments created in interval
|
|
#[default(6)]
|
|
pub comment: i32,
|
|
/// Interval length for comment limit, in seconds
|
|
#[default(600)]
|
|
pub comment_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)]
|
|
pub sidebar: Option<String>,
|
|
#[default(None)]
|
|
pub description: Option<String>,
|
|
#[default(None)]
|
|
pub icon: Option<String>,
|
|
#[default(None)]
|
|
pub banner: Option<String>,
|
|
#[default(None)]
|
|
pub enable_downvotes: Option<bool>,
|
|
#[default(None)]
|
|
pub open_registration: Option<bool>,
|
|
#[default(None)]
|
|
pub enable_nsfw: Option<bool>,
|
|
#[default(None)]
|
|
pub community_creation_admin_only: Option<bool>,
|
|
}
|