Open main menu

Manual:LocalSettings.php

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

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎magyar • ‎polski • ‎português do Brasil • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎अवधी • ‎ತುಳು • ‎中文 • ‎日本語 • ‎한국어
Atenção Atenção: Não edite o arquivo LocalSettings.php com o Bloco de Notas, TextEdit, ou qualquer outro editor de texto que adicione marcas de ordem de bytes aos arquivos. Eles interrompem o tempo de execução do PHP de sua wiki. Em vez disso, use editores como o Notepad++, o Vim ou o Atom. Eles lidam com codificações de arquivo corretamente. Estes editores podem também ser usados para reparar arquivos previamente danificados por editores de documentos.

O arquivo LocalSettings.php fornece informações básicas de definições de configuração (com base no arquivo DefaultSettings.php ) de uma instalação MediaWiki. Você deve aproveitar seu tempo para rever as configurações neste arquivo. O arquivo geralmente é gerado pelo instalador de MediaWiki baseado na Web, mas você pode ajustar os parâmetros, possivelmente em conjunto com as configurações do Apache. Para instalações MediaWiki configuradas como wiki farm, um arquivo chamado CommonSettings.php pode ser usado.

Localização no servidor

O arquivo LocalSettings.php não é uma página wiki e você não pode acessá-lo com o seu navegador. Em vez disso, ele é um arquivo no sistema de arquivos do servidor. Seu conteúdo é gerado durante a configuração inicial da wiki e o arquivo resultante deve ser copiado no servidor manualmente. O arquivo deve estar localizado na pasta que você instalou o MediaWiki, no mesmo nível de pastas como "includes/" ou "skins/" e arquivos como "api.php". Se este arquivo não está lá, a wiki não vai funcionar mesmo - se o wiki funcionar, o arquivo está lá. Se você não sabe onde está, você pode executar esse comando find / -iname 'LocalSettings.php' -print no shell do UNIX para fazer seu servidor lhe mostrar onde o arquivo está realmente.

(Se você estiver usando Vagrant, veja também MediaWiki-Vagrant#MediaWiki_settings.)

Segurança

O arquivo LocalSettings.php geralmente contém dados confidenciais, como logins de bancos de dados. Estes dados nunca devem ser revelados ao público! Devido a uma falha de segurança em algum lugar no servidor, pode acontecer que outros usuários possam visualizar o conteúdo dos arquivos. A fim de melhorar a segurança dos seus dados, você deve configurar as permissões do UNIX para este arquivo adequadamente: o usuário do servidor web deve ter acesso a este arquivo. Se esta é a mesma conta, que é o dono do arquivo, então você pode definir permissões para "600". Às vezes, o usuário servidor web não é o dono do arquivo, mas ele está no grupo de usuários UNIX do proprietário. Neste caso, as permissões de "640" devem estar certas. Para maior segurança, você deve estreitar as permissões tanto quanto possível.

Além disso, você pode criar um usuário MySQL, que é restrito a apenas o banco de dados usado pelo wiki e fornecer credenciais desse usuário no arquivo LocalSettings.php. Além disso, você pode configurar o servidor de banco de dados para aceitar apenas conexões a partir de localhost - isso deve impedir o acesso a partir do exterior em caso de credenciais que vazaram.

Conteúdo dos arquivos

Quando você edita LocalSettings.php, certifique-se de salvá-lo na codificação correta novamente. Você deve usara codificação "ANSI as UTF-8" - que é a codificação UTF-8 sem marcas de ordem de byte (BOM).

LocalSettings.php contém código PHP; principalmente a definição de variáveis e seus valores. Alterar uma configuração normalmente significa alterar o valor de uma variável PHP. As alterações entrarão em vigor imediatamente após salvar o arquivo novamente no servidor: Não há necessidade de reiniciar nada manualmente. De qualquer forma, em alguns casos, pode ser necessário limpar o cache do seu navegador para realmente ver as mudanças que você fez.

Os valores “padrão” de muitas outras configurações estão definidos em includes/DefaultSettings.php, os quais não devem ser editados; se a variável que você deseja alterar não estiver mencionada no seu LocalSettings.php, copie a linha apropriada de DefaultSettings.php e modifique-a de forma adequada no LocalSettings.php. Dentro do LocalSettings.php você pode adicionar novas linhas no final.

Dentro do arquivo também pode haver várias linhas, tais como 'require_once "extensions/extension.php";', que fazem ligação a outras extensões habilitadas na wiki. Estas extensões podem requerer a definição dos valores de mais variáveis ​​no LocalSettings.php; verifique a documentação da extensão para obter mais instruções.

A sua versão do LocalSettings.php pode não terminar com uma tag de fechamento PHP ?>. Isso é feito de propósito, uma vez que impede as pessoas de acidentalmente adicionar novas informações após esta tag. PHP funcionará muito bem sem a tag de fechamento.

Se você tem uma wiki em um serviço de hospedagem MediaWiki, você pode não ter acesso de gravação (talvez nem mesmo de acesso de leitura) para o arquivo LocalSettings.php (veja p.ex.[1]). A empresa de hospedagem wiki pode ou não estar disposta a fazer as mudanças que você deseja. Talvez ela queira manter a maioria das configurações do mesmo em todas as wikis da hospedagem wiki.

Antes da versão 1.17, esse arquivo era gerado automaticamente por um script de instalação e colocado na pasta 'config'. A partir da versão 1.17, esse arquivo não é escrito para o seu servidor, por razões de segurança. Ele agora é oferecido como um download, o que você deve, então, fazer o upload para o seu servidor para o seu wiki para começar a trabalhar. Para uma explicação mais completa, veja esta página.

Visão geral das configurações disponíveis

Consulte o índice de configurações e os comentários incluídos nos arquivos de configurações para ajuda sobre o que todas as variáveis fazem. Uma breve listagem das variáveis ​​mais importantes, bem como as características mais solicitadas, está colocada abaixo.

Configurações padrão

Caminho de instalação

A variável $IP (include path) detém o caminho do arquivo local para a instalação base da sua wiki. Desde a versão 1.17, o MediaWiki automaticamente define a $IP – defini-la no LocalSettings.php não é mais necessário. Ele assumirá como padrão o diretório de trabalho atual automaticamente e poderá ser usado sem a necessidade de defini-la manualmente.

O arquivo DefaultSettings.php é carregado a partir do diretório designado pela variável IP.

Nome do site

A variável $wgSitename contém o nome da configuração da sua wiki. Este nome é incluído muitas vezes ao longo do sistema, como via MediaWiki: PageTitle. Por exemplo, o slogan da Wikipédia "'Wikipédia, a enciclopédia livre."' faz uso dessa configuração.

Declinações do nome do site

Algumas traduções da interface estão prontas para inflexão do nome do site. Você pode definir as formas adequadas de palavras nas variáveis $wgGrammarForms (para exemplos, refira-se à página de documentação da $wgSitename ).

Idioma do site

A variável $wgLanguageCode controla o idioma de interface de sua wiki. Enquanto os usuários registrados podem alternar o idioma que eles vêem em suas preferências, esta variável define o idioma padrão que todos os usuários anônimos e a maioria usuários registrados vêem.

Caminho do script principal

$wgScriptPath é o prefixo do URL para acessar o script principal do MediaWiki que é a peça central da atuação do código do MediaWiki. Essa configuração deve corresponder às configurações do Apache, especialmente se você estiver usando as regras de reescrita do Apache.

Nome do servidor

$wgServer pode ser usado opcionalmente para substituir a detecção automática. Quando o wiki é acessado a partir de qualquer localhost onde ele é executado, a partir de uma intranet ou da Internet, notificações por e-mail e algumas outras mensagens computadorizadas seriam normalmente entregues com diferentes URLs. Ao utilizar o $wgServer é substituída a detecção, e o nome do servidor será constante.

From MediaWiki 1.34 $wgServer must be set in LocalSettings.php. Prior to that, MediaWiki tried to autodetect the name of the server and $wgServer was optional, to override the autodetection.

Se www.example.com é o endereço do servidor do seu wiki, como visto a partir da Internet, adicione uma linha da seguinte maneira:

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

A palavra mágica {{SERVER}} pode ser usada em páginas wiki; é igual ao valor de $wgServer; no entanto, em uma wiki, como as da família Wikimedia, onde são usadas URLs relativas, não vai expandir totalmente, por exemplo, aqui ele exibe //www.mediawiki.org, que pode nem ser clicado nem copiado e colado na barra de endereços como ele está.

Nome do script principal

$wgScript é o nome do script PHP principal (índice) do MediaWiki, chamado index.php por padrão. Alterar o nome do script provavelmente não é uma boa idéia. No entanto, se você sentir vontade de fazê-lo, este é o lugar para fazer as alterações. Certifique-se de que você sabe o que está fazendo.

Nome do script de redirect

A variável $wgRedirectScript especifica a URL do script de redirecionamento que lida com redirecionamentos no MediaWiki. Esta configuração é semelhante a wgScript pois é possível configurar o nome exato do script. Como mencionado acima, isso provavelmente não é uma boa ideia, a menos que você realmente saiba o que está fazendo.

Caminho dos artigos

$wgArticlePath é o caminho a ser usado ao acessar uma página no MediaWiki. O caminho deve conter o caminho para o script principal (geralmente fazendo uso do $wgScript) e utilizar o espaço reservado $1 para o nome do artigo.

Se você estiver usando regras de reescrita do Apache para criar bonitas e curtas URLs, você provavelmente precisará ajustar $wgArticlePath para abordar o caminho certo. Observe que o wgArticlePath é usado para construir URLs a partir do MediaWiki. Se você cometer um erro aqui, links internos aparecerão de forma incorreta, enquanto você ainda puder acessar a página principal, especificando a URL correta manualmente. Veja Manual:Short URL para mais informações sobre configuração de URL.

Os valores típicos são:

"$wgScript/$1" passa o nome do artigo com o separador "/"
"$wgScript?title=$1" passa o nome do artigo como um parâmetro (estilo antigo)
"/mypath/$1" caminho personalizado. Use as regras de reescrita do Apache para converter "mypath" para o caminho correto acessando o script principal

Local de estilos CSS

Use a variável $wgStylePath para definir o caminho da URL para o local onde as folhas de estilo (CSS) para a instalação MediaWiki estão localizadas. A variável $wgStyleDirectory deve apontar o mesmo lugar, mas note que este é um caminho de sistema de arquivos local para uso em scripts internos acessam o sistema de arquivos.

Local para uploads

O diretório de upload é o local onde os arquivos enviados pelos usuários são armazenados. A variável $wgUploadPath especifica a URL, enquanto a variável $wgUploadDirectory aponta para o caminho do sistema de arquivos local.

A variável $wgLogo especifica qual o logotipo gráfico é exibido no canto superior esquerdo de todas as páginas do MediaWiki. Estes passos substituirão o logotipo padrão no diretório /wiki/skins/common/images/, substituindo /wiki com o caminho para o diretório onde você instalou o software MediaWiki.

Primeiro, copie qual o logotipo que você quer para o diretório /wiki/skins/common/images/ (substituindo /wiki com o caminho para o diretório onde você instalou o software MediaWiki).

Em seguida, tente encontrar a linha parecida com o exemplo a seguir no LocalSettings.php:

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

Se não existe tal linha, você pode copiar e colar a linha acima no final do arquivo.

Em seguida, modificar essa linha para apontar para o seu logotipo. O logotipo deve estar acessível. O valor desta variável é passado para o navegador web, que a utiliza para buscar o logotipo. Em caso de dúvida, uma boa maneira de escolher o que colocar aqui é navegar para o logotipo em seu navegador (por exemplo, nesta wiki a url do logotipo é http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png ), e colocar a url completa como valor desta variável.

Algumas pessoas simplesmente substituem o arquivo skins/common/images/wiki.png com seu logotipo. Isso não é recomendado, já que o logotipo personalizado seria substituído na atualização.

Informações para contato

A variável $wgEmergencyContact é o endereço de e-mail do usuário para entrar em contato quando as coisas acontecem. Este endereço de e-mail é usado para enviar relatórios de erros internos. Como administrador, você pode incluir o seu endereço de e-mail aqui.

A variável $wgPasswordSender é o endereço de e-mail a partir de onde o e-mail é enviado, quando as senhas são enviadas para usuários que esqueceram suas senhas. Escolha um endereço de pessoas para responder em caso de problemas ou confusão.

Configurações de banco de dados

O MediaWiki precisa ter acesso ao banco de dados (atualmente, seja MySQL ou PostgreSQL) para armazenar páginas, modificações, informações sobre o usuário, e muito mais coisas.

A variável $wgDBserver contém o nome da máquina onde o banco de dados está hospedado. Na maioria dos casos, ele será apenas "localhost" quando o banco de dados é executado no mesmo sistema, mas para instalações distribuídas, você precisa preencher o domínio completo do computador que está executando o banco de dados.

$wgDBname é o nome da base de dados a ser utilizada pelo MediaWiki. Uma única instalação MySQL ou PostgreSQL pode armazenar mais de um banco de dados e você pode até mesmo executar muitas instalações MediaWiki em um único servidor. Certifique-se de ter declarado o nome do banco de dados correto aqui e usar nomes de bancos de dados diferentes para diferentes instalações wiki no mesmo servidor de banco de dados.

As variáveis $wgDBuser e $wgDBpassword contêm o nome de login e senha a ser usados pelo MediaWiki para acessar o banco de dados. Verifique se o usuário especificado tem os direitos de acesso apropriados para poder manipular a tabela wiki no servidor de banco de dados.

Direitos de usuário

A variável $wgGroupPermissions é um array associativo, que controla as permissões para criação e edição de páginas para seus grupos de usuários diferentes. Neste array, níveis de permissão personalizados podem ser criados, e os níveis de permissão para os diferentes grupos de usuários podem ser configurados. Veja Help:User rights para mais informações sobre as diferentes permissões e grupos de usuários disponíveis.

Forçar ligações capitalizadas

Por padrão, nenhum nome da página pode começar com uma letra romana minúscula: na tentativa de fazê-lo a primeira letra é convertida em maiúsculas, se um destino do link, incluído página, imagem ou categoria é especificado com um nome que começa com uma letra minúscula, o alvo real etc é a página começando com a capitalização correspondente.

Alternativamente, nomes de página podem começar com uma letra minúscula, além de a possibilidade de iniciar com um capital, um dígito, etc. Para isso você deve ajustar a variável $wgCapitalLinks para false, que permite caracteres minúsculos, ou true, que escolhe o comportamento padrão.

Habilitando subpáginas

No LocalSettings.php, subpáginas são habilitadas em uma base por espaço nominal usando a variável $wgNamespacesWithSubpages . Por exemplo, para permitir subpáginas no espaço nominal principal:

$wgNamespacesWithSubpages[NS_MAIN] = 1;

Upload de imagens

Antes que os usuários tenham permissão para fazer upload de arquivos para o sistema MediaWiki, você tem que habilitar esse recurso. Verifique se o diretório de upload está devidamente configurado e gravável pelo processo do servidor web Apache. Em seguida, defina a variável $wgEnableUploads para true a fim de permitir upload na interface de usuário web.

P.ex., aqui está um exemplo de código de includes/DefaultSettings.php para inserir no 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;

Se você quer poder redimensionar imagens em tempo real para apoiar as miniaturas, o MediaWiki precisa de uma instalação do ImageMagick funcionando. Defina $wgUseImageMagick como true depois de ter instalado e testado o ImageMagick em seu sistema. Certifique-se que $wgImageMagickConvertCommand aponta para o local correto do comando convert de sua instalação, que o comando é executável pelo processo do servidor web, e $wgMaxShellMemory seja grande o suficiente. Veja Manual:Image administration/pt-br para obter informações detalhadas e resolução de problemas.

Além disso, você pode querer modificar a lista de extensões aceitas, que são armazenados dentro do array $wgFileExtensions :

$wgFileExtensions = array('png','jpg','jpeg','ogg','doc','xls','ppt','mp3','sxc','pdf');

No caso do ImageMagick produzir uma mensagem erro semelhante a seguinte:

Fatal error: mime_magic could not be initialized, magic file is not available in includes/MimeMagic.php on line 506

experimente então adicionar a seguinte linha ao LocalSettings.php:

$wgMimeDetectorCommand = "file -bi";

Suporte ao interwiki

O suporte ao InterWiki está embutido no MediaWiki, mas você precisa configurar o prefixo a ser usado para suas ligações internas. Este prefixo é geralmente o mesmo que $site-name, mas no caso de você precisar mudar isso, defina a variável $wgLocalInterwiki para o nome preferido.

Idioma da interface de usuário

O MediaWiki permite uma variedade de idiomas de interfaces de usuário localizados em vez do padrão Inglês. Se você deseja executar o seu wiki em um idioma não-inglês, defina a variável $wgLanguageCode ao código de idioma adequado (p. ex. "de" para alemão, "es" para espanhol, etc.)

Você pode usar qualquer um dos idiomas encontrados no diretório languages/i18n. Assim, se encontrar pt-br.json, você pode usar pt-br para português do Brasil. Não use Pt-br, com letra maiúscula. Embora pareça funcionar, nem todos os textos são traduzidos.

Depois de alterar o código do idioma, você terá que executar um script PHP para que ele funcione. Num terminal, vá para o diretório da sua wiki, abra a pasta maintenance e digite php rebuildMessages.php --rebuild. No Windows, a pasta do PHP pode não estar incluída na variável de ambiente PATH, e você terá de prefixar php com o caminho ao programa.

Nem todos os idiomas são suportados. Veja aqui para ver uma lista das estatísticas de localização de 1.35.0-wmf.2 (c045ed1). Consulte translatewiki.net para as estatísticas por versão lançada.

Configurando direitos autorais para o site

  • $wgRightsPage é a página no wiki, que abrange os direitos autorais que estão incorporados. Normalmente, será Project:Copyrights.
  • $wgRightsUrl é a página que descreve os detalhes da sua licença. (Para a licença GNU FDL, por exemplo, seria http://www.gnu.org/licenses/fdl.html.)
  • $wgRightsText é o texto no rodapé que se segue "Conteúdo disponível sob". Ela será vinculada à página especificada na variável $wgRightsPage.
  • $wgRightsIcon é o URL da imagem colocado à esquerda do rodapé.
    Note: Se $wgRightsPage não estiver vazio, o link no aviso copyright/license ligará para essa página em seu site. Se $wgRightsPage estiver vazio, então o aviso copyright/license ligará à variável $wgRightsUrl como alternativa.

Para modificar as declarações de direitos autorais do site, adicionar algo como isso no LocalSettings.php:

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

Posteriormente, edite MediaWiki:Copyright para proporcionar uma mensagem apropriada, usando "$1" para indicar a posição onde o link para sua página de direitos autorais estará.

Exemplo: criação de uma licença Creative Commons

Para definir uma licença Creative Commons faça o seguinte:

 <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>.
  • Para $wgRightsURL inserir a informação do href da primeira âncora:
$wgRightsUrl = "http://creativecommons.org/licenses/by-nc-sa/3.0/";

Para $wgRightsText digite o texto onde a segunda âncora é vinculada (adicione o "a" à variável Wiki para uma versão mais gramaticalmente correta)

$wgRightsText = "a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License";
  • Para $wgRightsIcon inserir as informações da origem (src) da ligação image (img) na primeira âncora. Você quer copiar o emblema de seu próprio site, em vez de usar o do site da Creative Commons.
$wgRightsIcon = "http://creativecommons.org/images/public/somerights30.png";
  • Para utilizar os metadados RDF sobre direitos autorais adicionar uma ou ambas das seguintes linhas ao seu arquivo LocalSettings.php
$wgEnableCreativeCommonsRdf = true;
$wgEnableDublinCoreRdf = true;

Namespaces personalizados

Ao declarar o array $wgExtraNamespaces , e modificar os arrays $wgNamespacesToBeSearchedDefault , espaços nominais adicionais podem ser adicionados a uma instalação do MediaWiki; e ao declarar o array $wgNamespaceAliases aliases de espaço nominal podem ser adicionados. Tenha cuidado para não ter quaisquer páginas já tituladas nesse namespace, por exemplo, em que você tinha uma página chamada "Technical:Support" e você criou o espaço nominal "Technical:", então essa página não só seria perdida, mas você não pode removê-la de Special:Allpages. Para corrigir isso exclua o namespace, mova "Technical:Support" para "Support" no espaço principal, exclua o redirecionamento, reinsira o espaço nomina, e mova-o de volta para "Technical:Support". Consulte Espaços nominais personalizados para obter informações adicionais a respeito de como fazê-lo.

Skins

A skin padrão do site pode ser modificada através da variável $wgDefaultSkin.

Ver também

  • Famílias wiki podem compartilhar o mesmo LocalSettings.php.
  • A extensão Configure fornece uma maneira de definir as definições de configuração de uma página especial.
  • Protegendo senhas de banco de dados - um guia para proteger suas senhas de banco de dados e o arquivo LocalSettings.php.