Příručka:LocalSettings.php

This page is a translated version of the page Manual:LocalSettings.php and the translation is 100% complete.

Varování: Neupravujte LocalSettings.php pomocí editorů dokumentů, jako je Notepad na Windows 10 verze 1809 nebo dříve, TextEdit nebo jiných textových editorů, které do souborů přidávají značky pořadí bajtů. Ty narušují běh PHP vaší wiki. Místo toho použijte editor kódu, např. Vim nebo Notepad++. Tyto správně zpracovávají kódování souborů. Lze je také použít k opravě souborů dříve poškozených editory dokumentů.

Soubor MediaWiki: LocalSettings.php
Lokalita:	/
Zdrojový kód:	není udržován v Gitu (vytvořené během instalace)
Třídy:

Soubor LocalSettings.php poskytuje základní konfigurační nastavení instalace MediaWiki. Určitě si udělejte čas na kontrolu nastavení v tomto souboru. Soubor je obvykle generován webovým instalátorem MediaWiki, ale můžete si vyladit parametry, případně ve shodě s nastavením Apache. U instalací MediaWiki nakonfigurovaných jako wiki farma lze použít soubor s názvem CommonSettings.php .

Umístění na serveru

Soubor LocalSettings.php není wiki stránka a nemůžete k němu přistupovat pomocí webového prohlížeče. Místo toho je to soubor v systému souborů serveru. Jeho obsah je generován během počátečního nastavení wiki a výsledný soubor je nutné zkopírovat na server ručně. Soubor musí být umístěn ve složce, do které jste nainstalovali MediaWiki, na stejné úrovni se složkami jako includes/ a skins/ a soubory jako api.php. Pokud tam tento soubor není, wiki nebude fungovat vůbec – pokud wiki funguje, soubor tam je. Pokud nevíte, kde se nachází, můžete jej vyhledat zadáním příkazu jako find / -iname LocalSettings.php -print v okně terminálu.

(Pokud používáte Vagrant, podívejte se také na MediaWiki-Vagrant#MediaWiki_settings.)

Zabezpečení

LocalSettings.php obvykle obsahuje citlivá data, například přihlašování do databáze. Tato data by neměla být nikdy odhalena veřejnosti! Kvůli narušení bezpečnosti někde na serveru se může stát, že ostatní uživatelé budou moci prohlížet obsah souborů. Chcete-li zlepšit zabezpečení vašich dat, měli byste odpovídajícím způsobem pro tento soubor nastavit oprávnění UNIX: Uživatel webového serveru musí mít přístup k tomuto souboru. Pokud se jedná o stejný účet, který je vlastníkem souboru, můžete nastavit oprávnění na 600. Někdy uživatel webového serveru není vlastníkem souboru, ale je ve vlastníkově skupině uživatelů UNIX. V tomto případě by měla být v pořádku oprávnění 640. Pro lepší zabezpečení byste měli oprávnění co nejvíce omezit.

Kromě toho můžete vytvořit uživatele MySQL, který je omezen pouze na databázi používanou wiki, a zadat pověření tohoto uživatele v LocalSettings.php. Databázový server můžete také nakonfigurovat tak, aby akceptoval pouze připojení z localhost - v případě úniku pověření by to mělo zabránit přístupu zvenčí.

Viz také Manual:Securing database passwords pro metodu přesunutí citlivých částí LocalSettings.php do jiného souboru v jiném adresáři.

Obsah souboru

Pokud upravujete LocalSettings.php, nezapomeňte jej znovu uložit do správného kódování. Měli byste použít kódování "ANSI jako UTF-8" - to je kódování UTF-8 bez značky pořadí bajtů (BOM).

LocalSettings.php obsahuje PHP kód. Hlavně definice proměnných a jejich hodnot. Změna nastavení obvykle znamená změnu hodnoty proměnné PHP. Změny se projeví okamžitě po opětovném uložení souboru na server. Není třeba nic ručně restartovat. V některých případech však možná budete muset vymazat mezipaměť prohlížeče, abyste viděli skutečně provedené změny.

Výchozí hodnoty mnoha dalších nastavení jsou nastaveny v includes/DefaultSettings.php, které by nemělo být upravovánoǃ Pokud proměnná, kterou chcete změnit, již není ve vašem LocalSettings.php, zkopírujte příslušný řádek z DefaultSettings.php a odpovídajícím způsobem jej upravte v LocalSettings.php. Do LocalSettings.php můžete přidat nové řádky na konec.

V souboru může být také několik řádků, například 'require_once "$IP/extensions/extension.php";', které ukazují na rozšíření. Tyto řádky umožňují odpovídající rozšíření na wiki. Tato rozšíření mohou vyžadovat nastavení hodnot více proměnných v LocalSettings.php. Zkontrolujte další pokyny v dokumentaci příslušného rozšíření.

Stejně jako většina souborů PHP v MediaWiki nekončí LocalSettings.php koncovým kódem PHP ?>. Tím se zabrání tomu, aby administrátoři náhodně přidali nové informace za tuto značku. PHP funguje dobře bez uzavírací značky.

Pokud máte wiki na farmě wiki MediaWiki, možná nemáte přístup pro zápis (snad ani přístup pro čtení) do souboru LocalSettings.php (viz např. [1]). Společnost wiki může, ale nemusí být ochotna provést požadované změny. Možná chce zachovat většinu nastavení na všech wikinách na wiki farmě.

Tento soubor není z bezpečnostních důvodů automaticky zapsán na váš webový server. Místo toho je nabízen jako soubor ke stažení, který musíte poté nahrát na server, aby vaše wiki mohla začít fungovat. Podrobnější vysvětlení viz najdete zde.

Přehled nastavitelných parametrů

Viz index nastavení konfigurace a komentáře obsažené v souborech nastavení, kde najdete nápovědu k tomu, co všechny proměnné dělají. Níže je uveden krátký seznam nejdůležitějších proměnných a nejžádanějších funkcí.

Standardní nastavení

Instalace cesty

Proměnná $IP (instalační cesta) obsahuje lokální cestu k souboru k základní instalaci vaší wiki. Protože MediaWiki od verze 1.18 nastavuje $IP automaticky, ruční nastavení $IP v LocalSettings.php již není potřeba. $IP bude výchozím nastavením aktuálního pracovního adresáře a lze jej použít, aniž byste jej museli ručně definovat. Pokus o nastavení $IP (nebo MW_INSTALL_PATH) v LocalSettings.php může vést k neočekávaným výsledkům.

Soubor DefaultSettings.php se načte z adresáře určeného proměnnou IP.

Název webu

$wgSitename obsahuje název vašeho nastavení wiki. Toto jméno je zahrnuto mnohokrát v celém systému, například prostřednictvím MediaWiki:Pagetitle. Například toto nastavení používá tagline Wikipedie "Z Wikipedie, bezplatné encyklopedie".

Odmítnutí názvu webu

Některé překlady rozhraní jsou připraveny ke skloňování názvu webu. Správné formy slova můžete nastavit v proměnných $wgGrammarForms (například viz stránka dokumentace $wgSitename ).

Výchozí jazyk

$wgLanguageCode řídí jazyk rozhraní vaší wiki. Zatímco uživatelé mohou přepínat jazyk, který vidí v preferencích, tato proměnná nastavuje výchozí jazyk, který vidí všichni anonymní uživatelé a většina registrovaných uživatelů.

Cesta ke skriptům

$wgScriptPath je předpona cesty URL pro přístup k hlavnímu skriptu MediaWiki, který je klíčovým kódem MediaWiki. Toto nastavení by mělo odpovídat nastavení Apache, zejména pokud používáte přepis pravidel Apache.

Jméno serveru

$wgServer obsahuje základní URL serveru, včetně protokolu, ale bez koncového lomítka a bez podadresáře, pokud existuje. Když je wiki přístupná buď z localhost, kde běží, z intranetu nebo z internetu, e-mailová oznámení a několik dalších vypočtených zpráv by byly obvykle doručovány s různými URL.

Od MediaWiki verze 1.34 musí být $wgServer nastaveno na LocalSettings.php. Předtím se MediaWiki pokusila autodetekovat název serveru a $wgServer byl volitelný, aby přepsal autodetekci.

Pokud je www.example.com serverovou adresou vaší wiki, jak je vidět z internetu, přidejte řádek, například

$wgServer = 'http://www.example.com';

Na wiki stránkách lze použít proměnnou magické slovo {{SERVER}}. Rovná se hodnotě $wgServer. Na wiki, jako například z rodiny WikiMedia, kde se používají relativní adresy URL, se nebude plně rozšiřovat. Například na //www.mediawiki.org, na který nelze kliknout ani zkopírovat do adresního řádku.

Můžete také použít adresu URL relativní k protokolu, jak je uvedeno níže. Při použití adresy URL relativní k protokolu nezapomeňte nastavit $wgCanonicalServer. $wgCanonicalServer je potřeba pro některá místa v kódu, kde je potřeba původ s protokolem a názvem hostitele.

$wgServer = '//www.example.com';
$wgCanonicalServer = 'https://www.example.com';

Jméno skriptu

$wgScript je název hlavního (indexového) skriptu MediaWiki PHP, ve výchozím nastavení s názvem index.php. Změna názvu skriptu pravděpodobně není dobrý nápad. Pokud však cítíte nutkání tak učinit, je to místo, kde můžete provést změny. Ujistěte se, že víte, co děláte.

Cesta ke článkům

$wgArticlePath je cesta, kterou je třeba použít při přístupu na stránku v MediaWiki. Cesta by měla obsahovat cestu k hlavnímu skriptu (obvykle s použitím $wgScript). Pro název článku použijte zástupný symbol $1.

Pokud používáte pravidla pro přepisování Apache k vytvoření hezkých a krátkých adres URL, pravděpodobně budete muset upravit $wgArticlePath, abyste se dostali na správnou cestu. Všimněte si, že wgArticlePath se používá k vytváření adres URL z MediaWiki. Pokud zde uděláte chybu, interní odkazy se zobrazí nesprávně, zatímco stále budete mít přístup na hlavní stránku zadáním správné adresy URL ručně. Viz Manual:Short URL pro více informací o konfiguraci URL.

Typické hodnoty jsou:

`"$wgScript/$1"`	předá název článku s oddělovačem "/"
`"$wgScript?title=$1"`	předá název článku jako parametr (starý styl)
`"/mypath/$1"`	vlastní cesta. Pomocí pravidel přepsání Apache převede "mypath" na správnou cestu, která přistupuje k hlavnímu skriptu

Umístění souboru s nastavením stylu

$wgStylePath použijte k nastavení cesty URL k místu, kde jsou umístěny šablony stylů (CSS) pro instalaci MediaWiki. $wgStyleDirectory by měl směřovat na stejné místo, ale mějte na paměti, že se jedná o cestu lokálního systému souborů pro použití v interních skriptech, které přistupují k systému souborů.

Adresář pro nahrané soubory

Adresář pro upload je místo, kde jsou uloženy soubory nahrané uživateli. $wgUploadPath určuje cestu URL, $wgUploadDirectory odkazuje na cestu k místnímu systému souborů.

Logo

$wgLogo určuje, jaké grafické logo se zobrazí v levém horním rohu všech stránek MediaWiki. Tyto kroky nahradí výchozí logo v adresáři /wiki/skins/common/images/ a nahradí /wiki cestou k adresáři, do kterého jste nainstalovali software MediaWiki.

Nejprve zkopírujte libovolné logo do adresáře /wiki/skins/common/images/ - (nahrazení /wiki cestou k adresáři, do kterého jste nainstalovali software MediaWiki).

Dále zkuste najít řádek v LocalSettings.php, který vypadá takto:

$wgLogo = "$wgStylePath/common/images/wiki.png";

Pokud žádný takový řádek neexistuje, můžete jej na konci souboru zkopírovat a vložit.

Poté tento řádek upravte tak, aby ukazoval na vaše logo. Logo musí být přístupné na webu. Hodnota této proměnné je předána do webového prohlížeče, který ji používá k načtení loga. Pokud máte pochybnosti, dobrým způsobem, jak si vybrat, co zde vložit, je přejít na logo ve webovém prohlížeči (například tato wiki adresa URL loga je http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png) a jako hodnotu této proměnné zadejte úplnou adresu URL.

Někteří lidé prostě nahradí soubor skiny/common/images/wiki.png svým logem. To se nedoporučuje, protože přizpůsobené logo by se při aktualizaci přepisovalo.

MediaWiki 1.35 představila $wgLogos , která umožňuje více verzí stejného loga. Níže je uveden příklad použití více log.

$wgLogos = [
	'1x' => "$wgStylePath/common/images/1x_version.png",
	'1.5x' => "$wgStylePath/common/1.5x_version.png",
	...
	'tagline' => [
		'src' => "$wgStylePath/common/tagline_version.png",
		'width' => 135,
		'height' => 15,
	],
];

Kontaktní informace

$wgEmergencyContact je e-mailová adresa uživatele, který se má kontaktovat, pokud se něco pokazí. Tato e-mailová adresa se používá k odesílání interních hlášení chyb. Jako administrátor zde uveďte svou e-mailovou adresu.

$wgPasswordSender je e-mailová adresa, odkud bude uživatelům, kteří zapomněli svá hesla odesílán e-mail. Vyberte adresu, na kterou mohou lidé odpovědět při potížích nebo zmatcích.

Nastavení databáze

MediaWiki potřebuje přístup k databázi (v současné době buď MySQL nebo PostgreSQL) k ukládání stránek, úprav, informací o uživateli a mnoha dalších věcí.

$wgDBserver obsahuje jméno hostitele, na kterém je databáze hostována. Ve většině případů to bude jen "localhost", protože databáze je spuštěna ve stejném systému. V případě distribuovaných instalací musíte vyplnit plně kvalifikovaný název domény počítače, na kterém je databáze spuštěna.

$wgDBname je název databáze, kterou má použít MediaWiki. Jedna instalace MySQL nebo PostgreSQL může uložit více než jednu databázi a můžete dokonce spouštět více instalací MediaWiki na jednom serveru. Ujistěte se, že jste zde uvedli správný název databáze. Použijte různé názvy databází pro různé instalace wiki na stejném databázovém serveru.

$wgDBuser a $wgDBpassword obsahují přihlašovací jméno a heslo, které má MediaWiki použít pro přístup k databázi. Ujistěte se, že určený uživatel má správná přístupová práva, aby mohl manipulovat s tabulkou wiki na databázovém serveru.

Viz také Manual:Securing database passwords , kde je uveden způsob přesunutí citlivých částí LocalSettings.php do jiného souboru v jiném adresáři.

Uživatelská práva

$wgGroupPermissions je asociativní pole, které řídí oprávnění k vytváření a úpravám stránek pro různé skupiny uživatelů. V tomto poli lze vytvořit vlastní úrovně oprávnění a nastavit úrovně oprávnění pro různé skupiny uživatelů. Další informace o různých dostupných oprávněních a skupinách uživatelů najdete na Help:User rights .

Vynucení velkých písmen v odkazech

Ve výchozím nastavení nemůže název stránky začínat malými písmeny latinské abecedy. Při pokusu o změnu prvního písmene se převede na velká písmena. Pokud je cíl odkazu, zahrnutá stránka, obrázek nebo kategorie zadán s názvem začínajícím malým písmenem, skutečným cílem atd. začíná název stránky odpovídajícím velkým písmenem.

Alternativně mohou názvy stránek začínat malým písmenem, kromě možností začínat velkým písmenem, číslicí atd. K tomu musíte upravit $wgCapitalLinks . Pokud je nastavena na false, povoluje malá písmena, true vybírá výchozí chování.

Zapnutí podstránek

V LocalSettings.php jsou podstránky povoleny na základě jmenného prostoru pomocí $wgNamespacesWithSubpages . Chcete-li například povolit podstránky v hlavním jmenném prostoru:

$wgNamespacesWithSubpages[NS_MAIN] = 1;

Nahrávání obrázků

Než budou uživatelé moci nahrávat soubory do systému MediaWiki, musíte tuto funkci povolit. Ujistěte se, že adresář pro nahrávání je správně nakonfigurován a zapisovatelný procesem webového serveru Apache. Poté, abyste umožnili nahrávání ve webovém uživatelském rozhraní nastavte $wgEnableUploads na true.

tj. zde je příklad kódu z adresy includes/DefaultSettings.php, do kterého je možné vložit LocalSettings.php:

$wgUploadPath       = "$wgScriptPath/uploads";      ## Wiki 1.5 defaults to /images, but allows more than just images
$wgUploadDirectory  = "$IP/uploads";                ## Wiki 1.5 defaults to /images, but allows more than just images

## To enable image uploads, make sure the above '$wgUploadPath' directory is writable by Apache User or group.
## ''(i.e.  chmod og+w uploads images)''  then the following should be true:
$wgEnableUploads       = true;

$wgUseImageMagick      = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

## If you want to use image uploads under safe mode, create the directories images/archive, images/thumb and
## images/temp, and make them all writable. Then uncomment this, if it's not already uncommented:
$wgHashedUploadDirectory = false;

Pokud chcete mít možnost nepřetržitě měnit velikost obrázků, aby podporovaly miniatury, vyžaduje MediaWiki funkční ImageMagick instalaci. Po instalaci a testování ImageMagick ve vašem systému nastavte $wgUseImageMagick na true. Ujistěte se, že $wgImageMagickConvertCommand ukazuje na správné umístění příkazu convert vaší instalace, zda je příkaz spustitelný procesem webového serveru a zda je $wgMaxShellMemory dostatečně velký. Podrobné informace a řešení problémů najdete na stránce Příručka:Správa obrázků#Náhledy obrázků .

Můžete také chtít upravit seznam přijatých rozšíření, která je uložena v $wgFileExtensions :

$wgFileExtensions = [ 'png', 'jpg', 'jpeg', 'ogg', 'doc', 'xls', 'ppt', 'mp3', 'sxc', 'pdf' ];

V případě, že ImageMagick zobrazí chybovou zprávu podobnou následující:

Fatal error: mime_magic could not be initialized, magic file is not available in includes/MimeMagic.php on line 506 (Závažná chyba: mime_magic nelze inicializovat, magický soubor není dostupný v include/MimeMagic.php na řádku 506)

zkuste přidat následující řádek do LocalSettings.php:

$wgMimeDetectorCommand = "file -bi";

Přečtěte si sekci nahrát zabezpečení na stránce Příručka:Zabezpečení.

Další informace jsou k dispozici v příručkách:

Podpora interwiki

Podpora InterWiki je integrována do MediaWiki, ale musíte nakonfigurovat předponu, která bude použita pro vaše interní odkazy. Tato předpona je obvykle stejná jako $wgSitename , ale v případě, že ji potřebujete změnit, nastavte proměnnou $wgLocalInterwikis na preferovaný název.

Jazyk uživatelského rozhraní

MediaWiki umožňuje místo angličtiny jako výchozí různé jazyky lokalizovaných uživatelských rozhraní. Pokud chcete spustit svou wiki v neanglickém jazyce, nastavte proměnnou $wgLanguageCode na správný kód jazyka (např. "de" pro němčinu, "cs" pro češtinu atd.)

Můžete použít kterýkoli z jazyků se souborem v adresáři languages/i18n. Např. Pokud najdete es.json, můžete pro španělštinu použít "es". Nepoužívejte "Es" s velkým písmenem. Zdá se, že to funguje, ale ne všechny texty jsou přeloženy.

Po změně kódu jazyka budete muset spustit skript PHP, aby byl funkční. V terminálovém okně přejděte do adresáře wiki, přejděte do složky maintenance a zadejte php rebuildMessages.php --rebuild. Ve Windows nemusí být složka PHP ve vaší proměnné pro prostředí PATH a budete muset před cestou php předponu zadat cestu k programu.

Ne všechny jazyky jsou podporovány. Aktuální seznam podporovaných jazyků a v jakém rozsahu najdete ve [statistikách překladů https://translatewiki.net/w/i.php?title=Special:MessageGroupStats&group=mediawiki na TranslateWiki]. Tento seznam odráží aktuální stav jádra MediaWiki, takže v závislosti na verzi, kterou používáte, může dojít k nesrovnalostem.

Nastavení copyrightu

$wgRightsPage je stránka na wiki, která zahrnuje autorská práva, pod která spadá. Obvykle se jedná o Project:Autorská práva .
$wgRightsUrl je stránka popisující veškeré podrobnosti o vaší licenci. (Například pro GNU FDL by to bylo http://www.gnu.org/licenses/fdl.html.)
$wgRightsText je text v zápatí, který následuje za "Obsah je dostupný pod". Bude propojen se stránkou uvedenou v $wgRightsPage.
$wgRightsIcon je adresa URL obrázku umístěného v levé části zápatí.

Pokud $wgRightsPage není prázdný, bude odkaz v oznámení o autorských právech a licencích odkazovat na tuto stránku na vašem webu. Pokud je $wgRightsPage prázdný, odkaz na copyright / licenci se místo toho spojí s $wgRightsUrl.

Chcete-li upravit prohlášení o autorských právech webu, přidejte něco podobného do LocalSettings.php:

$wgRightsPage = "YourWiki:Copyright";
$wgRightsText = "copyright YourWiki";

Poté upravte MediaWiki:Copyright a poskytněte příslušnou zprávu. Pomocí "$1" označte místo, kde bude odkaz na vaši stránku s autorskými právy.

Příklad: nastavení licence Creative Commons

Chcete-li nastavit licenci Creative Commons, postupujte takto:

Vyberte si licenci: http://creativecommons.org/choose/
Zkontrolujte vrácený kód HTML, např.:

<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
<img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights30.png" />
</a>
This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License</a>.

Pro $wgRightsURL zadejte info href od první kotvy:

$wgRightsUrl = "http://creativecommons.org/licenses/by-nc-sa/3.0/";

Pro $wgRightsText zadejte text, na který odkazují druhé kotvy (pro gramaticky korektnější verzi přidejte do proměnné Wiki písmeno "a")

$wgRightsText = "a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License";

Pro $wgRightsIcon zadejte informace src z odkazu img v první kotvě. Chcete-li odkaz zkopírovat na svůj vlastní web, místo toho, aby byl použit z webu Creative Commons.

$wgRightsIcon = "http://creativecommons.org/images/public/somerights30.png";

Pro použití RDF metadata o autorských právech přidejte do LocalSettings.php jeden nebo oba následující řádky:

$wgEnableCreativeCommonsRdf = true;
$wgEnableDublinCoreRdf = true;

Uživatelské jmenné prostory

Deklarací $wgExtraNamespaces a úpravou $wgNamespacesWithSubpages a $wgNamespacesToBeSearchedDefault lze do instalace MediaWiki přidat další jmenné prostory. A deklarováním alias jmenného prostoru pole $wgNamespaceAliases lze přidat. Dbejte na to, abyste v tomto jmenném prostoru již neměli žádné stránky, například pokud byste měli stránku nazvanou "Technical:Support" a vytvořili jste jmenný prostor Technical:, pak by se tato stránka nejen ztratila, ale také ji nemůžete odstranit ze Special:Allpages. Chcete-li to odstranit, odstraňte jmenný prostor přesunutím položky "Technical:Support" na "Support" v hlavním prostoru, odstraněním přesměrování, opětovným vložením oboru názvů a přesunutím zpět na "Technical:Support". Další informace o tom, jak to provést, najdete na stránce Uživatelské jmenné prostory .

Zobrazení

Výchozí vzhled webu lze upravit pomocí $wgDefaultSkin .

Související odkazy

LocalSettingsGenerator.php zdrojový kód, který během instalace generuje původní obsah LocalSettings.php.
Wiki rodiny mohou sdílet stejné LocalSettings.php.
Manual:Securing database passwords - průvodce zabezpečením hesel databáze a souboru LocalSettings.php.