SquidCacheAux para BrazilFW ÍNDICE Índice Pág. 1 O que é o SquidCacheAux Pág. 2 SquidCacheAux e a inicialização do sistema Pág. 2 SquidCacheAux e a finalização do sistema Pág. 2 Tela principal do SquidCacheaux Pág. 3 Utilização do SquidCacheAux Configurações Pág. 4 Utilização do SquidCacheAux Gerenciando Plugins Pág. 5 O que é um Plugin do/no SquidCacheAux Pág. 5 Ativar/Desativar/Excluir um Plugin Pág. 5 Criar um novo Plugin Pág. 6 Utilização do SquidCacheAux Recarregar o SquidCacheAux Pág. 7 Utilização do SquidCacheAux Listar arquivos cacheados pelo SquidCacheAux Pág. 7 Utilização do SquidCacheAux Visualizar log dos arquivos cacheados Pág. 8 Entendendo o log Pág. 8 Utilização do SquidCacheAux Zerar cache (somente atualizações) Pág. 9 Utilização do SquidCacheAux Zerar Log Pág. 9 SquidCacheAux para BrazilFW Página 1
O que é o SquidCacheAux O SquidCacheAux é utilitário para o BrazilFW cuja função é auxiliar o Squid com cache de de conteúdos dinâmicos. O SquidCacheAux foi criado com base em scripts Perl de projetos já existentes (vide Addon Index em www.brazilfw.com.br). - SquidCacheAux e a inicialização do sistema Quando o BrazilFW é carregado, um script se encarrega de confirmar as configurações para o SquidCacheAux, bem como todas as dependências. Caso não seja encontrado algum dos componentes necessários para o funcionamento correto do SquidCacheAux, esse script é finalizado e não carrega o SquidCacheAux. Quando o SquidCacheAux é instalado no BrazilFW ainda não há configurações para ele no sistema. O script de inicialização encarrega-se de preencher as configurações necessárias (variáveis no Arquivo Mestre de configuração, configurações no squid.conf) com um valor padrão, para que o SquidCacheAux seja carregado corretamente logo após a instalação. No carregamento do sistema, mesmo após configurar-se o SquidCacheAux, serão exibidas mensagens de Falha! com relação ao suporte Perl no Lighttpd (caso esse seja encontrado no sistema) e com relação a configurações no squid.conf. Isso é normal (será explicado no próximo tópico/capítulo). Não é preciso preencher nenhuma variável em nenhum arquivo do sistema, bem como inserir configurações no squid.conf. Tais tarefas são executadas pelo script de inicialização do SquidCacheAux. Quem utilizar o Squid com a criação automática do squid.conf habilitada, deverá, após dar um reload no Squid, efetuar também um reload no SquidCacheAux. - SquidCacheAux e a finalização do sistema Quando o BrazilFW é desligado ou reiniciado, é executado um script para o desligamento correto do SquidCacheAux. Esse script encarrega-se de remover as configurações inseridas no squid.conf, o suporte a Perl do Lighttpd (caso seja encontrado no sistema) e o agendamento no Cron. Essas tarefas são executadas pois, caso o usuário remova o SquidCacheAux ou o Perl, o sistema e seus utilitários (Squid e Lighttpd) funcionarão normalmente (se as configurações do SquidCacheAux permanecerem no squid.conf, e o SquidCacheAux for removido, o Squid não funcionará). SquidCacheAux para BrazilFW Página 2
- Tela principal do SquidCacheaux Na figura abaixo (figura 01) veremos a tela principal do SquidCacheAux (todos os links são auto-explicativos, porém, mais a frente veremos a função, detalhadamente, de cada um): Figura 01 Tela Principal do SquidCacheAux SquidCacheAux para BrazilFW Página 3
- Utilização do SquidCacheAux Configurações Ao clicarmos no link Configurações do SquidCacheAux, será carregada a tela para configurarmos os parâmetros para o funcionamento do SquidCacheAux. Uma vez na tela de configuração, basta ler o resumo abaixo de cada opção para conhecer a função de tal opção. A tela de configuração do SquidCacheAux é exibida na figura 02 (abaixo): Figura 01 Tela de Configurações do SquidCacheAux Uma vez configuradas as opções conforme suas necessidades, basta clicar no botão Enviar para que as configurações sejam inseridas ao BrazilFW (Arquivo Mestre de Configuração). Quando clicamos no botão Enviar, somos direcionados a outra tela, a qual contém dois link s: Aplicar Configurações : Recarrega o SquidCacheAux com as configurações recém configuradas pelo usuário. Não esqueça de gravar sua configuração antes de reinicializar! : Executa a rotina de backup do BrazilFW (essencial para que as mesmas configurações sejam aplicadas após reinicializar o sistema). Caso seja alterada alguma configuração é necessário realizar o backup antes de reinicializar o sistema. Em caso de alterações na configuração é recomendado reinicializar o sistema. SquidCacheAux para BrazilFW Página 4
- Utilização do SquidCacheAux Gerenciando Plugins Ao clicarmos no link Gerenciar Plugin (tela principal do SquidCacheAux), será carregada a tela de gerência dos plugins do SquidCacheAux. O que é um Plugin do/ no SquidCacheAux : Plugin (no SquidCacheAux) é complemento para o SquidCacheAux (é uma configuração personalizada, feita pelo usuário para que o SquidCacheAux faça cache do conteúdo do domínio especificado pelo usuário). Os plugins utilizados no SquidCacheAux podem ser editados, bem como, pode-se criar novos plugins. O SquidCacheAux já vem por padrão com 19 plugins configurados, os quais podem ser editados, ativados, desativados ou excluídos, conforme vontade do usuário. Ativar/ Desativar/ Excluir um Plugin: A tela de Gerência de Plugins no SquidCacheAux (figura 03) conta com uma listagem de plugins. Essa listagem é exibida em uma tabela, a qual possui a coluna Ações onde encontramos as opções Ativar/Desativar, Editar e Excluir, sendo exibidas ao lado de cada linha da tabela. Para executar as funções, basta clicar no link da ação desejada, na coluna Ações, na linha correspondente ao Plugin em que deseja-se aplicar a ação. Listagem de plugins configurados no SquidCacheAux. Ações para gerência dos plugins configurados no SquidCacheAux Link Retornar à lista Ao clicar-se nesse link, é carregada a tela principal do SquidCacheAux. Link Criar novo plugin Ao clicar se nesse link, é carregada a tela para criação de um novo plugin. Figura 03 Tela de Gerência de Plugins do SquidCacheAux SquidCacheAux para BrazilFW Página 5
Criar um novo Plugin: Ao clicar-se no link Criar novo plugin (tela de gerência de plugins vide Figura 03), é carregada a tela para cadastro/criação de um novo plugin. Na figura abaixo (figura 04) veremos a tela citada com destaques contendo explicações para cada campo a ser preenchido para criação do plugin. Nome para o Plugin Aqui você digita um nome para o plugin que está criando. Esse nome não deve conter espaços em branco. Ativar o Plugin? Aqui você especifica se o plugin estará ativo ou não. Esse link aponta para o Tutorial que você está lendo Tipo de Acesso Aqui você deve selecionar se o domínio é acessado por HTTP ou FTP. Extensões Aqui você declara as extensões dos arquivos que o domínio contém e que você deseja fazer o cache. Deve-se ficar atento, pois, caso seja mais de uma extensão, elas devem ser separadas por uma vírgula (,). Em caso de dúvidas, basta basear-se em um dos plugins já configurados. Botões Confirmar, Limpar e Cancelar São auto-explicativos. URL Aqui você especifica o domínio para o qual está sendo criado o plugin. Existem duas formas de declarar a URL aqui, sendo: Quando você sabe exatamente qual é o domínio: Exemplo:.brazilfw.com.br Nesse formato é declarado o ponto (.) no início da URL. Assim será feito o cache de qualquer_coisa.brazilfw.com.br. Quando você não tem certeza sobre o domínio: Nesse caso, não incluo aquele ponto (.) no inínio da URL, ficando assim: Exemplo: brazilfw.com.br Existem Plugins já configurados no SquidCacheAux. Em caso de dúvidas, basta basear-se em um dos plugins já configurados. Figura 04 Tela de cadastro/criação de plugins do SquidCacheAux SquidCacheAux para BrazilFW Página 6
- Utilização do SquidCacheAux Recarregar o SquidCacheAux Ao clicarmos no link Recarregar o SquidCacheAux, será exibida uma tela mostrando os passos de recarga do SquidCacheAux. Esse link executa uma instrução que carrega e executa os scripts de desligamento e inicialização do SquidCacheAux. A tela de recarga do SquidCacheAux é exibida na figura abaixo (figura 05): Figura 05 Tela de recarga do SquidCacheAux - Utilização do SquidCacheAux Listar arquivos cacheados pelo SquidCacheAux Exibe uma listagem com os arquivos cacheados pelo SquidCacheaux (somente atualizações). Independente do idioma que é configurado no sistema (e conseqüentemente no SquidCacheAux), a listagem de arquivo encontra-se em inglês. SquidCacheAux para BrazilFW Página 7
- Utilização do SquidCacheAux Visualizar log dos arquivos cacheados Exibe o arquivo de Log do SquidCacheAux. Caso a limpeza de log esteja habilitada e a ação da limpeza de log seja Rotate, será exibido o arquivo de log atual. Entendendo o log No log do SquidCacheAux são encontradas informações referentes aos arquivos baixados, sendo baixados, corrigidos, atualizados, limpeza e verificação do cachê e limpeza e verificação do próprio log. Abaixo veremos algumas mensagens que podem aparecer no log e sua interpretação: Mensagem IP UpdateHit Path/arquivo Linking path/arquivo path/arquivo remove stale path/arquivo download. path/arquivo exists Downloaded path/arquivo Cache size checked. Cache size is tamanho Cache cleaned Log rotate Log size checked. Log size is tamanho Log cleaned O que significa Significa que o tal ip requisitou um arquivo já contido no cache A checagem diária do cache efetuou correção/atualização no arquivo já contido no cachê A checagem diário do cachê excluiu um arquivo obsoleto Alguma estação requisitou um arquivo e este já está sendo baixado pelo SquidCacheAux Arquivo baixado pelo SquidCacheAux e disponível no cachê A checagem diária do cache tentou efetuar a limpeza do cache, porém, o cachê não atingiu o seu limite ainda Cache foi zerado Foi efetuada limpeza do Log e a ação configurada para limpeza do Log é Rotate A checagem diária do cache efetuou a limpeza do Log, porém, este ainda não atingiu o seu limite Foi efetuada limpeza do Log e a ação configurada para limpeza do Log é Apagar Essas são as principais mensagens exibidas no Log. Em caso de dúvidas, reportar no fórum do BrazilFW ( www.brazilfw.com.br ). SquidCacheAux para BrazilFW Página 8
- Utilização do SquidCacheAux Zerar cache (somente atualizações) Ao clicar nesse link, o cache do SquidCacheAux será apagado. Uma vez zerado o cachê não haverá como recuperá-lo. As atualizações terão de ser baixadas novamente pelo SquidCacheAux. Ao clicar nesse link, o Log será zerado. - Utilização do SquidCacheAux Zerar Log Essa tarefa basea-se na configuração da ação para a limpeza do Log. Sendo assim o log pode ser zerado ou rotacionado. Amigos, espero ter ajudado com esse pequeno Tutorial. Qualquer dúvida, por favor, postar em www.brazilfw.com.br (provavelmente existirá o tópico sobre o SquidCacheAux em Addon-Factory). SquidCacheAux para BrazilFW Página 9