Type Alias EditSite

EditSite: {
    actor_name_max_length?: number;
    application_email_admins?: boolean;
    application_question?: string;
    blocked_urls?: string[];
    captcha_difficulty?: string;
    captcha_enabled?: boolean;
    comment_downvotes?: FederationMode;
    comment_upvotes?: FederationMode;
    community_creation_admin_only?: boolean;
    content_warning?: string;
    default_comment_sort_type?: CommentSortType;
    default_post_listing_mode?: PostListingMode;
    default_post_listing_type?: ListingType;
    default_post_sort_type?: PostSortType;
    default_post_time_range_seconds?: number;
    default_theme?: string;
    description?: string;
    disable_donation_dialog?: boolean;
    discussion_languages?: LanguageId[];
    federation_enabled?: boolean;
    hide_modlog_mod_names?: boolean;
    legal_information?: string;
    name?: string;
    oauth_registration?: boolean;
    post_downvotes?: FederationMode;
    post_upvotes?: FederationMode;
    private_instance?: boolean;
    rate_limit_comment?: number;
    rate_limit_comment_per_second?: number;
    rate_limit_image?: number;
    rate_limit_image_per_second?: number;
    rate_limit_message?: number;
    rate_limit_message_per_second?: number;
    rate_limit_post?: number;
    rate_limit_post_per_second?: number;
    rate_limit_register?: number;
    rate_limit_register_per_second?: number;
    rate_limit_search?: number;
    rate_limit_search_per_second?: number;
    registration_mode?: RegistrationMode;
    reports_email_admins?: boolean;
    require_email_verification?: boolean;
    sidebar?: string;
    slur_filter_regex?: string;
}

Edits a site.

Type declaration

  • Optionalactor_name_max_length?: number

    The max length of actor names.

  • Optionalapplication_email_admins?: boolean

    Whether to email admins when receiving a new application.

  • Optionalapplication_question?: string

    Your application question form. This is in markdown, and can be many questions.

  • Optionalblocked_urls?: string[]

    A list of blocked URLs

  • Optionalcaptcha_difficulty?: string

    The captcha difficulty. Can be easy, medium, or hard

  • Optionalcaptcha_enabled?: boolean

    Whether to enable captchas for signups.

  • Optionalcomment_downvotes?: FederationMode

    What kind of comment downvotes your site allows.

  • Optionalcomment_upvotes?: FederationMode

    What kind of comment upvotes your site allows.

  • Optionalcommunity_creation_admin_only?: boolean

    Limits community creation to admins only.

  • Optionalcontent_warning?: string

    If present, nsfw content is visible by default. Should be displayed by frontends/clients when the site is first opened by a user.

  • Optionaldefault_comment_sort_type?: CommentSortType

    The default comment sort, usually "hot"

  • Optionaldefault_post_listing_mode?: PostListingMode

    Default value for listing mode, usually "list"

  • Optionaldefault_post_listing_type?: ListingType

    The default post listing type, usually "local"

  • Optionaldefault_post_sort_type?: PostSortType

    The default post sort, usually "active"

  • Optionaldefault_post_time_range_seconds?: number

    A default time range limit to apply to post sorts, in seconds. 0 means none.

  • Optionaldefault_theme?: string

    The default theme. Usually "browser"

  • Optionaldescription?: string

    A shorter, one line description of your site.

  • Optionaldisable_donation_dialog?: boolean

    If this is true, users will never see the dialog asking to support Lemmy development with donations.

  • Optionaldiscussion_languages?: LanguageId[]

    A list of allowed discussion languages.

  • Optionalfederation_enabled?: boolean

    Whether to enable federation.

  • Optionalhide_modlog_mod_names?: boolean

    Whether to hide moderator names from the modlog.

  • Optionallegal_information?: string

    An optional page of legal information

  • Optionalname?: string
  • Optionaloauth_registration?: boolean

    Whether or not external auth methods can auto-register users.

  • Optionalpost_downvotes?: FederationMode

    What kind of post downvotes your site allows.

  • Optionalpost_upvotes?: FederationMode

    What kind of post upvotes your site allows.

  • Optionalprivate_instance?: boolean

    Whether your instance is public, or private.

  • Optionalrate_limit_comment?: number

    The number of comments allowed in a given time frame.

  • Optionalrate_limit_comment_per_second?: number
  • Optionalrate_limit_image?: number

    The number of image uploads allowed in a given time frame.

  • Optionalrate_limit_image_per_second?: number
  • Optionalrate_limit_message?: number

    The number of messages allowed in a given time frame.

  • Optionalrate_limit_message_per_second?: number
  • Optionalrate_limit_post?: number

    The number of posts allowed in a given time frame.

  • Optionalrate_limit_post_per_second?: number
  • Optionalrate_limit_register?: number

    The number of registrations allowed in a given time frame.

  • Optionalrate_limit_register_per_second?: number
  • Optionalrate_limit_search?: number

    The number of searches allowed in a given time frame.

  • Optionalrate_limit_search_per_second?: number
  • Optionalregistration_mode?: RegistrationMode
  • Optionalreports_email_admins?: boolean

    Whether to email admins for new reports.

  • Optionalrequire_email_verification?: boolean

    Whether to require email verification.

  • Optionalsidebar?: string

    A sidebar for the site, in markdown.

  • Optionalslur_filter_regex?: string

    A regex string of items to filter.