Большая часть возможностей DokuWiki настраивается с помощью соответствующих параметров конфигурационного файла.

Эта страница описывает все возможные параметры и все их возможные значения. Значения по умолчанию для всех параметров хранятся в файле conf/dokuwiki.php. Если вы хотите изменить какие-либо из этих параметров, то лучше всего сделать это в файле conf/local.php — это гарантирует сохранение внесённых изменений при обновлении DokuWiki. Менеджер конфигурации также работает с этим файлом.

Пример файла conf/local.php:

<?php
$conf['title']     = "Admin's Wiki";
$conf['useacl']    = 1;
$conf['superuser'] = 'admin';
?>

Несколько замечаний относительно формата конфигурационного файла. Этот файл представляет собой фрагмент кода PHP, потому должен следовать синтаксису этого языка. В частности, каждая строка должна заканчиваться точкой с запятой. Переменные могут иметь следующе типы данных:

• Числовой. Значения записываются как есть. Пример: 9
• Строковой. Строки заключаются в одинарные или двойные кавычки. Например: 'foo bar'
• Логический. Допустимы значения true (истина) или false (ложь) или 1 и 0 соответственно.
• Массив представляет собой набор из нескольких значений одного из указанных выше типов.

Название конкретного установленного экземпляра вики. Вы можете устанавливать его произвольно. Если вы хотите установить несколько экземпляров вики на одном и том же сервере, то они должны иметь разные названия.

• Тип данных: строковой
• Значение по умолчанию: DokuWiki

Имя страницы по умолчанию в каждом пространстве имён вашего вики (включая корневое пространство имён). Эта страница загружается, если имя страницы в запросе не задано. Также называется домашней страницей (homepage).

• Тип данных: строковой
• Значение по умолчанию: start

Язык интерфейса вики. См. страницу Мультиязыковая поддержка.

• Тип данных: строковой
• Значение по умолчанию: en

Имя шаблона, используемого для отображения содержимого вики. Более подробно см. templates.

• Тип данных: строковой
• Значение по умолчанию: default

Относительный путь к подкаталогу (внутри каталога, определённого параметром basedir), в котором хранятся файлы вики. Этот каталог должен быть доступен web-серверу на запись.

• Тип данных: строковой
• Значение по умолчанию: ./data

Внутри этого каталога находится несколько подкаталогов и список изменений (changelog). Вы можете изменить их расположение с помощью следующих параметров:

Обычно Dokuwiki определяет каталог, в который он был установлен, автоматически. Однако, иногда, в силу некоторых причин, этот механизм не срабатывает. Если DokuWiki работает некорректно (например, не находит рисунки для собственных страничек), Вы можете указать каталог установки в этом параметре.

Указанный здесь путь — это путь к вашему экземпляру вики относительно корня веб-сервера. Например, если адрес вашего вики — http://www.yourserver.com:port/dokuwiki/, значение этого параметра следует установить равным /dokuwiki/. Обратите внимание на начальную и завершающую косую черту!

• Тип данных: строковой
• Значение по умолчанию: /

URL к серверу (включая имя протокола). Оставьте пустым для автоопределения.

Указанный здесь путь — это путь к корню web-сервера. Например, если адрес вашего вики — http://www.yourserver.com:port/dokuwiki/, значение этого параметра следует установить равным http://www.yourserver.com:port без косой черты в конце.

• Тип данных: строковой
• Значение по умолчанию:

Замечание: Порт необходимо указывать только в том случае, когда web-сервер настроен на прослушивание нестандартного порта. В противном случае номер порта можно опустить вместе с предшествующим ему двоеточием.

Этот параметр определяет права доступа, с которыми должны создаваться каталоги. Права задаются в восьмеричном виде с начальным нулём. По умолчанию каталоги создаются с правами 0755 (rwxr-xr-x в текстовом виде). Подробнее см. следующий раздел.

• Тип данных: числовой
• Значение по умолчанию: 0755

Для Windows-серверов данный параметр игнорируется.

Перед использованием обязательно прочтите страницы permissions и security.

Этот параметр определяет права доступа, с которыми должны создаваться файлы.

Этот параметр определяет права доступа, с которыми должны создаваться каталоги. Права задаются в восьмеричном виде с начальным нулём. По умолчанию каталоги создаются с правами 0644 (rw-r–r– в текстовом виде).

• Тип данных: числовой
• Значение по умолчанию: 0644

Для Windows-серверов данный параметр игнорируется.

Перед использованием обязательно прочтите страницы permissions и security.

The first non-zero digit (6 in the default above) determines the user permissions (ie. permissions of the file owner), second non-zero digit is the group permissions and the last digit is permissions for other (ie. everyone else). To convert permissions into the correct number, use the following key:

• Read=4
• Write=2
• Execute=1

and sum the result for each one of the above groups. Thus, if you want read and write permissions for the user owning the files, specify 4+2=6 as the first non-zero digit. If you would want read and execute permissions (appropriate eg. for directories) for the group that the file belongs to, specify 4+1=5 as the second non-zero digit. The default permission value above is interpreted as read and write permissions for the user and only read permissions (number 4) for the group and others.

Для того, чтобы упростить оказание поддержки пользователям, у которых возникают проблемы, DokuWiki при необходимости может выводить обширный список внутренних параметров. Самый простой способ воспользоваться этой возможностью — просто добавить &do=debug к URL страницы (при условии, что данный параметр включен). Например: http://hostname.domain/your-dokuwiki/doku.php?id=playground&do=debug. Данная возможность очень полезна для решения разнообразных проблем, возникающих при установке DokuWiki, однако, может с успехом применяться и когда DokuWiki уже установлен и работает (возможно, не вполне корректно).

Для обеспечения безопасности необходимо всегда выключать данную функцию, когда DokuWiki успешно установлен. (См. также страницу, посвящённую безопасности.)

• Тип данных: логический
• Значение по умолчанию: 0

Параметр определяет количество документов, показываемых на странице Недавние изменения, а также количество недавних документов и количество элементов списка документов в новостных лентах.

• Тип данных: числовой
• Значение по умолчанию: 20

Параметр определяет количество страниц, отображаемых в строке пройденного пути "Вы посетили". Установка значения 0 отключает отображение соответствующей строки.

• Тип данных: числовой
• Значение по умолчанию: 10

Параметр определяет альтернативный способ отображения вашего местонахождения в вики: в виде пути к просматриваемой странице в дереве пространств имён. Если вы используете эту возможность, возможно вы захотите отключить стандартную строку “Вы посетили”.

• Тип данных: логический
• Значение по умолчанию: 0

Параметр определяет, следует ли показывать полный путь к отображаемым страницам.

• Тип данных: boolean
• Значение по умолчанию: 0

Разрешить преобразование некоторых наборов символов в их типографские аналоги (длинное тире, кавычки и т. д.).

• Тип данных: логический
• Значение по умолчанию: 1

Параметр определяет формат отображения дат. Непосредственно передаётся PHP-функции date. Многие пользователи предпочитают видеть даты в формате d.m.Y H:i, а не в формате по умолчанию.

• Type : строковой
• Default : Y/m/d H:i

Параметр определяет, как должны выглядеть подписи зарегистрированных пользователей. Здесь вы можете использовать любые форматные последовательность, допускаемые PHP-функцией strftime, а также следующие специальные переменные:

• Тип данных: строковой
• Значение по умолчанию: --- //[[@MAIL@|@NAME@]] @DATE@//

Многие пользователи предпочитают более короткие подписи, например: --- //[[@MAIL@|@USER@]] %b%e//. Если ваш вики содержит личные странички пользователей, то вы возможно захотите включить ссылки эти странички в подпись. В этом случае формат подписи может выглядеть например так: --- //[[user:@USER@|@NAME@]] @DATE@//

Минимальный уровень заголовков, которые необходимо включать в автоматически генерируемое содержание.

• Тип данных: числовой (0-5)
• Значение по умолчанию: 1

Максимальное количество уровней заголовков, которые необходимо включать в автоматически генерируемое содержание.

• Тип данных: числовой (1-5)
• Значение по умолчанию: 3

Значение 0 отключает генерацию содержания.

Set this variable to the maximum number of heading levels deep to create as separate, editable, sections.

• Тип данных: числовой (0-5)
• Значение по умолчанию: 3

A value of 0 will disable the in-page section editing buttons.

Параметр определяет, используется ли CamelCase — способ автоматического создания ссылок на другие страницы Wiki. Если вы включите этот режим, а затем выключите его, это может привести к появлению страниц-сирот.

• Тип данных: логический
• Значение по умолчанию: 0

Когда этот параметр равен 1, акцентированные символы преобразуются в их ASCII-эквиваленты (ü превращается в ue) или просто теряют акценты (á превращается в a). Когда этот параметр равен 2, символы из нелатинских алфавитов заменяются наиболее близкими ASCII-эквивалентами (см. страницу romanization). Установка значения 0 отключает все эти возможности.

• Тип данных: числовой (0-2)
• Значение по умолчанию: 1

When this option is enabled, a link to a wiki page name will automatically use the first heading in the page for each of the following:

• The title of the page, as shown in the browser or in search engine results.
• The text for a link to the page, unless the link specification contains an explicit title.
• The title of RSS feed entries for the page

For more information, read Using the first heading as the page name.

• Тип данных: логический
• Значение по умолчанию: 0

Параметр определяет, следует ли выполнять проверку наличия ссылок на медиа-объект при его удалении.

• Тип данных: логический
• Значение по умолчанию: 1

How many references should be shown (5 is a good value).

• Тип данных: числовой
• Значение по умолчанию: 5

Параметр определяет, следует ли использовать Списки прав доступа (ACL) для ограничения прав пользователей. Если этот параметр выключен, любые пользователи могут выполнять любые операции с вики.

• Тип данных: логический
• Значение по умолчанию: 0

DokuWiki supports two methods of password handling after a new user has been registered. The setting of this configuration variable determines which method is used:

1. automatically generated passwords (1)
   The user specifies his email address and DokuWiki generates a password and sends it to him. To use this method, set autopasswd to 1. (You can configure the “From” email address used for all mails sent through DokuWiki via the mailfrom setting.)
2. user defined passwords (0)
   The registration form contains two fields where the new user can type in his desired password. No email is sent. To use this method set, autopasswd to 0.

• Тип данных: логический
• Значение по умолчанию: 1

This specifies which backend should be used to authenticate against.

DokuWiki supports several authentication backends. For full list see DokuWiki Manual, Chapter Authentication Methods.

• Тип данных: строковой
• Значение по умолчанию: plain

Passwords should always be saved as an encrypted hash. DokuWiki supports multiple hash methods, which one it should use is defined by this option. What you choose here depends on your security needs and if you want to use an existing authentication database. DokuWiki is able to determine which method was used from an encrypted password, so you can always change the used method as long as your authentication backend supports this.

When using salted hashing, a random salt is generated when the user is initially assigned a password, and each time the user changes their password. The salt is stored with the password. Whether DokuWiki is able to apply a salt depends on the authentication backend used.

The following hash methods are available:

• Тип данных: строковой
• Значение по умолчанию: smd5

If a user signs up (using openregister) he will automatically be added to this group.

• Type : строковой
• Значение по умолчанию: user

Specifies who has superuser rights in DokuWiki. Superusers always have all permissions regardless of ACL restrictions and are allowed to edit ACL restrictions (think root).

You can set either a username or the name of a group by prepending an @ char to the groupname.

• Тип данных: строковой
• Значение по умолчанию: !!not set!!

Note: in the current release you need to encode most special chars in the user or groupname using the following table:

Doesn't seem to be the case anymore. Example: @wiki%5fwrite got re-encoded to @wiki%255fwrite.

Example: If the username is admin@foo.bar then you need to set the option to admin%40foo%2ebar. Do not encode the starting @ for groups.

Disable some ''?do=something'' commands

• Тип данных: string
• Значение по умолчанию: ""

For example, if you are using some indexmenu plugin, you can disable default index of all pages by setting $conf['disableactions']=“index”;

For a list of all actions, use the Configuration Manager plugin.

Specifies who has manager rights in DokuWiki. Managers gain access to the a limited selection of items on the admin menu. e.g. the Revert Manager.

You can set either a username or the name of a group by prepending an @ char to the groupname.

• Тип данных: строковой
• Значение по умолчанию: !!not set!!

Require a user to confirm their current password when updating their Dokuwiki user profile.

• Тип данных: логический
• Значение по умолчанию: 1

When enabled, namespaces for which a user has no read permissions will not be shown in the namespace index. This may break the index view when deeper namespaces have higher permissions than the ones above (which is usually the case). Not recommended except for paranoid people .

• Тип данных: логический
• Значение по умолчанию: 0

Enables the use of a blacklist against WikiSpam.

• Тип данных: логический
• Значение по умолчанию: 1

Use rel=“nofollow” for external links like this .
More info on nofollow here and a different perspective here.

• Тип данных: логический
• Значение по умолчанию: 1

When creating/modifying a page allow search engines to index it after this time (in seconds). This works by adding in the output if the specified time hasn't elapsed.

• Тип данных: числовой
• Значение по умолчанию: 60*60*24*5 (i.e. five days)

This configures if and how email addresses will be obfuscated against harvesting bots. Possible options are:

• visible – replaces @ with [at], . with [dot] and - with [dash]
• hex – uses hex entities to encode the address
• none – no obfuscating is used

• Тип данных: строковой
• Значение по умолчанию: hex

This option protects your wiki against uploading HTML through the media manager even when hidden in other non-HTML files. This is a counter measure against a bug in Microsoft Internet Explorer.

• Тип данных: логический
• Значение по умолчанию: 1

Enable auto draft saving.

• Тип данных: логический
• Значение по умолчанию: 1

Defines if embedding HTML using the tags is allowed. This may break the layout and XHTML compliance if wrong HTML is inserted. This is a security problem when used on a freely accessible site!

• Тип данных: логический
• Значение по умолчанию: 0

Defines if embedding PHP using the tags is allowed. This is a huge security problem when used on a freely accessible site!

• Тип данных: логический
• Значение по умолчанию: 0

This option may contain an email address to which notifications about page adds and changes will be sent. No mails are sent when this is a blank string. To add more than one email address, use the comma to separate the entries (','). (You can configure the “From” email address used for all mails sent through DokuWiki via the mailfrom setting.)

• Тип данных: строковой
• Значение по умолчанию:

When set to an email address, notification mails will be sent to this address whenever a new user registers at the wiki.

• Тип данных: строковой
• Значение по умолчанию:

Enables email notifications of changes to a specific page (similar to the notify option). If this option is enabled there will be an additional “Subscribe Changes” button for logged in users. (You can configure the “From” email address used for all mails sent through DokuWiki via the mailfrom setting.)

• Тип данных: логический
• Значение по умолчанию: 1

Defines the maximum age for lockfiles in seconds. See locking.

• Тип данных: числовой
• Значение по умолчанию: 15*60 (15 Minutes)

Configures the maximum age of a cached paged in seconds. See caching.

• Тип данных: числовой
• Значение по умолчанию: 60*60*24 (one day)

This configures the HTML TARGET value used for different link types. The target value tells the web browser where to open the requested link. If a target is empty, then the link will open in the same window.

• Тип данных: массив
• Значение по умолчанию: All links are opened in the same browser window

Possible keys for this array are :

• wiki
• interwiki for interwiki links
• extern
• media for uploaded files.
• windows for windows shares.

Possible values for the target attribute :

• _blank : open the link in a new window.
• _self or empty string : open the link in the same window.
• Other values such as _parent or _top or framename assume you are using a template with frames, in that situation, you should know what to put in this array.

For resizing images DokuWiki uses PHP's libGD if available. DokuWiki tries to detect the availability and version of libGD automatically. However, in older PHP versions, this does not work. You can force a version by setting this variable. Possible values are: '0' for no libGD support; '1' for libGD version 1.x; and '2' for libGD 2 with autodetect.

• Тип данных: числовой
• Значение по умолчанию: 2

By default DokuWiki uses PHP's libGD (see above) however ImageMagick's convert is more powerful but not always available. If it is installed on your server you can give its path here and DokuWiki will use it instead of libGD.

• Тип данных: строковой
• Значение по умолчанию:

This sets the compression quality of jpg's created when resizing images. Low values create smaller files, but can introduce jpg artifacts. The range is from 0 to 100.

• Тип данных: числовой
• Значение по умолчанию: 90

Maximum size (bytes) fetch.php may download from extern. This is used to cache external images and resize them if needed. To disable this functionality completely just set this option to 0. (Setting this to 0 is suggested in the security page.)

• Тип данных: числовой
• Значение по умолчанию: 0

Check for new release messages. See update check.

• Тип данных: логический
• Значение по умолчанию: 1

Enable this to use rewriting for nicer URLs. Either using the Apache mod_rewrite module or by letting DokuWiki rewrite the URLs itself-

• Тип данных: числовой
• Значение по умолчанию: 0

You can set the following values:

For detailed config options please refer to rewrite.

If you enabled the rewrite option above, you can use this option to use a slash instead of a colon as namespace separator in URLs.

• Тип данных: логический
• Значение по умолчанию: 0

This variable determines the character that separates words in a page ID and that replaces characters not valid in a page ID.

The page ID is the component of the URL that specifies the page. For example, by default the link doesn't exist goes to the URL www.dokuwiki.org/wiki:doesn_t_exist. wiki:doesn_t_exist is the page ID. The default sepchar is '_', so the apostrophe and the space each appear as an '_' in the link.

By changing sepchar to another character, you can change the '_' to another character. The valid sepchar characters are those that are valid in a page ID: letters, digits, underscore (_), dash (-), and dot (.). The sepchar variable must contain exactly one character.

Be careful with this variable. By changing it you can make pages created under a previous sepchar inaccessible. When you create a new page, the page ID becomes the file name for the page. If you create pages with sepchar '_' and then later use sepchar '-', your links to those previously created pages will break because the links will change but the file names won't.

• Тип данных: Character (letter, digit, '_', '-', or '.')
• Значение по умолчанию: _

When this is enabled, all links are created as absolute URLs in the form http://server/path. This was the default in previous releases. URLs relative to the Serverroot are now prefered.

• Тип данных: логический
• Значение по умолчанию: 0

This option is probably only useful in English Wikis. If set to 1, plural forms of linked pages are tried automatically when the singular form is not found (and the other way round). So pagenames and pagename would then both link automatically to the same existing page.

• Тип данных: логический
• Значение по умолчанию: 0

This address will be used as sender address for all mails which are sent through DokuWiki. Make sure your Mailserver accepts the address you supply here. If you leave this empty the default PHP address will be used (usually webserveruser@webserverhostname)

• Тип данных: строковой
• Значение по умолчанию:

Enables simple whitespace and comment stripping in CSS and JavaScript files. Don't confuse with the compression option - to avoid this confusion it is sometimes called compaction instead.

• Тип данных: логический
• Значение по умолчанию: 0

Pages are compressed when sending them over the network to browsers that can handle gzip or deflate content encoding. Disable this setting if compression is applied later by an external tool (such as Apache's mod_gzip).

• Тип данных: логический
• Значение по умолчанию: 0

This option accepts a Regular Expression to filter certain pages from all automatic listings (RSS, recent changes, search results, index). This is useful to exclude certain pages like the ones used in the sidebar templates. The regexp is matched against the full page ID with a leading colon. If it matches, the page is assumed to be a hidden one. This is a rather cosmetical option not a security one!

• Тип данных: строковой
• Значение по умолчанию:

When someone follows a link to a page not existing yet, DokuWiki will send a usual 200 HTTP response. In a wiki this is a wanted behaviour, however if DokuWiki is used as a CMS system one might prefer to have DokuWiki answering with a 404 “not found” response. Enabling this option will cause this behaviour. Note: this will not change what content will be sent, only the HTTP status changes.

• Тип данных: логический
• Значение по умолчанию: false

Determines how old page versions (attic) will be stored. The default gz uses gzip compression, setting it to bz2 will use bzip2 compression. Set to 0 to disable. Don't confuse with the compress option.

• Тип данных: строковой
• Значение по умолчанию: gz

Note that if you change the compression method after revisions have been created, old revisions will be inaccessible via the “Old revisions” button. To fix this, re-compress old revisions using the newly selected method, or decompress the old revisions, as appropriate.

DokuWiki can automatically generate a XML sitemap suitable for the submission to the Google search engine. The option expects a number of days configuring how often the sitemap should be recreated. The default is not to create a sitemap. See sitemap for more info.

• Тип данных: number
• Значение по умолчанию: 0

This option works around a problem on certain platform where ignore_user_abort function is broken. In fact only IIS with PHP running as CGI is known to be broken.

• Тип данных: boolean
• Значение по умолчанию: 0

Параметр определяет тип новостных лент. См. также страницу Ленты новостей.

• Тип данных: строковой
• Значение по умолчанию: 'rss1'
• Options
  • 'rss' - RSS 0.91
  • 'rss1' - RSS 1.0
  • 'rss2' - RSS 2.0
  • 'atom' - Atom 0.3
  • 'atom1' - Atom 1.0

Sets the default link target for the created XML feed. See syndication.

• Тип данных: строковой
• Значение по умолчанию: 'diff'
• Options
  • 'diff' - page showing revision differences
  • 'page' - the page as of the revision
  • 'rev' - page showing all revisions of that page
  • 'current' - most recent revision of page (which may show a more recent revision than 'page')

How often to update the RSS feed in seconds. Between updates the cached version of the RSS feed is used. An update interval of hour(s) will be sufficient for a slowly changing wiki. See syndication also.

• Тип данных: числовой
• Значение по умолчанию: 60*5 (5 minutes)

Should the edit summary be added to the feed item titles? If you use DokuWiki for bloging or as CMS you probably want to disable this option.

• Тип данных: логический
• Значение по умолчанию: 1

Количество дней, в течение которых изменённые документы показываются в глобальном списке недавних изменений.

• Тип данных: integer
• Значение по умолчанию: 7

Параметр используется для конфигурирования прокси для исходящих соединений. Более подробная информация находится на странице Прокси-сервер.

• Тип данных: массив
• Значение по умолчанию: no proxy is used

Включение режима safemodehack — см. соответствующую страницу.

• Тип данных: логический
• Значение по умолчанию: 0

Параметры FTP для режима safemodehack — см. соответствующую страницу.

• Тип данных: массив
• Значение по умолчанию: not used