HelpContents > HelpOnAdministration > HelpOnConfiguration

Subtopics

• /CascadingStyleSheets

• /EmailSupport

• HelpOnAccessControlLists (permissions/users control)

• /SecurityPolicy

• /FileAttachments

• /ApacheVoodoo

Contents

1. Configuring a single wiki
   1. Wiki configuration file structure
2. Unicode options
3. International Setup
4. Configuration of multiple wikis
5. Overview of configuration options
6. Special options
   1. Default front page
   2. Character Set

Configuring a single wiki

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

wikiconfig.py normally is located besides your moin.cgi driver script. If you need to make a custom install, it can be located anywhere, but you must add the path to the directory where it is located to your Python system path in your server script. See the "System Path Configuration" section in your server script.

Wiki configuration file structure

General notes on wiki/farmconfig.py structure:

# -*- coding: iso-8859-1 -*-
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/'
    # More settings follow...

• First, you must define the coding of the config file. The default setting is suited for Latin ("western") languages only, for international setup, read next section. If you don't define the coding, you can't use non-ascii characters.

• Next we import moin's internal default configuration. The default configuration includes values for all options, so we don't have to define all values, just what we want to customize.

• Then we define a new configuration class called "Config" and inherit all settings from the default configuration we imported. Note that the class name must be "Config".

• Next lines are the configuration options for the Config class. Note that each line must be indented by 4 spaces, tabs are not allowed. Moin will not run if you use wrong indentation.

• A common configuration item is sitename - in most cases you don't want your wiki to have the default "Untitled Wiki" name. You can define any name you like in any language, but before you do that, read next section on unicode options.

• If you followed the install instructions, the wiki will run without any other change, but you might want to change some values, like data_dir, data_underlay_dir acl_rights_before and more. For most cases, setting all the values in the supplied wikiconfig.py file is enough.

• Anything we do not define simply stays at moin's internal defaults which we inherited from !DefaultConfig.

Unicode options

• Important: to use unicode values, you must setup a correct coding line in the first line of your configuration file. Check that your editor is configured correctly.

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.

Notes:

• You can't mix different encodings in the same file. If your coding line says iso-8859-1, all your characters, the whole file content, must be in that encoding.

• If you use utf-8 encoding (or plain ascii), you don't have to use unicode strings, moin will decode your string correctly for you. New in 1.3.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 -*-

• You need a text editor being capable of (and also really using) utf-8 encoding for editing the config files.

Values using unicode strings (international users might want to change them):

• sitename

• logo_string

• page_front_page

• navi_bar

• default_lang

• page_category_regex

• page_dict_regex

• page_form_regex

• page_group_regex

• page_template_regex

• page_license_page - New in 1.3.2

• page_local_spelling_words - New in 1.3.2

• acl_rights_default - New in 1.3.2

• acl_rights_before - New in 1.3.2

• acl_rights_after - New in 1.3.2

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

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

• first we import the default config, like we do when configuring a single wiki

• now we define a new farm config class - and inherit from the default config

• then we change everything that our farm wikis have in common, leaving out the settings that they need to be different

• this FarmConfig class will now be used by the config files of the wikis instead of moin's internal DefaultConfig class, see below:

# -*- 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:

• see single wiki configuration, the only difference is that we inherit from FarmConfig (that inherited from DefaultConfig) instead of directly using DefaultConfig

• now we override show_hosts to be 0 - we want it for most wikis in our farm, but not for this one

• we also override sitename, interwikiname and data_dir (the usual stuff)

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 options must use unicode strings. Read the section about unicode options.

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:

Special options

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.

So you have 2 choices for your site:

1. You will have a single language site, with a single language front page. Then just make your own single front page (and don't name it FrontPage) which is suitable for all people regardless of their native language and set the page_front_page setting to this name. For example:

    page_front_page = u'MyGreatProject'
   

2. You will have a multiple language site and you intend to speak the user's language (or at least some of those languages). In that case, just edit FrontPage to fit your needs. Also edit all the translations of FrontPage (like StartSeite) you want to support (and keep them all in sync). If you don't want (or cannot) support a specific language, then replace that translation by a redirect to e.g. the english FrontPage:

    #redirect FrontPage
   

• Don't simply delete the unwanted translations of FrontPage or they might show up again after a MoinMoin upgrade.

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.

• Do not change config.charset. It is not tested and we can't support this.