?> TODO This page is partially in Brazilian Portuguese. If you can, please help us translate it completely to English.
This page gathers tips and configuration guidelines to your server in order to optimize Tainacan performance.
Some of the things listed here can be performed directly in tha WordPress admin panel, while others might need you to edit some configuration files and have access to your server configuration. It might also be needed some knowledge on server administration.
Taincan has a System Check page that gives you important information on your installation:
- Access the WordPress admin panel;
- In the left menu, pass the mouse over Tainacan;
- Select the subitem System Check;
This screen gives you the following information:
- WordPress version: Gives you the current WordPress version compared to the latest version
- PHP version: Gives you the version of the PHP installed on your server
- Database version: Gives you the version of the database server installed on your server
- PHP modules: Gives you information about required and recommended PHP modules installed on your server
- Maximum exection time of PHP scripts: Gives you the current value for the Maximum exection time of PHP scripts
- Permalinks structure: Informs you if your permalink strucutre is configured correctly
- Uploads folder: Informs you if the permission to write in your uploads folder is configured correctly
- Upload limit: Gives you the maximum file size an user can upload, as it is configured in your server
- Cron: Informs you about cron jobs configuration
Results have a small icon (▇) at the left indicating:
- ▇ - Incorrect configuration, Tainacan may not work;
- ▇ - Partially correct configuration, some functions might not work
- ▇ - Correct!
Imagick module is used to extract the first page from a PDF file and automatically generate a thumbnail for the item. If it is not present, System check will throw a warning.
However, due to recent changes in Imagick package, it may come pre-configured in a way it does not have the rights to open and read PDF files.
In order to solve this you must do the following.
In file /etc/ImageMagick-6/policy.xml (or /etc/ImageMagick/policy.xml) find the following line
<policy domain="coder" rights="none" pattern="PDF" />
and change it to allow reading and writing by the PDF coder in ImageMagick:
<policy domain="coder" rights="read|write" pattern="PDF" />
Finally, don't forget to restart your web server.
Se a sua listagem de itens estiver lenta, especialmente na visão “tabela”, reduza o número de metadados exibidos por padrão na listagem. Quanto menos metadados forem exibidos na listagem, mais rápida ela será.
Para fazer isso, acesse a página de configuração dos metadados de sua coleção, edite os metadados, procure a opção “Exibir na listagem” e marque “não exibir por padrão”. Esta opção ainda permitirá que os usuários escolham visualizar este metadado na listagem, se quiserem, mas removerá ele da listagem por padrão, acelerando o carregamento para os visitantes.
Por padrão, o Tainacan tem um limite de 96 itens por página em qualquer listagem ou requisição à API. Faça alguns testes e verifique se esse número é adequado para o seu servidor.
Caso este número seja muito alto e as requisições forem muito lentas, você pode diminuí-lo para garantir uma boa experiência de uso.
Da mesma forma, caso seu servidor seja mais potente, você pode aumentar esse número e oferecer listagens mais completas. Isto é especialmente útil para os links que são gerados para visitantes acessarem a coleção em outros formatos, como CSV. Quanto maior o número de itens por páginas, menos páginas eles terão que acessar para recuperar todos os itens de uma coleção.
Para mudar essa configuração, adicione a seguinte linha no seu arquivo wp-config.php:
define(‘TAINACAN_API_MAX_ITEMS_PER_PAGE’, 96);Substituindo 96 pelo número de sua preferência.
Para coleções pequenas, as configurações padrão do tainacan devem funcionar bem e a busca geral por palavras chave pode ser eficiente. No entanto, para coleções um pouco maiores, esta busca, que procura por um termo em todos os metadados de um item, pode ser bastante ineficiente.
Para este gargalo há uma solução ideal e uma paliativa.
A solução ideal é integrar o WordPress a um servidor de buscas, chamado Elastic Search. A instalação e configuração do Elastic Search está fora do escopo, pelo menos por enquanto, desta documentação, mas, uma vez que você tenha um servidor desses rodando, basta instalar o plugin ElasticPress. (Esta integração ainda está em fase experimental mas com excelentes resultados. Assim que estiver mais madura escreveremos uma documentação específica. Enquanto isso, seria muito bom receber relatos das tentativas).
A solução paliativa é restringir a busca ao funcionamento padrão do WordPress, que procura os termos apenas no título e descrição dos itens. Apesar de muito menos abrangente, ela é muito mais rápida.
Para fazer isso, adicione a seguinte linha no seu arquivo wp-config.php:
define('TAINACAN_DISABLE_DEFAULT_SEARCH_ENGINE', true);Mais informações na documentação para desenvolvedores da engine de busca.
Por padrão, os valores carregados para as facetas irão sempre considerar a busca atual que você está fazendo. Isso significa que, a medida que filtros forem selecionados, as facetas serão recarregadas e trarão apenas os valores que ainda irão trazer itens nos resultados. Dessa maneira, a medida em que o usuário vai fazendo filtros, as opções nas facetas vão reduzindo, criando um “funil” de busca.
Caso este comportamento não seja adequado para você, é possível configurar o tainacan para sempre exibir todos os valores possíveis em uma faceta, desconsiderando a busca atual. (em alguns casos, isto também pode melhorar a performance).
Para fazer isso, adicione a seguinte linha no seu arquivo wp-config.php:
define('TAINACAN_FACETS_DISABLE_FILTER_ITEMS', true); Muitas facetas, ou filtros, também podem piorar a experiência de uso de seu site dependendo do tamanho da sua coleção e da capacidade do seu servidor.
Se o carregamento das suas facetas estiver lento, o mais adequado é olhar as orientações da seção “Ajustes nas configurações do servidor” desta página.
Caso você não tenha acesso ou condições de modificar as configurações do servidor, aqui vão algumas alternativas:
- Considere diminuir o número de facetas, mantendo apenas as essenciais. Caso algumas facetas sejam essenciais para o trabalho de gestão, mas dispensáveis para a navegação do público em geral, marque estas como “visível apenas por editores”. Desta maneira, você irá melhorar a experiência do seu visitante.
- Desative a contagem de itens por faceta. Para fazer isso, adicione a seguinte linha no seu arquivo
wp-config.php:
define('TAINACAN_FACETS_DISABLE_COUNT_ITEMS', true);Mais informações sobre facetas na documentação para desenvolvedores da busca facetada.
Os ajustes presentes nesta seção dizem respeito a configuração do seu servidor Apache. O modo de acesso e a forma de fazer estas configurações podem variar bastante dependendo do servidor ou serviço de hospedagem utilizado. Em alguns serviços de hospedagem, possivelmente você não terá acesso a todas essas opções.
Para saber exatamente como fazer cada uma dessas configurações, consulte a documentação do servidor utilizado, o administrador de sistemas responsável ou o suporte técnico de sua hospedagem. As diretivas recomendadas aqui tomam como base um servidor com as seguintes configurações:
- Processador: Intel(R) Xeon(R) CPU E5-2609 0 @ 2.40GHz, 4 cores;
- Sistema operacional: Ubuntu Linux 16.04.1;
- Memória real e virtual: 16 GB e 2 GB;
- Kernel e CPU: Linux 4.4.0-72-generic on x86_64
- Versão do Apache: 2.4
Por padrão, grande parte dos servidores está configurado com um timeout de 30 segundos. Isso significa que qualquer requisição que demore mais do que 30 segundos para concluir será cancelada.
No geral, este tempo é suficiente, porém ele pode ser um gargalo em algumas operações específicas, como algumas de exportação e importação e de edição em massa de itens.
Por segurança, aumente este valor para algo em torno de 200 a 300 segundos.
Esta diretiva se definida como on, permite conexões persistentes ao apache. Para um melhor desempenho, é recomendado definir esta opção como on e permitir que mais de uma solicitação por conexão.
MaxKeepAliveRequests: Esta diretiva é usada para definir o número de solicitações permitido por conexão quando a opção KeepAlive acima é definido como on. Defina esta opção como 0 para indicar um número ilimitado.
KeepAliveTimeout: Esta diretiva é usada para definir quanto tempo, em segundos, o apache irá esperar por um posterior pedido antes de fechar a conexão. O valor 10 é uma boa média a ser utilizada.
Em algumas páginas do Tainacan, especialmente na listagem de itens, são realizadas muitas requisições simultâneas ao servidor. Para melhorar o desempenho nessas situações, é recomendável que você configure o módulo MPM Prefork do servidor Apache.
Para a conceitualização de cada diretiva de configuração apresentada abaixo recomenda-se a leitura do artigo 1 que explica todos os aspectos envolidos e para a determinação da configuração mais adequada para o seu ambiente recomenda-se a leitura do artigo 2 que traz uma abordagem simples e objetiva para a determinação dessas configurações.
Segue abaixo as configurações recomendadas que devem ser realizadas no arquivo /etc/apache2/mods-availave/mpm_prefork.conf:
- StartServers: definir o valor para
4. - MaxClients: definir o valor para
256. - MinSpareServers: definir o valor para
15. - MaxSpareServer: definir o valor para
30. - MaxRequestsPerChild: definir o valor para
5. - MaxRequestWorkers: definir o valor para
250.
Realizadas tais configurações outro aspecto importante é blindar a instalação Wordpress na qual o plugin e tema do Tainacan serão executados. A próxima seção trata desse aspecto.
O primeiro passo é configurar as permissões dos arquivos e diretórios da instalação corretamente. Isso pode feito por meio dos seguintes comandos que:
Para diretórios:
find /caminho/para/a/pasta/do/wordpress/ -type d -exec chmod 755 {} \;Para arquivos:
find /caminho/para/a/pasta/do/wordpress/ -type f -exec chmod 644 {} \;Uma outra medida de proteção que pode ser adicionada nas partes onde os scripts geralmente não devem ser acessados por nenhum usuário. Uma forma de fazer isso é usar mod_rewrite para bloquear os scripts no arquivo .htaccess.
RewriteEngine On
RewriteBase /
RewriteRule ^wp-admin/includes/ - [F,L]
RewriteRule !^wp-includes/ - [S=3]
RewriteRule ^wp-includes/[^/]+\.php$ - [F,L]
RewriteRule ^wp-includes/js/tinymce/langs/.+\.php - [F,L]
RewriteRule ^wp-includes/theme-compat/ - [F,L]
O bloqueio do acesso ao arquivo wp-config.php por meio do .htaccess é outra medida interessante. Para isso basta inserir o seguinte código no arquivo .htaccess da instalação Wordpress:
<files wp-config.php>
order allow,deny
deny from all
</files>Desabilitar a listagem de arquivos e o acesso direto a arquivos .php no diretório de uploads. Isso pode ser feito pela inclusão de um arquivo .htaccess dentro do diretório /wp-content/uploads da instalação Wordpress com o seguinte conteúdo:
Options -Indexes
<Files *.php>
Require all denied
</Files>Fechando as recomendações de segurança recomenda-se a instalação, ativação e configuração do plugin Wordfence que possui uma gama de recursos que objetivam proteger a instalação Wordpress do mais diversos tipos de ataques e exploração de vulnerabildades.
O plugin e a sua documentação podem ser acessados aqui.
There are many WordPress plugins to add caching for your site. This is a good approach and could speed up page load time for your visitors.
There is one thing you have to pay attention when configuring cache in your Tainacan site, though.
Tainacan uses nonces, which a is a security procedure to verify users intention to perform some actions. These nonces are codes generated to users that last for a shor period of time and then are regenerated.
In order to make cache plugins work fine, you must set your cache lifetime for no longer than 12 hours, which is how long the nonce codes last. If your cache lives longer, your user may access the website using an expired code and have permission issues.
If you want to better understand this issue, check this articles.