Konfigurace DokuWiki

https://www.dokuwiki.org/config

DokuWiki lze přizpůsobit potřebám pomocí „systémových“ voleb, konfiguračních souborů pro doladění chování, úprav stylu šablony a povolování/zakazování rozšíření.

Co lze konfigurovat

„Systémové“ volby DokuWiki se nastavují ve Správci konfigurace. Pro spuštění je potřeba být přihlášen jako superuživatel a v adminu kliknout na tlačítko Admin. „Výchozí“ hodnoty systému jsou načítány ze souboru conf/dokuwiki.php. Pro úpravy je měňte ve Správci konfigurace, který je uloží do conf/local.php. Případně lze tento soubor upravit ručně (nebo vytvořit, pokud neexistuje). Seznam toho, co lze v něm nastavit, viz níže v sekci available options.

Uživatelská jména, (šifrovaná) hesla a pravidla přístupu se ukládají v souborech users.auth.php a acl.auth.php v adresáři conf/. Tyto soubory lze upravovat přes Správce uživatelů a Správu přístupových práv.

Při nahrávání souboru v media manageru se může objevit hláška „Upload denied. This file extension is forbidden!“. Toto chování se řídí v conf/mime.conf. Chcete‑li povolit nový typ souboru, uveďte jej v mime.local.conf.

Při editaci stránek probíhají automatické záměny (nápovědy ke zkratkám, smajlíci, speciální znaky). Řídí je acronyms.conf, smileys.conf a entities.conf.

Konfigurační soubory

Konfigurační soubory jsou v conf/ instalace (nebo /etc/dokuwiki při instalaci z balíčku Debianu).

„Hlavní soubory“ se dodávají s DokuWiki, „lokální soubory“ vytváří správce wiki. Pokud jsou podporovány lokální soubory, používejte je místo úprav hlavních souborů, aby se předešlo problémům při upgrade.

Alternativou k ruční editaci *.conf je použití Správce konfiguračních souborů.

hlavní soubor	lokální soubor	typ konfigurace	stručné info
`dokuwiki.php`	`local.php` `local.protected.php`	viz níže	obecná konfigurace wiki
`acronyms.conf`	`acronyms.local.conf`	abbreviations	automatické nápovědy ke zkratkám
`entities.conf`	`entities.local.conf`	entities	automatické textové záměny
`interwiki.conf`	`interwiki.local.conf`	interwiki	interwiki zkratkové odkazy
`mime.conf`	`mime.local.conf`	Konfigurace MIME	MIME typy pro uploady
`smileys.conf`	`smileys.local.conf`	Smajlíky	obrazové záměny
	`acl.auth.php`	viz Seznamy přístupových práv (ACL)	nastavení přístupů
	`users.auth.php`	viz Seznamy přístupových práv (ACL)	uživatelé a hesla
`license.php`	`license.local.php`	config:license	seznam dostupných licencí
`scheme.conf`	`scheme.local.conf`	urlschemes	URL schémata rozpoznávaná jako odkazy
`mediameta.php`	`mediameta.local.php`	EXIF a IPTC metadata	editovatelná metadata obrázků
`wordblock.conf`	`wordblock.local.conf`	Zařazení na černou listinu	spamový blacklist
`plugins.required.php`	`plugins.local.php` `plugins.protected.php`	viz níže	povolení/zakázání pluginů
`manifest.json`	`manifest.local.json`	devel:manifest	PWA manifest
`lib/tpl/<tpl>/style.ini`	`conf/tpl/<tpl>/style.ini`	devel:style.ini	styly a proměnné šablony
	`userscript.js`	devel:javascript	vlastní JavaScript
	`userstyle.css`	devel:css	vlastní CSS

Konfigurační soubory šablony

Konfigurační soubor devel:style.ini pro změny vzhledu je v /lib/tpl/dokuwiki (pro výchozí šablonu). style.ini je textový soubor načítaný šablonou, kde lze nastavovat např. barvu pozadí. Plugin Styling umožní přes Admin rozhraní náhled a změnu vzhledu libovolné šablony a ukládá do conf/tpl/<tpl>/style.ini.

Povolení/zakázání pluginů

Nainstalované pluginy jsou ve výchozím stavu povoleny. Zakázat je lze ve Správci rozšíření, který zapisuje do plugins.local.php. Vybrané pluginy lze „ochránit“ v conf/plugins.protected.php.

Výchozí pořadí načítání konfiguračních souborů pluginů:

conf/plugins.php - výchozí pluginy
conf/plugins.local.php - změny ze Správce rozšíření
conf/plugins.required.php - jádrové pluginy mimo kontrolu Správce rozšíření
conf/plugins.protected.php - přepisuje nastavení z ostatních souborů

Pořadí načítání řídí globální proměnná $config_cascade. Chování lze změnit přes preload.php.

Konfigurační volby

Většinu funkcí DokuWiki lze nastavit různými volbami. Nejjednodušší je úprava přes Správce konfigurace.

Dostupná nastavení jsou níže. Jejich výchozí hodnoty jsou v conf/dokuwiki.php. Úpravy provádějte v conf/local.php, aby je pozdější upgrade nepřepsal. Config Manager tento soubor také používá. conf/local.protected.php je pro volby, které nelze měnit ve Správci konfigurace.

Ukázka conf/local.php:

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

Poznámky: Jde o PHP soubor, je nutné dodržet syntaxi (např. ukončovací středníky). Typy proměnných:

Number (Čísla): např. 9
String (Řetězce): musí být uzavřeny v jednoduchých nebo dvojitých uvozovkách., např. 'foo bar'
Boolean (Boolean): 1 nebo 0
Array (Pole): více hodnot předchozích typů

Dostupné volby

Základní nastavení
- title
- start
- lang
- template
- tagline
- sidebar
- license
- savedir
- basedir
- baseurl
- cookiedir
- dmode
- fmode
- allowdebug
Zobrazení
- recent
- recent_days
- breadcrumbs
- youarehere
- fullpath
- typography
- dformat
- signature
- showuseras
- toptoclevel
- tocminheads
- maxtoclevel
- maxseclevel
- camelcase
- deaccent
- useheading
- sneaky_index
- hidepages
Autentizace
Ochrana proti spamu
Úpravy
- usedraft
- ~~htmlok~~ (removed since release 2023 Jack Jackrum)
- ~~phpok~~ (removed since release 2023 Jack Jackrum)
- locktime
- cachetime
Odkazy
- target (wiki, interwiki, extern, media, windows)
Média
Oznámení
- subscribers
- subscribe_time
- notify
- registernotify
- mailfrom
- mailreturnpath
- mailprefix
- htmlmail
- dontlog
- logretain
Syndikace (RSS)
Pokročilé volby
- updatecheck
- userewrite
- useslash
- sepchar
- canonical
- fnencode
- autoplural
- compress
- cssdatauri
- gzip_output
- send404
- compression
- broken_iua
- xsendfile
- renderer_xhtml
- readdircache
- search_nslimit
- search_fragment
Síť
- dnslookups
- jquerycdn
- trustedproxy
- trustedproxies
- realip
- proxy (host, port, user, pass, ssl, except)
- ~~safemodehack~~ (removed since release 2020 Hogfather)
- ~~ftp (host, port, user, pass, root)~~ (removed since release 2020 Hogfather)
Příznaky funkcí
- defer_js