Guia de instalação do TWiki
Instruções de instalação do TWiki 01-Sep-2001 production release
Visão Geral
Esses passos para instalação são baseados no servidorApache Web server em Linux. TWiki é executado em outros servidores Web e sistemas Unix, e é bem-executado em qualquer SO e servidor que estejam especificados em
system requirements. Documentação para outras plataformas é atualmente limitada. Para Windows, confira em
TWiki:Codev.TWikiOnWindows. Procure a Web
TWiki:Codev para outras dicas de instalação.
Instalação Padrão.
Peça e faça o download da distribuição TWiki 01-Set-2001 em formato Unix ZIP em
http://TWiki.org/download.html.
(para instalar TWiki em código fonte, para uso em um desenvolvimento de projeto de software, leia TWiki:Codev.SourceForgeHowTo.)
Passo 1: Criar & Configurar os Diretórios
NOTA: Se você não tem acesso aos arquivos de configuração do seu servidor Web - por exemplo, se você está instalando uma conta ISP-hosted - use em seu lugar o Passo 1 alternativo .
- Crie o diretório
/home/httpd/twiki e faça o unzip da distribuição TWiki nesse diretório.
- O diretório
twiki/bin do TWiki deve ficar definido como um diretório cgi-bin. Adicione /home/httpd/twiki/bin ao arquivo /etc/httpd/httpd.conf com somente a opção ExecCGI.
- O diretório
twiki/pub do TWiki deve estar definido como visível como URL. Adicione /home/httpd/twiki ao arquivo httpd.conf com opções de acesso normais (copie de /home/httpd/html ).
- Agora adicione
ScriptAlias a /twiki/bin e Alias a /twiki no arquivo httpd.conf .
NOTA: O ScriptAlias deve vir antes de Alias, senão Apache irá falhar ao definir corretamente /twiki/bin/, ao tratá-lo simplesmente como um sub-diretório de /twiki/ alias.
Exemplo de entradas no arquivo httpd.conf:
ScriptAlias /twiki/bin/ "/home/httpd/twiki/bin/"
Alias /twiki/ "/home/httpd/twiki/"
Options +ExecCGI
SetHandler cgi-script
AllowOverride all
Allow from all
Options FollowSymLinks +Includes
AllowOverride None
Allow from all
- Reinicie o Apache usando
/etc/rc.d/rc5.d/S85httpd restart .
- Teste que o diretório
twiki/bin permite CGI tentando visitá-lo em seu navegador:
- Digite a URL para o diretório
bin, http://yourdomain.com/twiki/bin/.
- Suas configurações estão corretas se você obtiver uma mensagem como
"Forbidden. You don't have permission to access /twiki/bin/ on this server".
- As configurações NÃO estão corretas se você obtiver algo como
"Index of /twiki/bin" - confira seu arquivo httpd.conf.
Passo 1 para Contas Não-Root
Para instalar TWiki em um sistema onde você não tem privilégio de administrador de servidor, por exemplo, em uma hosted Web account:
- Faça o download e descompacte com unzip o TWiki em seu computador local
- Usando a tabela abaixo, crie uma estrutura de diretório em sua máquina de servidor
- Faça o upload dos arquivos TWiki por FTP (transfira como text com exceção para arquivos de imagem em
pub)
| Diretório TWiki: |
O que é isso: |
Para onde copiar: |
Exemplo: |
twiki/bin |
CGI bin |
cgi-enabled dir |
/home/smith/public_html/cgi-bin |
twiki/lib |
library files |
same level as twiki/bin |
/home/smith/public_html/lib |
twiki/pub |
public files |
htdoc enabled dir |
/home/smith/public_html/pub |
twiki/data |
topic data |
outside of htdoc tree (for security) |
/home/smith/twiki/data |
twiki/templates |
Web templates |
outside of htdoc tree (for security) |
/home/smith/twiki/templates |
Passo 2: Definir Permisões de Arquivos
- Certifique-se que Perl 5 e Perl CGI library estejam instalados em seu sistema. A localização padrão do Perl é
/usr/bin/perl. Se estiver em outro lugar, mude o path para Perl na primeira linha de cada script no diretório twiki/bin, ou crie um link simbólico de /usr/bin/perl.
- IMPORTANTE: Em contas ISP-hosted , Perl CGI scripts normalmente exigem uma extensão
.cgi para executar.Alguns sistemas precisam da extensão Perl regular .pl. Modifique todos os nomes de arquivo scripts twiki/bin caso necessário.
- Defina as permissões de arquivo de todos os scripts Perl no diretório
twiki/bin como executáveis para -rwxr-xr-x (755).
- Para que você possa editar scripts Perl e arquivos
.tmpl são necessários chown e chgrp -R twiki de maneira que todos os arquivos tenham o dono que você desejar.
- NOTA: Esse guia assume usuário
nobody como dono de todos os arquivos manipulados por scipts CGI (executados pelo servidor Web), e usuário twiki para todos os outros arquivos. Você pode:
- substituir
nobody por qualquer outro usuário caso seu servidor execute scripts sob um nome diferente (ex: padrão para Debian é www-data).
- DICA: Execute o script
testenv a partir do seu navegador: http://yourdomain.com/twiki/bin/testenv. Isso irá mostrá-lo o nome de usuário de scripts CGI, uma tabela listando todas as variáveis de ambiente CGI, e um teste de seu arquivo de configuração twiki/lib/TWiki.cfg (você irá configurar isso em um minuto).
- substitua usuário
twiki pelo seu próprio nome de usuário
- Defina a permissão de todos os arquivos abaixo
twiki/data de maneira que eles possam ser escritos pelo usuário nobody. Uma maneira simples é usar chmod para -rw-rw-r-- (664) e chown para nobody.
- Defina a permissão do diretório
twiki/data e seus subdiretórios de modo que os arquivos ali contidos posssam ser escritos pelo usuário nobody. Uma maneira simples de fazê-lo é usar chmod para drwxrwxr-x (775) e chown para nobody.
- Defina a permissão do diretório
twiki/pub e de todos os seus subdiretórios de maneira que os arquivos ali contidos possam ser escritos pelo usuário nobody. Uma maneira simples de fazê-lo é usar chmod para drwxrwxr-x (775) e chown para nobody.
- NOTA: Os arquivos de reposição
twiki/data/*/*.txt,v RCS no pacote de instalação são bloqueados pelo usuário nobody. Se seus scripts CGI não estiverem executando como usuário nobody, não é possível to check in files (você verá que o número de revisão nao irá aumentar após salvar um tópico). Neste caso, você precisa desbloquear todos os arquivos de reposição (confira as páginas de manual RCS) e os bloqueie com um usuário diferente, ex www-data, ou apague-os todos - novos arquivos serão automaticamente criados na primeira vez que cada tópico for editado. Uma maneira simples de mudar o proprietário é pelo método de localizar e substituir em todos os arquivos; por exemplo, using sed:
for f in *,v; do sed 's/nobody\:/www-data\:/' $f > x; mv x $f; done
Passo 3: Definir o Arquivo de Configuração Principal
- Edite o arquivo
twiki/lib/TWiki.cfg, definindo as variáveis de acordo com as suas necessidades.
- Defina a extensão de arquivo na variável
$scriptSuffix para cgi ou pl se requerido.
- Certifique-se que RCS está instalado. Defina
$rcsDir em twiki/lib/TWiki.cfg para ter a mesma localização de seus binários RCS.
- Alerta de segurança: Diretórios
twiki/data , twiki/templates e todos os seus subdiretórios devem estar definidos para que eles não sejam visíveis como uma URL. (Alternativamente, mova os diretórios para um lugar onde eles não sejam visíveis, e mude as variáveis em twiki/lib/TWiki.cfg de acordo com as modificações feitas)
- Teste suas definições executando o script
testenv no seu navegador: http://seudominio.com/twiki/bin/testenv. Verifique se suas definições de configuração de arquivo estão corretas.
Passo 4: Finalize pelo seu Navegador
- Coloque seu navegador em
http://seudominio.com/twiki/bin/view e comece a usar o TWiki de novo!
- Edite o tópico TWikiPreferences na web TWiki:TWiki para definir o endereço eletrônico do
WIKIWEBMASTER, e outras preferências.
- Edite o tópico WebPreferences em cada web, se necessário: defina mensagens individuais
WEBCOPYRIGHT, e outras preferências.
- Permita notificação por correio eletrônico de mudança em tópicos, TWikiSiteTools? tem mais.
- Edite o tópico WebNotify em todas as webs e adicione usuários que você queira notificar.
- Adicione o TWiki:Main/PoweredByTWikiLogo ao seu tópico Main.
- Você pode adicionar novas
%VARIABLES%. Defina variáveis site-level no tópico TWikiPreferences. Veja também: TWikiVariables.
Estes são os passos básicos para uma instalação padrão do TWiki. As opções abaixo são para a personalização do servidor.
Opções Adicionais em Nível de Servidor
Com a sua nova instalação TWiki de pé e executando, você pode gerenciar a maioria dos aspectos de seu sítio pela interface do navegador. Somente poucas funções requerem acesso ao sistema de arquivos do servidor, via Telnet ou FTP. Você pode fazer estas mudanças a nível de servidor durante a instalação e a qualquer momento depois disso.
Habilitando Autenticação de Usuários
- Caso TWiki tenha sido instalado em um servidor não-autenticado - não usando SSL - e você queira autenticar usuários:
- Renomeie o arquico
.htaccess.txt no diretório twiki/bin para .htaccess e o modifique de acordo com as suas necessidades. Para detalhes, consulte a documentação de servidor HTTP (para servidor Apache: [1], [2]). Em particular, as seguintes partes em vermelho necessitam ser configuradas corretamente:
Redirect /urlpath/to/TWiki/index.html http://your.domain.com/urlpath/to/TWiki/bin/view
AuthUserFile /filepath/to/TWiki/data/.htpasswd
ErrorDocument 401 /urlpath/to/TWiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- NOTA: Caso você tenha renomeado os script de arquivos CGI para ter uma extensão você tem que refletir isso nas entradas
edit, view, preview, etc em .htaccess.
- NOTA: O navegador deve pedir nome de login e senha quando você clicar no link Edit. Caso
.htaccess não tenha o efeito desejado você precisa habilitá-lo: Adicione "AllowOverride All" à Directory section de access.conf para o ser diretório twiki/bin.
- Copie o tópico TWikiRegistrationPub? para TWikiRegistration. Faça isso editando os tópicos na web TWiki, ou renomeando os arquivos
.txt e .txt,v no diretório twiki/data/TWiki.
- DICA: Você pode melhorar o formulário de registro apagando ou adicionando tags input. O parâmetro
name="" das tags input devem começar com: "Twk0..." (Se este for um campo opcional), ou "Twk1..." (se este for um campo obrigatório). Isso assegura que os campos sejam processados corretamente.
- Registre-se no tópico TWikiRegistration.
- NOTA: Quando um usuário se registra, uma nova linha com o nome de usuário e a senha encriptada é adicionada ao arquivo
data/.htpasswd. O arquivo .htpasswd que vem com a instalação do TWiki inclui contas de usuário para TWiki core team members que são usadas para testes em TWiki.org. Você pode editar o arquivo e apagar aquelas linhas.
- Crie um novo tópico para verificar se a autenticação funciona.
- Edite o tópico TWikiAdminGroup na web TWiki:Main para incluir usuários com status de administrador de sistema.
- Edite o tópico TWikiPreferences na web TWiki:TWiki para definir privilégios de acesso.
- Edite o tópico WebPreferences em cada web, caso necessite: defina privilégios de acesso.
Adicionando uma Nova Web
Para criar uma nova web:
- Crie um novo diretório web data em
twiki/data e verifique as permissões de arquivo deste diretório.
- Use um nome que comece com os caracteres
A..Z, seguidos por a..z e/ou os caracteres 0..9, mas não uma WikiWord.
- Copie todos os arquivos do diretório
twiki/data/_default para um novo diretório de informações, preservando os donos, grupos e permissões dos arquivos originais (em Unix, use cp -p). Os arquivos de informações devem poder ser escritos pelo dono dos scripts CGI scripts que estão rodando (normalmente, nobody).
- DICA: Você pode deginir permissões de arquivos
.txt e .txt,v para -rw-rw-rw- (666) e então editar os tópicos usando o seu navegador; RCS irá rearmazenar as permissões de arquivo corretamente quando salvar o tópico.
- Adicione a nova web à web list (visível no canto superior direito de cada tópico) editando as preferências site-level, TWikiPreferences:
- Atualize as definições web editando o tópico WebPreferences da nova web:
- Aprimore a variável =Página inicial Diretrizes de Tradução Índice de tópicos Últimas atualizações Busca = para que contenha links web-specific de sua preferência.
- Defina a variável WEBBGCOLOR para uma cor. O número representa a única cor para a web.
- Defina Plugins, privilégios de acesso, custom variables, other web-level options (ex:
Copyleft @ 2002, pelos autores que colaboraram na produção dos textos. Todo material aqui é liberado para uso através da GNU FDL. Para sugestões, dúvidas, etc., entre em contato com diego@edugraf.ufsc.br . can be set for an individual web).
- Adicione a nova web na tabela colorida que lista as webs através da edição do tópico TWIKIWEB%.TWikiWebsTable
- Teste a nova web: visualize páginas, crie uma nova página.
Esta é uma configuração básica de uma nova Web!
Opicionalmente, você pode:
- Criar um template Web personalizado em um novo diretório
twiki/templates/AlgumaWeb (caso contrário, os templates são herdados de twiki/templates).
- Adicionar TWikiForms para servir de entrada em páginas baseada em formulário que esteja armazenada separadamente do texto do tópico 'free-form' principal.
NOTA: Tópicos home do usuário estão localizados na web TWiki.Main - não tente movê-los ou criá-los em outras webs. A partir de qualquer outra web as assinaturas de usuários devem apontar para a web TWiki.Main , usando um
Main.UserName ou uma formatação
Main.UserName . (A variável
Main é uma vantagem caso você venha a mudar o nome da web Main, mas o padrão
Main.UserName é mais fácil para os usuários, o que é a linha inferior!
Informações da estrutura dos arquivos e diretórios do TWiki
Veja
Appendix A: TWiki File System? para um sistema snapshot instalado e descrições de todos os arquivos na distribuição TWiki 01-Sep-2001.
--
PeterThoeny - 13 Sep 2001
--
MikeMannix - 03 Dec 2001