domingo, 18 de setembro de 2011

Instalando o Bugzilla no Debian ou Ubuntu

  • Introdução

O Bugzilla é um famoso gerenciador de bugs e pendências para projetos de desenvolvimento, especialmente desenvolvimento de sistemas, criado pela Fundação Mozilla. Suporta múltiplos projetos, diversos componentes por projeto e login de usuários. Suporta envio de anexos e é bastante flexível, além de ser código aberto (e, portanto, gratuito). Você pode baixar e instalar o Bugzilla em sua máquina pessoal, em um servidor de seu projeto, sua empresa ou instituição, ou mesmo modificá-lo e adaptá-lo para seu uso, caso deseje. Este artigo ensina os passos básicos para a instalação comum do Bugzilla, dando ênfase a sistemas derivados do Debian (como Ubuntu). Uma documentação detalhada de cada versão do sistema, incluindo a instalação destas, pode ser encontrada do repositório oficial de documentações (aqui). O artigo é divido em várias seções, uma para cada etapa da instalação, para melhor compreensão e orientação segura do fluxo, descrito passo-a-passo.


  • Verificando Dependências: Perl

O Bugzilla depente da linguagem Perl. Você não precisa saber nada da linguagem e possivelmente ela já vem na sua distribuição. Porém, para verificar isto, digite o comando:

perl -v

Caso o comando rode perfeitamente, o Perl está instalado. A versão mínima do Perl para rodar o Bugzilla deve ser maior ou igual à 5.8.1.


  • Verificando Dependências: Banco de Dados

O Bugzilla pode rodar em uma de três opções diferentes de bancos: MySQL, Oracle ou PostgreSQL. Para verificar as versões de cada um deles, digite:

mysql -V [para o MySQL. Deve ser maior ou igual a 4.1.2]
psql -V [para o PostgreSQL. Deve ser maior ou igual a 8.00.0000]
select * from v$version [para o Oracle. Deve ser maior ou igual a 10.02.0]

Se você tem ao menos um destes bancos e não está usando uma versão incrivelmente desatualizada da sua distribuição, então muito provavelmente seu banco servirá para o Bugzilla. Caso você ainda não tenha um banco de dados, recomendo que instale e use o MySQL. Para tanto, visite o nosso artigo Como Instalar e Configurar o MySQL no Ubuntu.


  • Verificando Dependências: Servidor Web

 Imagino que, a esta altura, você já tenha o Apache Web Server instalado (ou outro servidor web que suporte Perl). O Bugzilla recomenda o uso do Apache e, caso não o tenha instalado, proceda a instalação do mesmo via apt-get, digitando:

apt-get install apache2


  • Instalando e Configurando o Bugzilla

Muito bem, agora você está pronto para começar a instalação do Bugzilla. Baixe-o do portal oficial e copie-o para o diretório onde estão suas páginas do Apache. Descomprima-o lá dentro. Exemplo (para o arquivo da versão 4.0.2 e para o diretório /var/www como sendo o repositório das pastas virtuais do Apache):

mv bugzilla-4.0.2.tar.gz /var/www/
cd /var/www/
tar -zxvf bugzilla-4.0.2.tar.gz

É sempre bom renomear o diretório criado para um nome que você decida ser melhor, caso deseje:

mv bugzilla-4.0.2 bugzilla

Como o Bugzilla precisa escrever nos seus próprios arquivos, você terá de dar permissão para tanto. Verifique o usuário e grupo do Apache que está configurado na sua distribuição (para o Ubuntu, o usuário e grupo são ambos www-data) e modifique as permissões de acesso do Bugzilla para autorizar este usuário e grupo:

chown -R www-data bugzilla/
chgrp -R www-data bugzilla/

Você pode conferir se tudo funcionou com um "ls -l".


  • Instalando e Configurando os Módulos do Perl para o Bugzilla

A não ser que você seja um ávido desenvolvedor Perl, possivelmente seu servidor tem o Perl, porém não tem todos os módulos e bibliotecas necessárias para rodar o Bugzilla em sua plenitude. Neste caso, precisaremos verificar quais módulos você realmente tem e quais precisam ser instalados. Esta etapa deve ser feita cuidadosamente para que não falte nenhum módulo. Felizmente, o programa fornece uma ferramenta para isto. Entre no diretório do Bugzilla (talvez /var/www/bugzilla, ou o local onde você o colocou) e digite:

./checksetup.pl --check-modules

Não fique triste, mas a saída reportará várias linhas em vermelho, indicando os módulos não encontrados (ou encontrados, mas em versões inferiores à esperada). Você pode tentar instalá-los com os comandos sugeridos na própria saída, ou via apt-get. Eu recomendo que instale via apt-get o máximo de módulos possíveis, de sorte a garantir a integridade de seu sistema.
Alguns módulos que possivelmente estarão presentes: CGI.pm, Digest-SHA, TimeDate, DBI, URI, DBD-mysql. Alguns módulos que possivelmente estarão ausentes e podem ser instalados via apt-get são:

Módulo DateTime-Timezone:
apt-get install libdatetime-timezone-perl

Módulos List-MoreUtils e DateTime:
apt-get install libdatetime-perl liblist-moreutils-perl

Módulo Email-Send:
apt-get install libemail-send-perl

Módulo Email-MIME:
apt-get install libemail-mime-perl

Módulo Template (Template-Toolkit):
apt-get install libtemplate-perl

Caso, em seu sistema, outro módulo esteja faltando, o pacote correspondente pode ser encontrado fazendo a pesquisa:

apt-cache search [nome-do-módulo]

Use esta opção acima para achar também os módulos opcionais que deseja instalar (embora não estritamente obrigatórios, os módulos opcionais podem ser desejáveis para um uso mais amplo do Bugzilla).

Após a instalação dos módulos, rode de novo o comando checksetup (conforme mostrado lá em cima) para verificar se ainda há pendências.
Se algum módulo ficar faltando, ou caso esteja instalado, contudo o comando informa que se trata de uma versão inferior à requerida, então é preciso fazer o resto da instalação "à mão", ou seja, com os comandos sugeridos. Neste momento, como você fez o máximo que pôde com os pacotes do Debian (pelo apt-get), então as chances de instalações ou atualizações manuais falharem são de fato muito pequenas. Vide a seção seguinte.


  • Instalando Manualmente os Módulos do Perl para o Bugzilla

Suponhamos que o procedimento da seção acima informa que dois módulos foram instalados corretamente pelo gerenciador apt-get mas não se encontram nas versões mínimas requeridas: Template-Toolkit e Email-MIME (comumente isto acontece em algumas versões do Ubuntu).
Felizmente, o Bugzilla também se preocupou com problemas inerentes a este cenário, e prontificou uma ferramenta que auxiliará a instalação das versões mais novas (ou ao menos as versões corretas e apropriadas) dos módulos em questão. O próprio comando "checksetup.pl" sugere como proceder!! Basta que se digite (em relação a estes dois módulos e estando ainda no diretório do Bugzilla):

/usr/bin/perl install-module.pl Template
/usr/bin/perl install-module.pl Email::MIME

Utilizei estes módulos como exemplo, pois é comum que isto aconteça com eles. Entretanto, o comando acima instalará qualquer módulo, se substituir o "Template" ou "Email::MIME" pelo nome do módulo desejado. Impera ressalvar que, em qualquer condição, só faça uso dessa ferramenta se e somente se a instalação dos módulos pelo seu gerenciador de pacotes (apt-get, aptitude, Synaptic, etc.) não for possível ou acabar instalando versões anteriores à necessária.
Agora, faça figa, cruze os dedos, e verifique novamente como estão os módulos com o mesmo famoso comando ensinado lá em cima:

./checksetup.pl --check-modules

Se estiver tudo branquinho, então esta etapa foi superada!! Parabéns e continue aí embaixo com a próxima etapa!!


  • Instalando os Módulos Opcionais do Perl para o Bugzilla

Esta seção não é rigorosamente necessária para continuar a instalação, mas pode ser necessária dependendo da funcionalidade do Bugzilla que você desejar usar. Se quiser, pule para a seção seguinte. Caso contrário, instale os módulos que você realmente precisa dentre as opções abaixo. Os módulos HTML-Parser e libwww-perl possivelmente já estarão instalados. Seguem os comandos para a instalação dos outros.

Módulos GD e Chart:
apt-get install libchart-perl

Módulos GDTextUtil e GDGraph:
apt-get install libgd-graph-perl

Módulo Template-GD:
apt-get install libtemplate-plugin-gd-perl

Módulo MIME-tools:
apt-get install libmime-tools-perl

Módulo XML-Twig:
apt-get install libxml-twig-perl

Módulo perl-ldap:
apt-get install libnet-ldap-perl

Módulo Authen-SASL:
apt-get install libauthen-sasl-perl

Módulo RadiusPerl:
apt-get install libauthen-radius-perl

Módulo SOAP-Lite:
apt-get install libsoap-lite-perl

Módulos JSON-RPC e JSON-XS:
apt-get install libjson-rpc-perl

Módulo Test-Taint:
apt-get install libtest-taint-perl

Módulo HTML-Scrubber:
apt-get install libhtml-scrubber-perl

Módulo TheSchwartz:
apt-get install libtheschwartz-perl

Módulo Daemon-Generic:
apt-get install libdaemon-generic-perl

Note que alguns módulos não estão, aparentemente, disponíveis via gerenciador de pacotes. Assim, como na seção anterior, caso um dos módulos não seja encontrado ou não esteja na versão requerida, ele pode ser instalado diretamente pelo comando "install-module.pl", conforme descrito acima.


  • Instalando o Módulo do Perl no Apache2

Se o seu Apache2 já roda programas escritos em Perl, então talvez este passo também não seja necessário. Caso contrário, você precisa do módulo de Perl para o Apache. Este módulo faz com que o Apache aprenda a repassar para o executor Perl o código escrito em arquivos solicitados. Sem o módulo, os arquivos de código Perl serão tratados como arquivos de texto puro e serão simplesmente listados na tela de seu navegador.
Verificando se você tem o módulo Perl do apache:

ls /etc/apache2/mods-available/
[deve aparecer o arquivo perl.load na listagem]

Verificando se o módulo está ativo:

ls /etc/apache2/mods-enabled/
[deve aparecer o arquivo perl.load na listagem]

Caso o arquivo mencionado não esteja lá, o módulo não está instalado.
Instalando o módulo Perl do Apache2:

apt-get install libapache2-mod-perl2

Agora o arquivo deve aparecer em ambos os diretórios. Não se esqueça de que, sempre que uma mudança como estas é feita, é preciso que se reinicie o Apache. Você pode deixar para fazer isto depois, quando terminar de configurá-lo para o Bugzilla. Porém, caso deseje testar o carregamento do módulo, digite:

service apache2 restart

Você pode rodar de novo o verificador "./checksetup.pl --check-modules" e observar a linha "mod_perl" para averiguar se a versão do módulo do Perl para o Apache é maior ou igual à requerida. Embora esta linha esteja entre os módulos opcionais, ela é imprescindível caso você pretenda usar o Apache como servidor web através do módulo citado.


  • Gerando Automaticamente o Arquivo localconfig

A instalação está quase no fim!! Agora o seu Bugzilla precisa, para rodar perfeitamente, de acesso ao banco de dados. Para tanto, o programa lê um arquivo de configuração denominado "localconfig". Se você procurar este arquivo (e tiver feito tudo conforme indiquei até aqui!), notará que ele não existe (ainda). Não se preocupe, ele é gerado automaticamente pelo mesmo programa "checksetup.pl", porém rodado agora sem o parâmetro "--check-modules". Portanto, execute:

./checksetup.pl

[Quase no final deve surgir esta mensagem:]
This version of Bugzilla contains some variables that you may want to change and adapt to your local settings. Please edit the file ./localconfig and rerun checksetup.pl.

Muito bem!! Seu arquivo foi gerado!! Mas ainda está com as opções padrões... precisamos configurar qual schema (database) e qual usuário de banco o Bugzilla usará.


  • Criando Usuário de Banco e Schema (Database)

Este é um bom momento para se criar um usuário do banco de dados para o Bugzilla (jamais, jamais, sob qualquer hipótese, use o usuário "root"!!!), como também o seu Schema (ou Database). Como este artigo recomenda o uso do MySQL, abaixo estão os comandos do MySQL para executar estas funções. Caso você esteja usando o Oracle ou o PostgreSQL, busque na documentação de seu banco a maneira apropriada de se realizar estas operações.

Criando um usuário no MySQL:

mysql -u root -p
[digite a senha do banco, definida na instalação do mesmo, lá em cima]

mysql> create user 'bugzilla'@'localhost' identified by 'password';
[password é a senha que você deseja colocar, bugzilla é o nome do usuário (de até 16 caracteres). Não use nada óbvio!!]

Criando um schema para o Bugzilla:

mysql> create database bugzilla character set = 'utf8';
["bugzilla" será o nome do schema. Use o nome que quiser]

Concedendo privilégios para o novo usuário sobre o novo schema:

mysql> grant all privileges on bugzilla.* to 'bugzilla'@'localhost';


  • Configurando o Arquivo localconfig

Edite o arquivo "localconfig", de forma a acrescentar os dados do banco de dados e permitir o acesso correto do Bugzilla ao mesmo.

vi localconfig

Configure as opções:

$webservergroup = 'www-data';
[ou o nome do grupo linux usado pelo seu Apache]

$db_driver = 'mysql';
[pode ainda ser "oracle" ou "Pg", conforme o caso]

$db_host = 'localhost';
[caso acesse o banco de outra máquina, coloque o endereço do host aqui]

$db_name = 'bugzilla';
[ou o nome do schema ou database que você escolheu]

$db_user = 'bugzilla';
[ou o nome do usuário do banco que você escolheu]

$db_pass = 'password';
[ou a senha do usuário do banco que você escolheu]

Possivelmente as outras opções podem ficar como estão. Para testar se está tudo certinho e finalmente criar todas as suas tabelas dentro do banco de dados, rode novamente o programa:

./checksetup.pl

Se tudo correr bem, você verá um monte de tabelas sendo criadas. Ao final, serão solicitados dados para o administrador do Bugzilla, a saber:

- e-mail do Administrador do Bugzilla;
- Nome (real) do Administrador do Bugzilla;
- Senha (segura, por favor!!) do Administrador do Bugzilla.

Parabéns, seu Buzilla está configurado!! Resta apenas ensinar o Apache a encontrá-lo, que é seu último e derradeiro passo!!
NOTA: Uma vez terminada a configuração total, você poderá, via interface web do Bugzilla, criar mais usuários, inclusive outros usuários com perfil de Administrador.


  • Configurando o Servidor Web para o Bugzilla

A equipe do Bugzilla recomenda que se use o Apache Web Server. Este tutorial tem indicado o Apache desde o início; portanto, será explanada apenas a configuração deste servidor web. Se você usa, por qualquer motivo, outro servidor web, busque em suas documentações as configurações equivalentes.

Rode a página de teste do Bugzilla:

http://[seu servidor]/[pasta virtual]/testagent.cgi
[troque "seu servidor" pelo endereço ou IP de seu servidor, e "pasta virtual" pelo diretório onde o Bugzilla foi instalado]
Exemplo:
http://localhost/bugzilla/testagent.cgi

Se aparecer somente o texto "OK", então provável é que esteja tudo funcionando. Se o código do arquivo CGI for listado na tela, então o Apache ainda precisa entender melhor o Bugzilla. Possivelmente é isto que irá acontecer.

Existem duas maneiras de se configurar o Apache para rodar o Bugzilla: via mod_cgi e via mod_perl. Neste tutorial vamos varrer o mod_cgi, por ser mais econômico na memória e mais flexível (suporta múltiplas instâncias no mesmo servidor).
Abra o arquivo de configuração de seu Apache (apache2.conf ou httpd.conf, dependendo de sua distribuição):
vi /etc/apache2/apache2.conf

Acrescente as linhas:

<Directory /var/www/bugzilla>
AddHandler cgi-script .cgi
Options +Indexes +ExecCGI
DirectoryIndex index.cgi
AllowOverride Limit FileInfo Indexes
</Directory>
[troque o "/var/www/bugzilla" pelo diretório correto onde o seu Bugzilla está instalado]

Reinicie o Apache Web Server (lembra que eu pedi que você esperasse por este momento bem lá em cima?? Pois é, agora chegou a hora!!):

service apache2 restart

 Rode o "checksetup.pl" para pequenos ajustes automáticos. Este programa pode ser rodado a qualquer momento que se fizer necessário, sem prejuízo algum:

./checksetup.pl

Acesse novamente a página de testes lá em cima, no início desta seção. Se tudo funcionou, ela vai listar apenas uma linha contendo o texto:


OK mod_cgi

Parabéns!! Seu Bugzilla está instalado e rodando!! Acesse-o pelo endereço:

http://[seu servidor]/[pasta virtual]/
Exemplo:
http://localhost/bugzilla/

Se preciso, dê um Ctrl+F5 (função refresh ou recarregar do navegador) na página para ela acordar. Deve aparecer uma tela chamada "Main Page" e dizendo, sorridente, "Welcome to Bugzilla"!!

Agora você vai desejar certamente descansar um pouco, tomar um café, ou um chá, ou um mate, comentar este artigo dizendo como ele te ajudou tanto (ehehe) e, enfim, começar a cadastrar seus projetos e os componentes internos dos mesmos. Para tanto, clique em "Login", digite o e-mail que você informou para o Administrador, a senha que foi igualmente informada, e siga as instruções da página que surgirá.


  • Conclusões

Este foi um artigo um tanto quanto extenso que procurou deixar de forma bem clara e simples todos os (muitos!) passo da instalação completa do Bugzilla. Embora os passos sejam numerosos e a quantidade de tecnologias utilizadas seja grande e diversificada, o Bugzilla é amigável e vem com programas internos que facilitam e automatizam muito todo o processo.
A documentação é muito clara, porém não está em português. Uma pendência na documentação, no entanto, é que, com o caráter generalista que lhe é de costume, ela deixa passar muitos comando que podem instalar mais seguramente módulos e bibliotecas, como os comandos que utilizam o gerenciador de pacotes do Debian, o apt-get.
Evidentemente, outras distribuições de Linux, com seus próprios sistemas de pacotes e seus gerenciadores, substituirão os comandos informados aqui por comandos bem semelhantes. Assim, espero, com este artigo, ter ajudado a aprimorar o processo de instalação do Bugzilla e colaborar com aqueles que precisam de uma instalação confiável, detalhista e segura, onde todos os passos são avaliados e explicados.
Se você realmente gostou, deixe seu comentário e experiência. Poderá estar, com isto, ajudando a muitos outros que nos visitam em busca de informações e ajuda.

10 comentários:

Clovis Rosa disse...

Olá Pajé!!!
Em primeiro lugar, gostaria de parabeniza-lo pela iniciativa que auxiliará e muito administradores de sistemas como eu que para atender a necessidade do ambiente precisam adquirir novos conhecimentos em diferentes tecnologias para melhoria de nossa produção.
Gostaria que vocês desenvolvessem uma continuação desse tutorial, qnto a configuração após instalação. Exemplo: tenho o serviço de e-mail corporativo do Google. Como faço para configura-lo para envio de e-mail??

Desde já agradeço a atenção!!

Abs!!!

O Pajé disse...

Olá Clovis,

Muito obrigado pelos parabéns!! Ficamos muito felizes ao obter retorno de nossos leitores, especialmente sabendo que pudemos ser úteis nas tarefas e desafios profissionais.
Gostei da sugestão e vou preparar um tutorial para iniciar os administradores nas configurações básicas do Bugzilla. Por ora, enquanto o tutorial não fica pronto, posso responder à sua pergunta: após instalado, entre no bugzilla e faça login como administrador (digitando o e-mail que foi fornecido durante a instalação e a senha). Daí clique na opção "Administration" e depois "Parameters". Vai surgir uma tela cheia de opções e com um longo menu à esquerda. Procure neste menu a opção "Email" e clique nela. Surgirá uma tela com opções auto-explicativas, fornecendo toda a configuração de e-mail necessária para seu bugzilla operar satisfatoriamente. Basta ler as opções e preencher com seus dados. Espero ter ajudado!!

nome da tela disse...

Bem legal ;) Parabéns. A simplicidade do bugzilla é uma arte.

O Pajé disse...

Beleza, rapaz!!
Obrigado pelo retorno!! Eu tb gosto muito do Bugzilla. Muito prático e eficiente.

Unknown disse...

Ola!! o post esta demais, mais nao sei oq eu fiz q nao consigo logar na pagina do BUGZILLA de jeito nenhum!!

alguma dica??
abs

O Pajé disse...

Eu precisaria de mais informações para entender o que realmente acontece. Você seguiu o tutorial todo?? Trocou o script de configuração?? Criou o banco de dados corretamente?? Ajustou o nome de usuário e grupo conforme indicado??
Mande mais informações e diga onde começou a dar errado para eu tentar ajudar...

Wilson R. Degressi Míccoli disse...
Este comentário foi removido pelo autor.
Wilson R. Degressi Míccoli disse...

Pajé, muito bom seu tutorial. Segui ele passo-a-passo. Consegui ir até o final, porém ele não carrega o Bugzilla depois da parte que diz respeito a fazer o Apache 'conversar' com o Perl e com o Bugzilla.

Antes de proceder esta atualização, a página de teste é exibida pra mim da seguinte maneira (conforme já previsto no seu tutorial):

#!/usr/bin/perl -wT
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

# This script is used by servertest.pl to confirm that cgi scripts
# are being run instead of shown. This script does not rely on database access
# or correct params.

use strict;
print "content-type:text/plain\n\n";
print "OK " . ($::ENV{MOD_PERL} || "mod_cgi") . "\n";
exit;

Depois da mudança, a página não é nem carregada. Apenas exibe o erro HTTP 500 no titulo da mesma.

Nos componentes do PERL tiveram apenas quatro que não consegui instalar... foram o DBD-Oracle (v1.19) que depende de uma instância do Oracle instalada (que creio não ser o meu caso, pois estou rodando ele em MySQL); Apache-SizeLimit (0.96); mod_headers (any) e mod_expires (any).

Saberia me dizer o que poderia ser este erro? Muito obrigado, abraços.

Anderson. Silva disse...

Ola parceiro, muito obrigado por ajudar as pessoas, e eu sou um desses hehe, porem o meu não há pacotes principais faltando e mesmo assim ele não roda os scripts no navegador, fui procurar o cgi.load na pasta e o mesmo não encontra-se lá. e o codigo não aparece.

O banco foi criado corretamente;
Ajustei o nome do usuário e grupo;

pode me da uma força?

Anônimo disse...

Good