[Alice]

HelpOnConfiguration

The following 806 words could not be found in the dictionary of 635 words (including 635 LocalSpellingWords) and are highlighted below:

16bit   32bit   9a   able   above   abused   accessible   Accueil   achieved   acl   action   Actions   actions   adapt   adapted   add   Additional   additional   address   adds   Administration   administrator   again   against   Alias   all   allow   allowed   Allows   allows   alphabet   already   although   amp   an   An   Anchor   and   another   anyone   anything   anywhere   Apache   appropriate   arbitrary   archive   area   around   asp   associated   assume   at   Attach   attached   attachment   Attachments   attachments   attacker   attacks   auth   authenticated   automatically   available   bang   bar   base   based   basic   Be   be   Because   because   before   behaviour   belonging   below   besides   between   blanks   border   bottom   box   Box   Bs   built   but   By   by   cached   caching   call   called   calls   can   capable   Cascading   catch   categories   Category   category   changeable   changed   changes   Changes   Changing   changing   channel   character   characters   chars   charset   chart   choose   chose   class   coding   comes   common   commonhttpd   completed   concern   conf   config   Config   configs   configuration   Configuration   configure   configured   configuring   Consequently   contain   containing   contains   Contents   control   Control   convert   converted   cookie   copied   correct   course   crediting   credits   css   current   Custom   cycle   date   dates   datetime   de   decoded   Default   default   defaults   define   defined   definitions   delay   Denial   denied   denies   deny   depending   described   description   Description   development   dict   Dict   dictionary   difference   differences   different   difficult   dir   directly   disable   disables   disabling   display   displayed   displaying   distribution   documents   does   doing   domain   domains   dot   download   driver   during   E8   each   early   Editor   editor   edits   effect   efficiency   either   eliminate   else   en   enable   enabled   enables   encoded   encoding   encodings   ends   engine   enough   entered   entities   entries   entry   environments   equivalent   escaped   especially   Especially   etc   ever   every   everything   Everything   exactly   example   excluded   execute   existing   expected   expires   explains   Explanation   exploit   exploitable   ext   extended   external   externally   F3333   fail   False   farm   Farm   farmconfig   features   fetching   few   File   file   filename   filenames   files   Finally   find   fine   fmt   follow   following   footer   footer1   footer2   for   force   Form   form   format   formats   found   fragment   French   from   From   front   Front   gdchart   get   give   given   global   google   grained   group   Group   handling   head   header   header1   header2   headings   height   help   Help   hierarchical   hint   hints   hook   host   hosted   hosting   hostname   hosts   hours   how   However   httpd   icon   iconbar   iconname   icons   If   if   image   img   implementing   import   important   imported   in   include   indent   indentation   Index   index   individual   inherit   inheritance   inherited   inheriting   inline   insert   installation   installed   instead   instruction   instructions   intend   interface   intermap   internal   internally   Internally   interwikiname   into   intranets   invocation   iso   iso8859   its   jpg   keep   key   know   lang   language   languages   Languages   last   latin   leading   leave   leaving   left   let   letters   level   License   license   lifetime   like   line   link   linked   links   list   List   listed   Lists   literal   load   loaded   loads   Local   local   locally   located   location   lock   locking   log   logged   logging   login   logo   logos   lookup   lowerletters   Ls   machine   made   mail   mailing   mails   main   make   making   malicious   many   mappings   mark   Master   match   matches   means   meta   minimum   minutes   mix   mkdir   models   modern   modify   module   moniker   most   Most   mostly   move   multiconfig   multiple   must   My   myorg   mypix   mywiki   mywikiattach   Name   name   named   names   navi   necessary   need   needs   new   next   No   no   nofollow   noindex   non   None   nonexist   normal   normally   note   notification   now   number   Number   numbers   numeric   object   Of   of   off   offset   old   one   only   open   option   options   or   original   other   others   our   out   output   outside   over   overhead   override   Overview   own   page   Page   pagename   Pagenames   pagetitle   pair   pairs   parsed   parser   part   path   Path   paths   people   per   permanently   permissions   persistent   php   php3   php4   phtml   place   Policy   policy   port   possible   possibly   posts   Powered   preferable   preferences   prefix   prefixes   privately   proceeds   process   processing   provided   Ps   pwd   Python   python   qm   question   quick   read   reason   Recent   recognized   recommend   refresh   regarded   regardless   regex   remap   remember   remotely   remove   Remove   replacement   replacing   request   requests   requires   restart   restrictions   retrieval   retrieve   retrieved   Review   review   ridden   right   rights   risk   robots   rowbgcolor   rows   run   running   same   sample   Sand   save   schemas   script   Script   scripts   searches   second   section   Security   security   Self   send   sent   servable   serve   served   server   servers   Service   serving   set   sets   setting   settings   shared   Sheets   Short   short   should   show   Show   showing   shown   shows   similar   simpler   simply   Since   single   sit   site   sitename   sits   size   Skins   slashes   smarthost   smileys   So   so   some   Some   Somepage   something   special   specific   spellchecker   spelling   Spelling   spiders   spoken   Starting   statement   statements   stays   step   steps   still   storage   store   stored   string   strings   structure   stuff   Style   Sub   subnet   subpages   Subtopics   such   suitable   Suite   Support   support   sure   system   System   Table   table   tags   take   target   targets   technically   tell   tells   Template   template   templates   test   text   than   that   their   them   theme   Themes   then   Then   There   there   these   they   thing   things   this   This   those   through   thus   Thus   Time   time   timeout   times   timing   timings   title   to   To   top   touch   trail   trailing   translated   trees   tries   True   true   Ts   tuple   turn   twisted   two   Type   tz   ua   ucs   umask   underlay   Unicode   unicode   Unless   unnamed   Unnamed   unsafe   until   up   upload   uploaded   uploading   uploads   upperletters   use   Use   used   Used   useful   user   username   users   uses   Using   using   usual   usually   utf   value   values   Variable   variable   variables   verify   version   via   view   virtual   visited   want   Wanted   warn   We   we   weaknesses   web   webserver   well   were   western   wget   what   When   when   where   which   while   whole   why   width   wikiconfig   wikiname   wikiwikiweb   will   With   with   within   without   Words   words   work   works   writing   wrong   xslt   You   you   Your   your   zone  

Clear message

HelpContents > HelpOnAdministration > HelpOnConfiguration

Subtopics

Index

  1. Configuration of MoinMoin
    1. Configuration of a single wiki
    2. Configuration of multiple wikis
    3. Overview of configuration options
    4. Default front page
    5. Changing character sets
    6. File attachments

Configuration of MoinMoin

Configuration of a single wiki

If you run a single wiki only, you should not use the file farmconfig.py, remove it from your configuration directory. Moin will then use a built-in list [("wikiconfig", r".*")] that matches every request to the config file wikiconfig.py.

A single MoinMoin wiki is configured by changing the wikiconfig.py file, which normally sits besides your moin.cgi driver script. wikiconfig.py is imported by the MoinMoin main code early in a request cycle and is found because the current directory (i.e. that of moin.cgi) is part of the Python system path. Consequently, wikiconfig.py can sit anywhere in your PYTHONPATH.

# -*- coding: iso-8859-1 -*-
# wikiconfig.py:
from MoinMoin.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/'
    # ...

Explanation:

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 (wikiname, url-regex). 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. Internally, moin adds a catch all ('wikiconfig', '.*') to the end of that list, so you do not need something like this in farmconfig.wikis.

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).

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 -*-
# farmconfig.py:
from MoinMoin.multiconfig import DefaultConfig
class FarmConfig(DefaultConfig):
    url_prefix = '/wiki'
    show_hosts = 1
    underlay_dir = '/where/ever/common/underlay'
    # ...

Explanation:

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

Explanation:

Overview of configuration options

The following table contains default values and a short description for all 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.

/!\ Starting with moin 1.3.1, some values MUST be Unicode. This is achieved like this: u'encoded string' (the u is the important thing and means to convert the encoded string to Unicode). Also, the encoding used for your config file must be given in the "coding" line at top of the file. For English (and some other western languages), use iso-8859-1, for others you may want to use utf-8.

Variable name

Default

Description

SecurityPolicy

None

class object hook for implementing security restrictions

acl_enabled (& acl_...)

0

true to enable Access Control Lists - fine grained page access rights settings (see HelpOnAccessControlLists)

allow_extended_names

1

true to enable ["free link"] markup

allow_numeric_entities

1

if true, numeric entities like &#8364; for € are not escaped, but &amp; and stuff still is

allow_xslt

0

true to enable 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 0)

allowed_actions

[]

allow unsafe actions (list of strings)

attachments

None

If None, send attachments via CGI; else this has to be a dictionary with the path to attachment storage (key dir) and the equivalent URL prefix to that same dir (key url)

auth_http_enabled

0

true to enable moin using the username of a user already authenticated by http basic auth

backtick_meta

1

true to enable `inline literal` markup

bang_meta

0

true to enable !NoWikiName markup

caching_formats

['text_html']

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

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}

cookie_lifetime

12

12 hours from now until the MoinMoin cookie expires and you get logged out

data_dir

'./wiki/data/'

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

data_underlay_dir

'./wiki/underlay/'

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

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)

default_lang

'en'

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

default_markup

'wiki'

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

edit_locking

'warn 10'

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

edit_rows

30

Default height of the edit box

hosts_deny

[]

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

html_head

Additional <HEAD> tags for all pages (see HelpOnSkins)

html_head_posts

robots: noindex,nofollow

Additional <HEAD> tags for POST requests

html_head_index

robots: index,follow

Additional <HEAD> tags for some few index pages

html_head_normal

robots: index,nofollow

Additional <HEAD> tags for most normal pages

html_pagetitle

None

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

interwikiname

None

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

logo_string

sitename

Used to show the name of the site at the top of page, HTML is allowed (<img> is possible as well)

mail_from

None

From: header used in sent mails

mail_login

None

"user pwd" if you need to use SMTP AUTH

mail_smarthost

None

IP or domain name of an SMTP-enabled server; note that email features (notification, mailing of login data) works only if this variable is set

navi_bar

list of default quick links (Unicode)

Most important links in text form (these links can be over-ridden by the user's quick links); to link to any URL, use a free-form link of the form u"[url text]"

nonexist_qm

0

Default for displaying WantedPages with a question mark, like in the original wiki (changeable by the user)

page_category_regex

u'^Category[A-Z]'

Pagenames containing a match for this regex are regarded as Wiki categories

page_credits

MoinMoin and PythonPowered

html fragment with logos or strings for crediting

page_dict_regex

u'[a-z]Dict$'

Pagenames containing a match for this regex are regarded as containing variable dictionary definitions

page_footer1

""

Custom HTML markup sent before the system footer (see HelpOnSkins)

page_footer2

""

Custom HTML markup sent after the system footer (see HelpOnSkins)

page_form_regex

u'[a-z]Form$'

Pagenames containing a match for this regex are regarded as containing form definitions

page_front_page

u'FrontPage'

Name of the front page (see Default front page)

page_group_regex

u'[a-z]Group$'

Pagenames containing a match for this regex are regarded as containing group definitions

page_header1

""

Custom HTML markup sent before the system header / title area (see HelpOnSkins)

page_header2

""

Custom HTML markup sent after the system header / title area (see HelpOnSkins)

page_iconbar

["view", ...]

list of icons to show in iconbar

page_icons_table

dict

dict of {'iconname': (url, title, icon-img-key), ...}

page_license_enabled

0

Show a license hint in page editor.

page_license_page

u'WikiLicense'

Page linked from the license hint.

page_local_spelling_words

u'LocalSpellingWords'

Name of the page containing user-provided spellchecker words

page_template_regex

u'[a-z]Template$'

Pagenames containing a match for this regex are regarded as templates for new pages

refresh

None

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

shared_intermap

None

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

show_hosts

1

true to show hostname in RecentChanges

show_section_numbers

1

true to show section numbers in headings by default

show_timings

0

shows some timing values at bottom of page - used for development

show_version

0

show MoinMoin's version at the bottom of each page

sitename

u'An Unnamed MoinMoin Wiki'

Short description of your wiki site, displayed below the logo on each page, and used in RSS documents as the channel title

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

trail_size

5

Number of pages in the trail of visited pages

tz_offset

0.0

default time zone offset in hours from UTC

ua_spiders

...|google|wget|...

A regex of HTTP_USER_AGENTs that should be excluded from logging

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

'/wiki'

used as the base URL for icons, css, etc.

Some values can only be set from MoinMoin/config.py (part of the MoinMoin 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:

allow_subpages

1

true to enable hierarchical wiki pages (see HelpOnEditing/SubPages)

charset

'utf-8'

the encoding / character set used by the wiki

lowerletters

ucs-2 lowercase letters

Lowercase letters, used to define what is a WikiName

smileys

{}

user-defined smileys (a dict with the markup as the key and a tuple of width, height, border, image name as the value)

umask

0770

umask used on all open(), mkdir() and similar calls

upperletters

ucs-2 uppercase letters

uppercase letters, used to define what is a WikiName

url_schemas

[]

additional URL schemas you want to have recognized (list of strings)

Default front page

The default front page name, "FrontPage", is automatically translated into the user language. Thus, an English user will end up at FrontPage, while a French user will end up at PageD'Accueil.

/!\ If you have made your own front page which is suitable for all people regardless of their spoken languages, you should give it a different name (anything but "FrontPage" will do) and set the page_front_page setting to this name. For example:

page_front_page = 'MyFrontPage'

Changing character sets

Do not. By default, moin uses unicode (depending on your python, it will use either ucs-2 16bit or ucs-4 32bit chars) internally and utf-8 as external character encoding.

/!\ You should not have to change this, as any character can be encoded in utf-8. So we do not recommend changing the default. We also do not support non-utf-8 encodings, although it is technically possible:

# MoinMoin/config.py - this is GLOBAL for all wikis in your installation!
charset = "iso8859-1"
upperletters = "A-Z"
lowerletters = "0-9a-z"

With that setting, you need to set "allow_extended_names=1" and use the special markup for extended WikiNames ["extended name"] to get any names with characters outside the core latin alphabet.

File attachments

The [Self]AttachFile action enables a page to have multiple attached files. Since file uploads could be abused for DoS (Denial of Service) attacks, AttachFile is an action that may be enabled by the wiki administrator. To do this, add "allowed_actions = ['AttachFile']" to your configuration file.

If you wiki has (or is expected to have) many file attachments, there is an option which will eliminate the CGI overhead associated with each retrieval of an attachment file.

/!\ If you make your attachments directly accessible via the web server, you should make sure that the web server does not execute stuff (like php or asp or other scripts) uploaded by some malicious user. /!\

If you do not know how to do that, do not configure your moin like described below or you risk making your server remotely exploitable.

There are two storage/retrieval models for file attachments:

  1. Attachments are stored "privately" and can only be retrieved via a CGI GET (via URLs like http://myorg.org/mywiki/<SomePage>?action=AttachFile&do=get&target=filename.ext).

  2. Attachments are stored into a directory directly accessible by the web server, and can thus be served directly by the webserver, without any invocation of MoinMoin (leading to URLs like http://myorg.org/mywikiattach/<Somepage>/attachments/filename.ext).

If the efficiency of serving file attachments is a concern, the second option is preferable, but it also requires additional configuration steps and possibly more rights on the host machine. Because of this, the first option is the default; attachments are stored in the "...mywiki/data/pages/" directory, with paths like "...mywiki/data/pages/<pagename>/attachments/<filename>".

The MoinMoin attachments configuration option allows you to move the directory structure used to store attachments to another location. Unless you have a reason for doing so, there is no need to use a different location. Using a different location may be more work and more risk, as all the existing attachments must be copied to the new location. The following instructions are for Apache servers and assume you intend to leave the attachment files in their existing location and your original installation used the name "mywiki".

The first step is to tell Apache that it has another Alias directory from which it can serve files. Review the changes you made to the httpd.conf (or commonhttpd.conf) file during the MoinMoin installation and find the ScriptAlias statement similar to the following:

    ScriptAlias /mywiki           ".../mywiki/moin.cgi" 

Create an Alias statement similar to the ScriptAlias statement above, replacing the /mywiki URI with /mywikiattach/ and replacing moin.cgi with data/pages/.

    Alias       /mywikiattach/    ".../mywiki/data/pages/"

Be sure to note the differences in the trailing slashes between the two statements, they must be entered exactly as shown above. If you are making this change to a running system, you must restart Apache to have the change take effect.

The second step is to tell MoinMoin to let Apache do the work of fetching file attachments. To do this, you need to add an attachments option to .../mywiki/wikiconfig.py. The 'attachment' option is a dictionary of two values:

attachments = {
    'dir': '.../mywiki/data/pages',
    'url': '/mywikiattach',
}

MoinMoin must still do the work of uploading file attachments. The dir value above tells MoinMoin where to store attachments; note this is the same as the path in the new Apache Alias statement but without the trailing "/". The url value tells MoinMoin how to retrieve the attachments; this matches the URI in the Alias statement but again without the trailing "/".

/!\ Your attached files are now directly servable by Apache. However if you also have PHP (or ASP or any other server parsed language) installed then an attacker can upload a PHP script an then run it to exploit other local weaknesses.

For example, you can disable PHP for the appropriate directory (note that it's difficult to include instructions for disabling all server parsed languages).

<Directory .../mywiki/data/pages/>
    RemoveType .php .php3 .php4 .phtml
</Directory>

/!\ This only disables php stuff - you have to add everything else on your own!

After you have completed the configuration changes, test by uploading an attachment for WikiSandBox. Then modify the WikiSandBox page to display the uploaded image or download the file. If there were existing attachments before this change, verify the old attachments are still available. Finally, review the Apache access.log file to verify you have a log entry showing the expected file access: