Page to demo inserting a macro.

Recent Changes

2024-11-13
	rel7downloads	02:17	buildqa
2024-11-12
	ReleaseNotes	11:36	DougGreve
2024-11-07
	Histo Atlas Segmentation	16:46	JuanIglesias
2024-10-28
	WMH-SynthSeg	15:52	JuanIglesias
2024-10-10
	PhotoTools	15:19	JonWilliamsRamirez [1-3]
2024-10-02
	AANSegment	13:08	MarkOlchanyi [1] JuanIglesias [2]
2024-10-01
	Brainstem Substructures	21:40	MarkOlchanyi [1-5]

Wiki Config

Wiki Config Help

Access control lists

ACLs control who may do what, see HelpOnAccessControlLists.

Variable name	Default	Description
acl_hierarchic	`False`	True to use hierarchical ACLs
acl_rights_after	`u''`	ACL that is processed after the on-page/default ACL
acl_rights_before	`u''`	ACL that is processed before the on-page/default ACL
acl_rights_default	`...`	ACL used if no ACL is specified on the page
acl_rights_valid	`...`	Valid tokens for right sides of ACL entries.

Authentication / Authorization / Security settings

Variable name	Default	Description
DesktopEdition	`False`	if True, give all local users special powers - only use this for a local desktop wiki!
SecurityPolicy	`None`	Class object hook for implementing security restrictions or relaxations
actions_excluded	`...`	Exclude unwanted actions (list of strings)
allow_xslt	`False`	if True, enables XSLT processing via 4Suite (note that this enables anyone with enough know-how to insert arbitrary HTML into your wiki, which is why it defaults to `False`)
auth	`[MoinAuth()]`	list of auth objects, to be called in this order (see HelpOnAuthentication)
auth_methods_trusted	`['http', 'xmlrpc_applytoken']`	authentication methods for which users should be included in the special "Trusted" ACL group.
password_checker	`_default_password_checker`	checks whether a password is acceptable (default check is length >= 6, at least 4 different chars, no keyboard sequence, not username used somehow (you can switch this off by using `None`)
secrets	`None`	Either a long shared secret string used for multiple purposes or a dict {"purpose": "longsecretstring", ...} for setting up different shared secrets for different purposes. If you don't setup own secret(s), a secret string will be auto-generated from other config settings.
superuser	`[]`	List of trusted user names with wiki system administration super powers (not to be confused with ACL admin rights!). Used for e.g. software installation, language installation via SystemPagesSetup and more. See also HelpOnSuperUser.

Backup settings

These settings control how the backup action works and who is allowed to use it.

Variable name	Default	Description
backup_compression	`'gz'`	What compression to use for the backup ("gz" or "bz2").
backup_exclude	`...`	Function f(filename) that tells whether a file should be excluded from backup. By default, nothing is excluded.
backup_include	`[]`	List of pathes to backup.
backup_users	`[]`	List of trusted user names who are allowed to get a backup.

Editor related

Variable name	Default	Description
edit_locking	`'warn 10'`	Editor locking policy: `None`, `'warn <timeout in minutes>'`, or `'lock <timeout in minutes>'`
edit_rows	`20`	Default height of the edit box
edit_ticketing	`True`
editor_default	`'text'`	Editor to use by default, 'text' or 'gui'
editor_force	`False`	if True, force using the default editor
editor_ui	`'freechoice'`	Editor choice shown on the user interface, 'freechoice' or 'theonepreferred'
page_license_enabled	`False`	if True, show a license hint in page editor.
page_license_page	`u'WikiLicense'`	Page linked from the license hint. [Unicode]

Mail settings

These settings control outgoing and incoming email from and to the wiki.

Variable name	Default	Description
mail_from	`None`	Used as From: address for generated mail.
mail_import_pagename_envelope	`u'%s'`	Use this to add some fixed prefix/postfix to the generated target pagename.
mail_import_pagename_regex	`'\\[\\[([^\\]]*)\\]\\]'`	Regular expression used to search for target pagename specification.
mail_import_pagename_search	`['subject', 'to']`	Where to look for target pagename specification.
mail_import_subpage_template	`u'$from-$date-$subject'`	Create subpages using this template when importing mail.
mail_import_wiki_addrs	`[]`	Target mail addresses to consider when importing mail
mail_login	`None`	'username userpass' for SMTP server authentication (None = don't use auth).
mail_sendmail	`None`	sendmail command to use for sending mail (None = don't use sendmail)
mail_smarthost	`None`	Address of SMTP server to use for sending mail (None = don't use SMTP server).

OpenID Server

These settings control the built-in OpenID Identity Provider (server).

Variable name	Default	Description
openid_server_enable_user	`False`	If True, the OpenIDUser processing instruction is allowed.
openid_server_enabled	`False`	True to enable the built-in OpenID server.
openid_server_restricted_users_group	`None`	If set to a group name, the group members are allowed to use the wiki as an OpenID provider. (None = allow for all users)

Special page names

Variable name	Default	Description
page_category_regex	`...`	Pagenames exactly matching this regex are regarded as Wiki categories [Unicode]
page_dict_regex	`u'(?P<all>(?P<key>\\S+)Dict)'`	Pagenames exactly matching this regex are regarded as pages containing variable dictionary definitions [Unicode]
page_front_page	`u'HelpOnLanguages'`	Name of the front page. We don't expect you to keep the default. Just read HelpOnLanguages in case you're wondering... [Unicode]
page_group_regex	`u'(?P<all>(?P<key>\\S+)Group)'`	Pagenames exactly matching this regex are regarded as pages containing group definitions [Unicode]
page_local_spelling_words	`u'LocalSpellingWords'`	Name of the page containing user-provided spellchecker words [Unicode]
page_template_regex	`...`	Pagenames exactly matching this regex are regarded as pages containing templates for new pages [Unicode]

Paths

Variable name	Default	Description
cache_dir	`None`	Directory for caching, by default computed from `data_dir`/cache.
data_dir	`'./data/'`	Path to the data directory containing your (locally made) wiki pages.
data_underlay_dir	`'./underlay/'`	Path to the underlay directory containing distribution system and help pages.
docbook_html_dir	`...`	Path to the directory with the Docbook to HTML XSLT files (optional, used by the docbook parser). The default value is correct for Debian Etch.
plugin_dir	`None`	Plugin directory, by default computed to be `data_dir`/plugin.
plugin_dirs	`[]`	Additional plugin directories.
shared_intermap	`None`	Path to a file containing global InterWiki definitions (or a list of such filenames)
user_dir	`None`	Directory for user storage, by default computed to be `data_dir`/user.

Session settings

Session-related settings, see HelpOnSessions.

Variable name	Default	Description
anonymous_session_lifetime	`None`	Session lifetime [h] of users who are not logged in (None = disable anon sessions).
cookie_domain	`None`	Domain used in the session cookie. (None = do not specify domain).
cookie_lifetime	`12`	Session lifetime [h] of logged-in users (see HelpOnSessions for details).
cookie_path	`None`	Path used in the session cookie (None = auto-detect).
cookie_secure	`None`	Use secure cookie. (None = auto-enable secure cookie for https, True = ever use secure cookie, False = never use secure cookie).
session_handler	`session.DefaultSessionHandler()`	See HelpOnSessions.
session_id_handler	`session.MoinCookieSessionIDHandler()`	Only used by the DefaultSessionHandler, see HelpOnSessions.

Anti-Spam/Leech/DOS

These settings help limiting ressource usage and avoiding abuse.

Variable name	Default	Description
antispam_master_url	`...`	where antispam security policy fetches spam pattern updates (if it is enabled)
hosts_deny	`[]`	List of denied IPs; if an IP ends with a dot, it denies a whole subnet (class A, B or C)
surge_action_limits	`...`	Surge protection tries to deny clients causing too much load/traffic, see /SurgeProtection.
surge_lockout_time	`3600`	time [s] someone gets locked out when ignoring the warnings
textchas	`None`	Spam protection setup using site-specific questions/answers, see HelpOnTextChas.
textchas_disabled_group	`None`	Name of a group of trusted users who do not get asked TextCha questions.
ua_spiders	`...`	A regex of HTTP_USER_AGENTs that should be excluded from logging and are not allowed to use actions.
unzip_attachments_count	`101`	max. number of files which are extracted from the zip file
unzip_attachments_space	`200000000.0`	max. total amount of bytes can be used to unzip files [bytes]
unzip_single_file_size	`2000000.0`	max. size of a single file in the archive which will be extracted [bytes]

Style / Theme / UI related

These settings control how the wiki user interface will look like.

Variable name	Default	Description
changed_time_fmt	`'%H:%M'`	Time format used on RecentChanges for page edits within the last 24 hours
chart_options	`None`	If you have gdchart, use something like chart_options = {'width': 720, 'height': 540}
date_fmt	`'%Y-%m-%d'`	System date format, used mostly in RecentChanges
datetime_fmt	`'%Y-%m-%d %H:%M:%S'`	Default format for dates and times (when the user has no preferences or chose the "default" date format)
edit_bar	`...`	list of edit bar entries
history_count	`(100, 200)`	number of revisions shown for info/history action (default_count_shown, max_count_shown)
html_pagetitle	`None`	Allows you to set a specific HTML page title (if None, it defaults to the value of `sitename`)
interwiki_preferred	`[]`	In dialogues, show those wikis at the top of the list.
interwikiname	`None`	unique and stable InterWiki name (prefix, moniker) of the site, or None
logo_string	`None`	The wiki logo top of page, HTML is allowed (`<img>` is possible as well) [Unicode]
navi_bar	`...`	Most important page names. Users can add more names in their quick links in user preferences. To link to URL, use `u"[url link title]"`, to use a shortened name for long page name, use `u"[LongLongPageName title]"`. To use page names with spaces, use `u"[page_name_with_spaces any title]"` [list of Unicode strings]
page_credits	`...`	list with html fragments with logos or strings for crediting.
page_footer1	`''`	Custom HTML markup sent before the system footer.
page_footer2	`''`	Custom HTML markup sent after the system footer.
page_header1	`''`	Custom HTML markup sent before the system header / title area but after the body tag.
page_header2	`''`	Custom HTML markup sent after the system header / title area (and body tag).
page_iconbar	`...`	list of icons to show in iconbar, valid values are only those in page_icons_table. Available only in classic theme.
page_icons_table	`...`	dict of {'iconname': (url, title, icon-img-key), ...}. Available only in classic theme.
show_hosts	`True`	if True, show host names and IPs. Set to False to hide them.
show_interwiki	`False`	if True, let the theme display your interwiki name
show_names	`True`	if True, show user names in the revision history and on RecentChanges. Set to False to hide them.
show_section_numbers	`False`	show section numbers in headings by default
show_timings	`False`	show some timing values at bottom of a page
show_version	`False`	show moin's version at the bottom of a page
sistersites	`[]`	list of tuples `('WikiName', 'sisterpagelist_fetch_url')`
sitename	`u'Untitled Wiki'`	Short description of your wiki site, displayed below the logo on each page, and used in RSS documents as the channel title [Unicode]
stylesheets	`[]`	List of tuples (media, csshref) to insert after theme css, before user css, see HelpOnThemes.
supplementation_page	`False`	if True, show a link to the supplementation page in the theme
supplementation_page_name	`u'Discussion'`	default name of the supplementation (sub)page [unicode]
supplementation_page_template	`u'DiscussionTemplate'`	default template used for creation of the supplementation page [unicode]
theme_default	`'modern'`	the name of the theme that is used by default (see HelpOnThemes)
theme_force	`False`	if True, do not allow to change the theme
traceback_show	`True`	if True, show debug tracebacks to users when moin crashes
trail_size	`20`	Number of pages in the trail of visited pages

URLs

Variable name	Default	Description
notification_bot_uri	`None`	URI of the Jabber notification bot.
url_mappings	`{}`	lookup table to remap URL prefixes (dict of `'prefix': 'replacement'`); especially useful in intranets, when whole trees of externally hosted documents move around
url_prefix_action	`None`	Use 'action' to enable action URL generation to be compatible with robots.txt. It will generate .../action/info/PageName?action=info then. Recommended for internet wikis.
url_prefix_local	`None`	used as the base URL for some Javascript - set this to a URL on same server as the wiki if your url_prefix_static points to a different server.
url_prefix_static	`'/moin_static181'`	used as the base URL for icons, css, etc. - includes the moin version number and changes on every release. This replaces the deprecated and sometimes confusing `url_prefix = '/wiki'` setting.

User Preferences related

Variable name	Default	Description
email_subscribed_events_default	`...`
jabber_subscribed_events_default	`[]`
quicklinks_default	`[]`	List of preset quicklinks for a newly created user accounts. Existing accounts are not affected by this option whereas changes in navi_bar do always affect existing accounts. Preset quicklinks can be removed by the user in the user preferences menu, navi_bar settings not.
subscribed_pages_default	`[]`	List of pagenames used for presetting page subscriptions for newly created user accounts.
tz_offset	`0.0`	default time zone offset in hours from UTC
userprefs_disabled	`[]`	Disable the listed user preferences plugins.

Users / User settings

Variable name	Default	Description
user_checkbox_defaults	`...`	Defaults for user preferences, see /UserPreferences.
user_checkbox_disable	`[]`	Disable user preferences, see /UserPreferences.
user_checkbox_fields	`...`	Describes user preferences, see /UserPreferences.
user_checkbox_remove	`[]`	Remove user preferences, see /UserPreferences.
user_email_unique	`True`	if True, check email addresses for uniqueness and don't accept duplicates.
user_form_defaults	`...`
user_form_disable	`[]`	list of field names used to disable user preferences form fields
user_form_fields	`...`
user_form_remove	`[]`	list of field names used to remove user preferences form fields
user_homewiki	`'Self'`	interwiki name of the wiki where the user home pages are located (useful if you have many users). You could even link to nonwiki "user pages" if the wiki username is in the target URL.
user_jid_unique	`True`	if True, check Jabber IDs for uniqueness and don't accept duplicates.
user_transient_fields	`...`	User object attributes that are not persisted to permanent storage (internal use).

Various

Variable name	Default	Description
bang_meta	`True`	if True, enable `!NoWikiName` markup
caching_formats	`['text_html']`	output formats that are cached; set to [] to turn off caching (useful for development)
config_check_enabled	`False`	if True, check configuration for unknown settings.
default_markup	`'wiki'`	Default page parser / format (name of module in `MoinMoin.parser`)
html_head	`''`	Additional <HEAD> tags, see HelpOnThemes.
html_head_index	`...`	Additional <HEAD> tags for some few index pages.
html_head_normal	`...`	Additional <HEAD> tags for most normal pages.
html_head_posts	`...`	Additional <HEAD> tags for POST requests.
html_head_queries	`...`	Additional <HEAD> tags for requests with query strings, like actions.
language_default	`'en'`	Default language for user interface and page content, see HelpOnLanguages.
language_ignore_browser	`False`	if True, ignore user's browser language settings, see HelpOnLanguages.
log_reverse_dns_lookups	`True`	if True, do a reverse DNS lookup on page SAVE. If your DNS is broken, set this to False to speed up SAVE.
log_timing	`False`	if True, add timing infos to the log output to analyse load conditions
mimetypes_embed	`...`	mimetypes that can be embedded by the EmbedObject macro
mimetypes_xss_protect	`...`	"content-disposition: inline" isn't used for them when a user downloads such attachments
refresh	`None`	refresh = (minimum_delay_s, targets_allowed) enables use of `#refresh 5 PageName` processing instruction, targets_allowed must be either `'internal'` or `'external'`
rss_cache	`60`	suggested caching time for RecentChanges RSS, in second
search_results_per_page	`25`	Number of hits shown per page in the search results
siteid	`'default'`

Xapian search

Configuration of the Xapian based indexed search, see HelpOnXapian.

Variable name	Default	Description
xapian_index_dir	`None`	Directory where the Xapian search index is stored (None = auto-configure wiki local storage)
xapian_index_history	`False`	True to enable indexing of non-current page revisions.
xapian_search	`False`	True to enable the fast, indexed search (based on the Xapian search library)
xapian_stemming	`False`	True to enable Xapian word stemmer usage for indexing / searching.