Skip to content
This repository was archived by the owner on Aug 6, 2022. It is now read-only.

II.1.a. board

Andrey Bogdanov edited this page Apr 7, 2016 · 20 revisions

Contents

Options

board.archiveLimit

Maximum threads to keep in a thread archive. One can not create new posts in archived threads, nor can one edit the posts in them.

Default: 0.

board.bumpLimit

Maximum number of posts, after reaching which a thread no longer gets bumped (lifted up in the thread list) on a new post. Not to be confused with post limit.

Default: 500.

board.captchaEnabled

Determines if captcha is enabled on the board.

Defaults to true.

Note: Unlike other options, this one does not overwrite global board settings. If the captcha is disabled globally, it will be disabled on any board, even if it is explicitly enabled for a specific board.

board.captchaQuota

Determines how many additional posts a user may leave having solved one captcha.

Defaults to 0 (each post requires solving a captcha).

board.defaultUserName

The default user name used if not specified on post creation.

Defaults to the name specified in the options.defaultUserName of the board constructod, or to "Anonymous" if not specified.

board.enabled

Determines if a board is enabled. If a board is disabled, it will not be accessible neither from a browser, nor with server commands.

Boards are enabled by default.

board.hidden

Determines if a board is hidden. Hidden boards are accessible from the browser and with server commands, but they are not shown in the navigation bar.

Boards are not hidden by default.

board.launchDate

Board launch date. Used to calculate posting speed. Must be specified in the ISO format: YYYY-MM-DDThh:mm:ss. Example: 2015-02-12T21:00:00.

board.markupElements

Array of markup button identifiers. If an identifier is present, the corresponding markup button will be added to the post form.

Available values:

  • "BOLD"
  • "ITALICS"
  • "STRIKED_OUT"
  • "UNDERLINED"
  • "SPOILER"
  • "QUOTATION"
  • "UNORDERED_LIST"
  • "ORDERED_LIST"
  • "LIST_ITEM"
  • "SUBSCRIPT"
  • "SUPERSCRIPT"
  • "URL"
  • "CODE"

By default all buttons are shown, except of the on with "CODE" identifier (it is only shown on the /pr/ board by default).

board.maxEmailLength

Maximum allowed post email field length (in symbols).

Default: 150.

board.maxFileCount

Maximum amount of files one can attach to a post.

Default: 1.

If the value is 0, a thread can be created without attaching a file. Otherwise one must attach at least one file to create a thread.

board.maxFileSize

Maximum attached file size. The sizes of several files are not summed up.

Default: 10485760 (10 MB).

board.maxLastPosts

Maximum amount of posts displayed after the first thread post on a board. Other posts are not shown.

Default: 3.

board.maxNameLength

Maximum allowed post name field length (in symbols).

Default: 50.

board.maxPasswordLength

Maximum allowed post password field length (in symbols).

Default: 50.

board.maxSubjectLength

Maximum allowed post subject field length (in symbols).

Default: 150.

board.maxTextLength

Maximum allowed post text field length (in symbols).

Default: 15000.

board.opModeration

If set to true, thead OP will be able to edit/delete other users' posts in his/her thread.

Default: false.

board.permissions

Overwrites permissions for a specific board. See II.1.c. permissions for details.

board.postingEnabled

Determines if posting is enabled on a board. If posting is disabled, nobody can create new threads/posts on the board and in any thread on the board.

Posting is enabled by default.

board.postLimit

Maximum number of posts a thread may contain. One can not create new posts in a thread that has reached the post limit. Not to be confused with bump limit.

Default: 1000.

board.showWhois

Determines if the geolocation information is shown for the posts on a board.

By default geolocation information is not shown, but it is stored in the database, so you may enable/disable this option at any time.

This is how it looks like:

Geolocation info

board.skippedGetOrder

The order (exponent, Math.pow(10, N)) of the post numbers to be skipped. For example, if 3 is specified, every 1000-th post number will be skipped (instead of 1000 it will be 1001, instead of 2000 it will be 2001, and so on). Useful on small boards to prevent non-legitimate GETs.

Default: 0 (no post number is skipped).

board.supportedCaptchaEngines

An adday of captcha engine identifiers. The user must solve a captcha corresponding to one of the captcha engines specified in the array to be able to create a post.

Default: identifiers of all captcha engines loaded at application startup.

See also: II.6.h. Captcha engines

board.supportedFileTypes

An array of MIME-types. Only the files which MIME-type match one from within the array can be attached to the post.

Default:

[
    "application/ogg",
    "application/pdf",
    "audio/mpeg",
    "audio/ogg",
    "audio/wav",
    "image/gif",
    "image/jpeg",
    "image/png",
    "video/mp4",
    "video/ogg",
    "video/webm"
]
board.threadLimit

Maximum number of threads per board. If the limit is reached and a new thread is created, the last thread is deleted or moved to the archive (if it is enabled).

Default: 200.

board.threadsPerPage

Amount of threads that are shown on a single board page.

Default: 20.

Overwriting global board settings for a specific board

Besides global board options, you may specify options for each board separately. These options will overwrite global board settings (except for the board.captchaEnabled option).

Example:

{
    "board": {
        "postLimit": 2000,
        "b": {
            "postLimit": 1500
        }
    }
}

In the example above, the post limit is set to 2000 for all boards, except /b/, for which the limit is set to 1500.

board.title

Title of the board.

Defaults to the title specified in board constructor.

board.useDefaultBoards

Determines if the default board set should be loaded.

Default: true.

boardGroups

Used to group the boards.

Fields:

  • title The title of the group.
  • priority Group priority used to order groups in the navigation bar. Optional.

Example:

"boardGroups": {
    "thematic": {
        "title": "Thematic",
        "prioority": 1
    },
    "adult": {
        "title": "For adults",
        "prioority": 2
    }
},
"boards": {
    "h": {
        "groupName": "adult"
    },
    "3dpd": {
        "groupName": "adult"
    },
    "a": {
        "groupName": "thematic"
    },
    "vg": {
        "groupName": "thematic"
    },
    "mlp": {
        "groupName": "thematic"
    }
}

Clone this wiki locally