welcome: please sign in

The following 969 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
able   about   above   accents   accept   acceptable   access   Access   accounts   acl   action   Actions   actions   adapt   adapted   adaptor   add   Additional   address   addresses   admin   administration   Administrators   affect   affected   after   against   all   allow   allowed   Allows   already   also   although   always   amount   an   analyse   Anchor   and   another   answers   antispam   any   anyone   Anything   anywhere   Apache   appearance   applytoken   arbitrary   archive   are   around   as   ascii   at   Attachments   attachments   auth   Auth   Authentication   authentication   autocreate   automatically   Available   backups   bang   bar   base   based   be   Because   because   before   behaviour   being   below   between   Book   both   bottom   box   broken   browser   builtin   but   by   bytes   cache   cached   caching   call   called   can   capable   case   cases   categories   Category   category   causing   Certain   cgi   change   Change   changed   changes   Changes   changing   channel   Character   character   characters   chars   charset   chart   Chas   Check   check   checkbox   checker   checking   checks   Chinese   choice   choose   chose   Class   class   classic   clients   code   coding   comes   comments   common   compatible   conditions   config   Config   configs   configuration   Configuration   configure   configured   Configuring   configuring   confused   confusing   contain   containing   contains   content   Contents   control   Control   converted   cookie   Copy   copy   correct   correctly   could   count   course   crashes   created   creation   crediting   credits   css   csshref   current   Custom   Customization   customize   data   date   dates   datetime   de   debug   decode   Default   default   defaults   define   defined   definition   definitions   delay   denied   denies   deny   deprecated   description   Description   Desktop   desktop   details   Developers   development   dialogues   dict   Dict   dictionary   didn   difference   different   digit   dir   directly   Directory   directory   disable   Disable   disabled   Discussion   display   displayed   disposition   distribution   dns   do   Do   Doc   Docbook   docbook   documents   does   doesn   doing   domain   domains   don   done   dot   downloads   Ds   duplicates   E8   each   early   edit   Edit   editing   Edition   editor   Editor   edits   either   element   else   email   Email   emails   embed   Embed   embedded   en   enable   enabled   enables   encoded   encoding   encodings   ends   engine   English   enough   entries   environments   especially   Especially   etc   Etch   even   ever   every   everything   Everything   exact   exactly   example   examples   Exclude   excluded   Existing   existing   expect   explains   Explanation   explicitly   external   externally   extracted   False   farm   Farm   farmconfig   fetch   fetches   File   file   filename   filenames   files   Find   fine   first   First   fmt   follow   followed   following   footer   For   for   force   form   format   formats   fragments   freechoice   French   from   front   ftp   full   func   further   gdchart   General   generate   generation   German   get   give   gives   global   go   good   google   grammar   group   Group   gui   hacks   handler   Handler   Handling   handling   has   have   head   header   headings   Hebrew   height   help   Help   Here   hide   hint   hints   history   hits   home   homewiki   hook   host   hosted   hosting   hosts   hours   how   html   http   icon   iconbar   iconname   icons   idea   identifier   identifiers   if   If   ignore   image   img   implementing   import   importable   Important   important   imported   in   In   included   includes   indentation   indented   index   indexed   individual   info   information   infos   inherit   inheritance   inherited   inheriting   init   inline   input   insert   install   installation   installed   Installing   instead   instruction   instructions   Inter   interface   intermap   internal   internally   international   International   internet   interwiki   interwikiname   into   intranets   intsetup   is   isn   iso   it   It   item   items   Jabber   jid   Just   just   keep   key   keyboard   know   language   languages   Languages   last   Latin   latin   least   leaving   left   length   let   letter   letters   License   license   lifetime   like   line   lines   link   linked   links   list   List   listed   Lists   load   loads   Local   local   locally   located   lock   locking   log   logging   logo   logos   Long   long   look   lookup   lookups   lowercase   Lowercase   lowerletters   Ls   macro   Macros   made   mail   maintain   make   making   manage   many   mappings   mark   Market   markup   markups   master   Master   match   matching   max   means   media   menu   Menu   meta   methods   might   mimetypes   minimum   minutes   mix   modern   module   moinmaster   moinmo   moinmoin   moniker   more   More   most   Most   mostly   move   much   multiconfig   multiple   multiwiki   must   My   mywiki   name   Name   named   names   navi   necessary   need   needs   new   newly   next   Next   no   No   non   None   nonexist   nonwiki   not   note   Note   notes   Notes   now   Number   number   numbers   Object   object   objects   Of   of   off   offset   On   on   one   only   option   optional   options   Options   or   order   org   original   other   our   out   output   override   Overview   owner   page   Page   Pagenames   pagenames   pages   Pages   pagetitle   pair   pairs   parser   part   password   path   Path   pathes   pattern   per   permanently   persistent   place   plain   Please   please   plugins   Policy   policy   port   possible   powers   predefine   preferences   Preferences   preferred   prefix   prefixes   prefixing   Preset   preset   presetting   proceeds   process   processing   protect   protection   Protection   provided   Ps   py   pyc   python   qm   question   questions   quick   quickhelp   Quickhelp   quicklinks   re   read   Read   ready   really   receiving   Recent   recognized   Recommended   refresh   regarded   regex   Related   release   remap   remove   removed   rendering   replacement   replaces   request   resides   restrictions   results   reverse   revision   revisions   right   rights   robots   rowbgcolor   rows   rss   rule   run   running   same   sample   save   says   schemas   script   search   searches   searching   seconds   section   Security   security   See   see   Self   Sending   sent   sequence   Server   server   session   Session   Sessions   Set   set   setting   settings   setup   Setup   several   share   shared   shipped   Short   short   shortened   should   show   shown   simple   simpler   simply   single   singlewiki   sisterpagelist   sistersites   site   Site   sitename   size   sizes   smiley   smileys   so   So   software   some   Some   somehow   something   sometimes   space   spaces   Spam   spam   special   specific   specify   speed   Spell   spell   spellchecker   spelling   Spelling   spiders   Standalone   static   static170   stays   store   string   strings   structure   stuff   stylesheets   sub   subnet   subscribed   subscriptions   such   suggested   Suite   suited   Super   super   superuser   supplementation   supplied   Support   support   supports   sure   Surge   surge   switch   sys   system   System   table   Table   tabs   tags   target   targets   technically   tell   tells   Template   template   templates   tested   Text   text   textchas   that   The   the   their   them   theme   Themes   then   Then   theonepreferred   there   these   they   This   this   those   through   thus   Time   time   timeout   times   timing   timings   title   to   To   too   top   Topics   total   touch   traceback   tracebacks   traffic   trail   translation   trees   tries   True   Trusted   trusted   try   Ts   tuples   turn   Twisted   txt   tz   ua   ucs   ui   umask   umlauts   underlay   understand   Unicode   unicode   unique   uniqueness   Untitled   unwanted   unzip   up   updates   uppercase   upperletters   ur   url   usable   use   Use   used   Used   useful   User   user   username   userprefs   Users   users   uses   using   usual   usually   utf   valid   value   values   Values   Variable   variable   variables   version   via   view   virtual   visited   Voodoo   want   warn   We   we   well   western   wget   what   When   when   where   whereas   whether   which   whole   why   wide   width   Wiki   wiki   wikiconfig   wikiname   wikis   wikiwikiweb   will   with   within   Without   without   wondering   word   Words   words   work   world   writing   wrong   wsgi   Xapian   xapian   Xml   xmlrpc   xmlrpc2   xslt   xss   yet   You   you   your   zip   zone  

Clear message
Page Locked


HelpContents > HelpForAdministrators > HelpOnConfiguration

This page should help you with configuring an already installed MoinMoin wiki. If you have not installed one yet please go to HelpOnInstalling.

1. General

1.1. Character Set

Moin uses Unicode internally, and utf-8 for external output and input, like pages, HTML output and translation files. The external character set is defined in config.charset to utf-8. This setting is fine for all languages, as any character can be encoded in UTF-8. You should not change this value, although technically it is possible.

Certain options must use Unicode values. For example, the site name could contain German umlauts or French accents or be in Chinese or Hebrew. Because of this, you must use unicode strings for those items. Unicode strings are defined by prefixing the letter u to the string. Here are some examples:

    # Site name, used by default for wiki name-logo [Unicode]
    sitename = u"Jürgen's Wiki"
    # another example:
    sitename = u'הוויקי של יורגן'

Read the comments in the configuration file - they tell you which options must use Unicode values.


1.2. International Setup

The default configuration file shipped with moin uses iso-8859-1 coding. This is fine for Latin languages like English or German, but not usable for non-latin languages. If you want to have non-latin characters in your configuration items, use utf-8 coding for the config file.

Set the first line of all configuration files to this line:

# -*- coding: utf-8 -*-

Values using unicode strings can be recognized by their default value being u"...." or ur"..." (the u means unicode) or when the description explicitly tells [unicode].

For ready made configuration in your language, see ConfigMarket. Read also the section about unicode options.

1.3. Customization of user preferences

You can predefine, disable or remove several options in the user preferences, see HelpOnConfiguration/UserPreferences.

2. Configuring a single wiki

If you run a single wiki, you should not copy the file farmconfig.py into your configuration directory (remove it and the .pyc file, if it is there). Without farmconfig, moin uses the default wikiconfig.py.

wikiconfig.py can be located anywhere, you just have make sure it can be imported by moin - it is a good idea to add the directory where it resides as first element to sys.path (this is the list of pathes python uses when searching for importable stuff). sys.path setup is done early, usually in the server adaptor script you use (e.g. moin.cgi or moin.wsgi) - see the comments in the script for details.

General notes on wiki/farmconfig.py structure:

# -*- coding: iso-8859-1 -*-

from MoinMoin.config.multiconfig import DefaultConfig

class Config(DefaultConfig):

    sitename = u'MyWiki'   # u means that it will be converted to Unicode
    interwikiname = 'MyWiki'
    data_dir = '/where/ever/mywiki/data/'
    underlay_dir = '/where/ever/mywiki/underlay/'
    # More settings follow...

3. Configuration of multiple wikis

The moinmoin wiki engine is capable of handling multiple wikis using a single installation, a single set of configuration files and a single server process. Especially for persistent environments like Twisted, this is necessary, because the Twisted server will permanently run on a specific IP address and TCP port number. So for virtual hosting of multiple domains (wikis) on the same IP and port, we need the wiki engine to permanently load multiple configs at the same time and choose the right of them when handling a request for a specific URL.

To be able to choose the right config, moin uses config variable wikis located in the file farmconfig.py - it simply contains a list of pairs (wikinameurl-regex). Please only use valid python identifiers for wikiname (to be exact: identifier ::= (letter|"_") (letter | digit | "_")* - just try with a simple word if you didn't understand that grammar rule). When processing a request for some URL, moin searches through this list and tries to match the url-regex against the current URL. If it doesn't match, it simply proceeds to the next pair. If it does match, moin loads a configuration file named <wikiname>.py (usually from the same directory) that contains the configuration for that wiki.

farmconfig.py in the distribution archive has some sample entries for a wiki farm running multiple wikis. You need to adapt it to match your needs if you want to run multiple wikis.

/!\ For simpler writing of these help pages, we will call such a <wikiname>.py configuration file simply wikiconfig.py, of course you have to use the filename you chose.

Of course you have already adapted the wikis setting in farmconfig.py (see above), so we only give some hints how you can save some work. Please also read the single wiki configuration hints, because it explains config inheritance.

We now use the class-based configuration to be able to configure the common settings of your wikis at a single place: in the base configuration class (see farmconfig.py for an example):


# -*- coding: iso-8859-1 -*-
# farmconfig.py:
from MoinMoin.config.multiconfig import DefaultConfig
class FarmConfig(DefaultConfig):
    url_prefix = '/wiki'
    show_hosts = True
    underlay_dir = '/where/ever/common/underlay'
    # ...

The configs of your individual wikis then only keep the settings that need to be different (like the logo, or the data directory or ACL settings). Everything else they get by inheriting from the base configuration class, see moinmaster.py for a sample.


# -*- coding: iso-8859-1 -*-
# moinmaster.py:
from farmconfig import FarmConfig
class Config(FarmConfig):
    show_hosts = False
    sitename = u'MoinMaster'
    interwikiname = 'MoinMaster'
    data_dir = '/org/de.wikiwikiweb.moinmaster/data/'
    # ...

4. Overview of Configuration Options

The following table contains default values and a short description for most configuration variables. Most of these can be left at their defaults, those you need to change with every installation are listed in the sample wikiconfig.py that comes with the distribution.

(!) You can also have a look at MoinMoin/config/multiconfig.py, class DefaultConfig for further information (that file has the builtin default configuration).

Variable name





if True, give all local users special powers - only use this for a local desktop wiki!



Class object hook for implementing security restrictions



wiki-wide access control list definition (see HelpOnAccessControlLists)


['xmlrpc', 'CopyPage', 'MyPages']

Exclude unwanted actions (list of strings)



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)



where antispam security policy fetches spam pattern updates (if it is enabled)



list of auth objects, to be called in this order (see HelpOnAuthentication)


['http', 'xmlrpc_applytoken']

authentication methods for which users should be included in the special "Trusted" ACL group.



if True, enable !NoWikiName markup



Path to the farm wide cache directory.



output formats that are cached; set to [] to turn off caching (useful for development)



Time format used on RecentChanges for page edits within the last 24 hours



If you have gdchart, use something like chart_options = {'width': 720, 'height': 540}



Change domain, path and lifetime of moin's session cookie, see HelpOnSessions.



Path to the data directory containing your (locally made) wiki pages.



Path to the underlay directory containing distribution system and help pages.



System date format, used mostly in RecentChanges


'%Y-%m-%d %H:%M:%S'

Default format for dates and times (when the user has no preferences or chose the "default" date format)



Default page parser / format (name of module in MoinMoin.parser)



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.


['Edit', ..., 'ActionsMenu']

list of edit bar entries



Editor to use by default, 'text' or 'gui'



if True, force using the default editor



Editor choice shown on the user interface, 'freechoice' or 'theonepreferred'


{'wiki':"...", ...}

Quickhelp provided at the bottom of edit pages. To customize, specify a dictionary with key matching default_markup (e.g. 'wiki') and give a string value containing wiki markup


'warn 10'

Editor locking policy: None, 'warn <timeout in minutes>', or 'lock <timeout in minutes>'



Default height of the edit box



for use by moin development


(100, 200)

number of revisions shown for info/history action (default_count_shown, max_count_shown)



List of denied IPs; if an IP ends with a dot, it denies a whole subnet (class A, B or C)



Additional <HEAD> tags, see HelpOnThemes.



Allows you to set a specific HTML page title (if None, it defaults to the value of sitename)



InterWiki name (prefix, moniker) of the site, or None



In dialogues, show those wikis at the top of the list.



Default language for user interface and page content, see HelpOnLanguages!



if True, ignore user's browser language settings, see HelpOnLanguages!



The wiki logo top of page, HTML is allowed (<img> is possible as well) [Unicode]



if True, do a reverse DNS lookup on page SAVE. If your DNS is broken, set this to False to speed up SAVE.



if True, add timing infos to the log output to analyse load conditions



Sending and receiving of email, see /EmailSupport.


['text/html', ...]

"content-disposition: inline" isn't used for them when a user downloads such attachments



mimetypes that can be embedded by EmbedObject macro



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]



if True, display links to non-existing pages with a question mark by default, like in the original wiki (can be changed in userprefs)



Pagenames exactly matching this regex are regarded as Wiki categories [Unicode]



list with html fragments with logos or strings for crediting.



Pagenames exactly matching this regex are regarded as pages containing variable dictionary definitions [Unicode]



Name of the front page. We don't expect you to keep the default. Just read HelpOnLanguages in case you're wondering... [Unicode]



Pagenames exactly matching this regex are regarded as pages containing group definitions [Unicode]

page_header* / page_footer*


Custom HTML markup sent by the theme, see HelpOnThemes.


["view", ...]

list of icons to show in iconbar, valid values are only those in page_icons_table. Available only in classic theme.



dict of {'iconname': (url, title, icon-img-key), ...}. Available only in classic theme.



if True, show a license hint in page editor.



Page linked from the license hint. [Unicode]



Name of the page containing user-provided spellchecker words [Unicode]



Pagenames exactly matching this regex are regarded as pages containing templates for new pages [Unicode]



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)



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.



refresh = (minimum_delay_s, targets_allowed) enables use of #refresh 5 PageName processing instruction, targets_allowed must be either 'internal' or 'external'



suggested caching time for RecentChanges RSS, in seconds



Number of hits shown per page in the search results



Session handler, see HelpOnSessions



Path to a file containing global InterWiki definitions (or a list of such filenames)



if True, show host names and IPs. Set to False to hide them.



if True, let the theme display your interwiki name



if True, show user names in the revision history and on RecentChanges. Set to False to hide them.



1 to show section numbers in headings by default



if True, show some timing values at bottom of a page



if True, show moin's version at the bottom of a page



list of tuples ('WikiName', 'sisterpagelist_fetch_url')


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]


[(mediacsshref), ...]

List of tuples (media, csshref) to insert after theme css, before user css, see HelpOnThemes.



List of pagenames used for presetting page subscriptions for newly created user accounts.



List of trusted user names with wiki system administration super powers (not to be confused with ACL admin rights!). Used for e.g. making full backups, software installation, language installation via SystemPagesSetup and more. See also HelpOnSuperUser.



if True, show a link to the supplementation page in the theme



default name of the supplementation (sub)page [unicode]



default template used for creation of the supplementation page [unicode]



Surge protection tries to deny clients causing too much load/traffic, see /SurgeProtection.



Spam protection setup using site-specific questions/answers, see HelpOnTextChas.



the name of the theme that is used by default (see HelpOnThemes)



if True, do not allow to change the theme



if True, show debug tracebacks to users when moin crashes



Directory to store tracebacks or None.



Number of pages in the trail of visited pages



default time zone offset in hours from UTC



A regex of HTTP_USER_AGENTs that should be excluded from logging



max. number of files which are extracted from the zip file



max. total amount of bytes can be used to unzip files [bytes]



max. size of a single file in the archive which will be extracted [bytes]



lookup table to remap URL prefixes (dict of 'prefix': 'replacement'); especially useful in intranets, when whole trees of externally hosted documents move around



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.



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.



Disable the listed user preferences plugins



if True, user accounts are created automatically (see HelpOnAuthentication).



share user data between multiple wikis. See HelpOnUserHandling



if True, check email addresses for uniqueness and don't accept duplicates.



if True, check Jabber IDs for uniqueness and don't accept duplicates.



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_checkbox_* / user_form_*


Disable / remove / set defaults for user preferences, see /UserPreferences.



Configuration of the Xapian based indexed search, see HelpOnXapian.

Some values can only be set from MoinMoin/config/__init__.py (part of the moin code and thus GLOBALLY changing behaviour of all your wikis), but not from the individual wiki's config - you should only touch them if you know what you are doing:



the encoding / character set used by the wiki <!> Do not change config.charset. It is not tested and we can't support this.


ucs-2 lowercase letters

Lowercase letters, used to define what is a WikiName



a list of smiley markups moin supports - image and image sizes are defined in the theme code.



umask used by moin, the default gives rights to owner and group, but not to world.


ucs-2 uppercase letters

uppercase letters, used to define what is a WikiName


['http', 'ftp', ...]

URL schemas you want to have recognized

5. Related Topics

HelpForDevelopers HelpForUsers