lemmy-js-client
    Preparing search index...

    Type Alias LocalSite

    The local site.

    type LocalSite = {
        application_email_admins: boolean;
        application_question?: string;
        banned_users_percent: number;
        community_creation_admin_only: boolean;
        default_comment_downvotes: VoteSettings;
        default_comment_sort_type: CommentSortType;
        default_comment_upvotes: VoteSettings;
        default_items_per_page: number;
        default_post_downvotes: VoteSettings;
        default_post_listing_mode: PostListingMode;
        default_post_listing_type: ListingType;
        default_post_sort_type: PostSortType;
        default_post_time_range_seconds?: number;
        default_post_upvotes: VoteSettings;
        default_theme: string;
        email_notifications_disabled: boolean;
        email_verification_required: boolean;
        federation_enabled: boolean;
        federation_signed_fetch: boolean;
        id: LocalSiteId;
        image_allow_video_uploads: boolean;
        image_max_avatar_size: number;
        image_max_banner_size: number;
        image_max_thumbnail_size: number;
        image_max_upload_size: number;
        image_mode: ImageMode;
        image_proxy_bypass_domains?: string;
        image_upload_disabled: boolean;
        image_upload_timeout_seconds: number;
        legal_information?: string;
        linked_instances: number;
        local_comments: number;
        local_communities: number;
        local_posts: number;
        local_users: number;
        max_invites_per_user_allowed: number;
        nsfw_content_disallowed: boolean;
        oauth_registration: boolean;
        private_instance: boolean;
        published_at: string;
        registration_mode: RegistrationMode;
        reports_email_admins: boolean;
        site_id: SiteId;
        site_setup: boolean;
        slur_filter_regex?: string;
        suggested_multi_community_id?: MultiCommunityId;
        total_comments: number;
        total_communities: number;
        total_posts: number;
        total_users: number;
        updated_at?: string;
        user_retention_half_year_percent: number;
        user_retention_month_percent: number;
        users_active_day: number;
        users_active_half_year: number;
        users_active_month: number;
        users_active_week: number;
    }
    Index
    application_email_admins application_question? banned_users_percent community_creation_admin_only default_comment_downvotes default_comment_sort_type default_comment_upvotes default_items_per_page default_post_downvotes default_post_listing_mode default_post_listing_type default_post_sort_type default_post_time_range_seconds? default_post_upvotes default_theme email_notifications_disabled email_verification_required federation_enabled federation_signed_fetch id image_allow_video_uploads image_max_avatar_size image_max_banner_size image_max_thumbnail_size image_max_upload_size image_mode image_proxy_bypass_domains? image_upload_disabled image_upload_timeout_seconds legal_information? linked_instances local_comments local_communities local_posts local_users max_invites_per_user_allowed nsfw_content_disallowed oauth_registration private_instance published_at registration_mode reports_email_admins site_id site_setup slur_filter_regex? suggested_multi_community_id? total_comments total_communities total_posts total_users updated_at? user_retention_half_year_percent user_retention_month_percent users_active_day users_active_half_year users_active_month users_active_week
    application_email_admins: boolean

    Whether new applications email admins.

    application_question?: string

    An optional registration application questionnaire in markdown.

    banned_users_percent: number
    community_creation_admin_only: boolean

    Whether only admins can create communities.

    default_comment_downvotes: VoteSettings

    Default comment downvote mode for newly created local communities.

    default_comment_sort_type: CommentSortType

    Default value for [LocalUser.comment_sort_type]

    default_comment_upvotes: VoteSettings

    Default comment upvote mode for newly created local communities.

    default_items_per_page

    default_items_per_page: number

    default_post_downvotes

    default_post_downvotes: VoteSettings

    Default post downvote mode for newly created local communities.

    default_post_listing_mode

    default_post_listing_mode: PostListingMode

    Default value for [LocalSite.post_listing_mode]

    default_post_listing_type

    default_post_listing_type: ListingType

    default_post_sort_type

    default_post_sort_type: PostSortType

    Default value for [LocalUser.post_sort_type]

    Optionaldefault_post_time_range_seconds

    default_post_time_range_seconds?: number

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

    default_post_upvotes

    default_post_upvotes: VoteSettings

    Default post upvote mode for newly created local communities.

    default_theme: string

    The default front-end theme.

    email_notifications_disabled: boolean

    Dont send email notifications to users for new replies, mentions etc

    email_verification_required: boolean

    Whether emails are required.

    federation_enabled: boolean

    Whether federation is enabled.

    federation_signed_fetch: boolean

    Whether to sign outgoing Activitypub fetches with private key of local instance. Some Fediverse instances and platforms require this.

    id: LocalSiteId
    image_allow_video_uploads: boolean

    This affects post and comment images, but not avatars and banners.

    image_max_avatar_size: number
    image_max_banner_size: number
    image_max_thumbnail_size: number

    These are pixel sizes. Larger images are automatically downscaled.

    image_max_upload_size: number

    This affects post and comment images, but not avatar and banner sizes.

    image_mode: ImageMode

    A mode for setting how pictrs handles images.

    image_proxy_bypass_domains?: string

    Allows bypassing proxy for specific image hosts when using [[ImageMode.ProxyAllImages]]. Use a comma-delimited string.

    Example: i.imgur.com,postimg.cc

    image_upload_disabled: boolean
    image_upload_timeout_seconds: number
    legal_information?: string

    An optional legal disclaimer page.

    linked_instances: number
    local_comments: number
    local_communities: number
    local_posts: number
    local_users: number
    max_invites_per_user_allowed: number

    How many active invite links a user can have

    nsfw_content_disallowed

    nsfw_content_disallowed: boolean

    Block NSFW content being created

    oauth_registration: boolean

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

    private_instance: boolean

    Whether the instance is private or public.

    published_at: string
    registration_mode: RegistrationMode
    reports_email_admins: boolean

    Whether to email admins on new reports.

    site_id: SiteId
    site_setup: boolean

    True if the site is set up.

    slur_filter_regex?: string

    An optional regex to filter words.

    suggested_multi_community_id?: MultiCommunityId
    total_comments: number
    total_communities: number
    total_posts: number
    total_users: number
    updated_at?: string
    user_retention_half_year_percent: number
    user_retention_month_percent: number
    users_active_day: number

    The number of users with any activity in the last day.

    users_active_half_year: number

    The number of users with any activity in the last half year.

    users_active_month: number

    The number of users with any activity in the last month.

    users_active_week: number

    The number of users with any activity in the last week.

    Settings
    Member Visibility

    On This Page
    Properties
    application_email_adminsapplication_questionbanned_users_percentcommunity_creation_admin_onlydefault_comment_downvotesdefault_comment_sort_typedefault_comment_upvotesdefault_items_per_pagedefault_post_downvotesdefault_post_listing_modedefault_post_listing_typedefault_post_sort_typedefault_post_time_range_secondsdefault_post_upvotesdefault_themeemail_notifications_disabledemail_verification_requiredfederation_enabledfederation_signed_fetchidimage_allow_video_uploadsimage_max_avatar_sizeimage_max_banner_sizeimage_max_thumbnail_sizeimage_max_upload_sizeimage_modeimage_proxy_bypass_domainsimage_upload_disabledimage_upload_timeout_secondslegal_informationlinked_instanceslocal_commentslocal_communitieslocal_postslocal_usersmax_invites_per_user_allowednsfw_content_disallowedoauth_registrationprivate_instancepublished_atregistration_modereports_email_adminssite_idsite_setupslur_filter_regexsuggested_multi_community_idtotal_commentstotal_communitiestotal_poststotal_usersupdated_atuser_retention_half_year_percentuser_retention_month_percentusers_active_dayusers_active_half_yearusers_active_monthusers_active_week