Button Button

This will eventually have a complete list of configuration parameters.

If a parameter you need is not documented in enough detail, please don't hesitate to ask on the mailing list.

Basic Parameters

See Basic Configuration for the following basic parameters:

  • VERSIUM_PARAMS - required
  • BASE_URL - required
  • TOKEN_SALT - required
  • PASSWORD_SALT
  • DOMAIN
  • SITE_TITLE
  • MAIN_COLOR
  • BODY_BG_COLOR

Other Parameters by Functionality Area

Toolbar (new in Fenchurch)

TOOLBAR_COMMANDS can be set to a table of strings specifying the commands to be potentially added to the toolbar.

For example:

TOOLBAR_COMMANDS = {'edit', 'history', 'rss'}

For users to actually see the icons in the tool bar, they need permissions for that action and there needs to be a corresponding icon (icons/command_name.png).

Interwiki

  • INTERWIKI - see Interwiki, new in Fenchurch.

URLs

  • NICE_URL -see Nicer URLs.
  • HOME_PAGE - the node that gets displayed when no node is specified, defaults to "index".
  • HOME_PAGE_URL - the URL used instead of links to HOME_PAGE
  • LOGO_URL - a URL of the site logo
  • FAVICON_URL - a URL of the site's favicon
  • ICON_BASE_URL - a prefix for icon URLS, see Serving Static Resources (new in Fenchurch).
  • CSS_BASE_URL - a prefix for CSS URLS, see Serving Static Resources (new in Fenchurch).
  • JS_BASE_URL - a prefix for Javascript URLS, see Serving Static Resources (new in Fenchurch).

Spam / Authentication

  • NUM_HONEYPOTS_IN_FORMS - more honeypots = more fun
  • POST_TOKEN_TIMEOUT - time in minutes before the edit form expires
  • CAPTCHA_MODULE and CAPTCHA_PARAMS - see Captcha
  • AUTH_MODULE and AUTH_MODULE_PARAMS - see Authentication
  • REQUIRE_EMAIL_ACTIVATION
  • CONFIRMATION_ADDRESS_FROM
  • USERNAME_RULES
  • PASSWORD_RULES
  • TERMS_OF_SERVICE

SMTP

(Set if you want to require email activation.)

  • SMTP_SERVER
  • SMTP_SERVER_PORT
  • SMTP_USER
  • SMTP_PASSWORD

Timezone

  • TIME_ZONE - preferred timezone for displaying time (e.g., "+0700")
  • TIME_ZONE_NAME - the name for the preferred timezone (e.g., "PST" or "San Francisco")

Search

  • SEARCH_PAGE
  • SEARCH_CONTENT

Cache

  • CACHE_MODULE - ask on the list
  • APP_STORAGE_CACHE_MODULE and APP_CACHE_PARAMS- ask on the list

Prototypes

  • ROOT_PROTOTYPE - the node that serves as the default prototype (defaults to "@Root").
  • PROTOTYPE_PATTERNS - ask on the list

Node ids

  • ADMIN_NODE_PREFIX
  • CONFIG_PAGE_NAME - the configuration node (defaults to sputnik/config).
  • PASS_PAGE_NAME - the passwords node (defaults to "sputnik/passwords")
  • DEFAULT_NAVIGATION_BAR - the navigation configuration page (defaults to "sputnik/navigation")
  • HISTORY_PAGE - the history page (defaults to "history")
  • LOGIN_NODE
  • REGISTRATION_NODE

Logging

  • LOGGER - set to a lualogging submodule (e.g. "file") to enable logging
  • LOGGER_PARAMS - logger specific parameters

Etc.

  • MAX_ITEMS_IN_HISTORY - max number of items to show in history
  • USE_GRAVATAR - set to "true" to activate Gravatar
  • VERSIUM_STORAGE_MODULE and VERSIUM_PARAMS - see Storage
  • MARKUP_MODULE - see Markup
  • DIRIFY_FN - a function that converts node names into "safe" ids (e.g., "More Parameters" to "More_Parameters"). Set to another function if you want.
  • INTERFACE_LANGUAGE - set to a code for the available translation (e.g. to "ru" or "pt_BR")
  • ROCK_LIST_FOR_VERSION - a list of modules for which the version will be displayed (under "sputnik/version", only to Admin).
  • MIME_TYPES