Como configurar os tempos limite de inatividade para sessões de edição do Collabora

O Collabora Online possui várias configurações que parecem ser de "tempo limite de inatividade", mas controlam comportamentos diferentes. Se um editor escurecer ou parar de atualizar enquanto um usuário ainda estiver trabalhando, ajuste a configuração de inatividade por visualização. Se um documento permanecer carregado depois que todos saírem, ajuste o tempo limite por documento. Se o editor realmente se desconectar, verifique o tempo limite do WebSocket do proxy reverso antes de alterar a política de inatividade do Collabora.

O modelo de configuração atual do Collabora Online define um tempo limite de inatividade de 15 minutos por visualização, um tempo limite de 5 minutos quando a guia do navegador está fora de foco e um tempo limite de uma hora antes que um documento ocioso seja descarregado. Esses valores padrão podem variar de acordo com a versão e o pacote, portanto, verifique a configuração fornecida com a sua versão instalada antes de fazer alterações. Os valores abaixo referem-se ao modelo atual verificado para este guia e não são uma garantia para todas as implantações do CODE ou corporativas.

Escolha a configuração com base no comportamento desejado.

A Collabora documenta os significados e valores padrão em seu modelo de configuração coolwsd atual e na referência de configuração . Um tempo limite de inatividade por visualização não é o mesmo que fechar uma conta ou revogar o acesso: ele escurece a visualização e interrompe as atualizações. Um tempo limite por documento encerra um processo de documento ocioso; não é um temporizador que deve encerrar a sessão de uma pessoa que está editando ativamente.

Pontos de partida recomendados

• Evite que as abas ativas dos usuários escureçam muito cedo: aumente per_view.idle_timeout_secso intervalo padrão instalado para um valor mensurável, como 1.800 segundos (30 minutos). Este é um ponto de partida prático, não uma recomendação universal.
• Permita que os usuários alternem entre abas sem perder o foco no documento: aumente o tempo de espera per_view.out_of_focus_timeout_secsseparadamente. Não aumente o tempo de espera apenas porque os usuários estão inativos em uma aba selecionada.
• Reduza o uso de memória após o abandono de documentos: mantenha os valores por visualização e considere reduzi-los per_document.idle_timeout_secs, após confirmar que o documento está realmente ocioso e que os backups de armazenamento estão íntegros.
• Corrigir uma desconexão com tempo fixo: investigue o tempo limite do WebSocket no proxy, no servidor de entrada ou no balanceador de carga. Alterar a configuração de escurecimento por visualização não corrigirá um WebSocket que o proxy fecha.
• Mantenha os salvamentos frequentes: deixe os valores de salvamento ocioso e salvamento automático em suas configurações atuais, a menos que você tenha um motivo específico para alterá-los.

Altere as configurações em coolwsd.xml

Para uma instalação baseada em pacotes, localize o coolwsd.xmlarquivo ativo usado pelo serviço em execução. Locais comuns incluem `/etc/systemd/system` /etc/coolwsd/coolwsd.xml, mas os caminhos variam entre distribuições e versões antigas. Não presuma que editar um arquivo de exemplo ou uma cópia montada não utilizada altere o serviço em execução.

Faça backup do arquivo ativo e, em seguida, edite apenas os valores relevantes nas seções existentes <per_view>. <per_document>Por exemplo, este trecho define um tempo limite de 30 minutos para usuários inativos, um tempo limite de 15 minutos para abas em segundo plano e um descarregamento de documentos ociosos após duas horas:

<per_view>
    <idle_timeout_secs>1800</idle_timeout_secs>
    <out_of_focus_timeout_secs>900</out_of_focus_timeout_secs>
</per_view>
<per_document>
    <idle_timeout_secs>7200</idle_timeout_secs>
</per_document>

Este é um excerto, não uma configuração de substituição completa. Preserve os atributos, comentários, aninhamento e outros elementos do arquivo fornecido com a sua versão; algumas compilações esperam atributos XML adicionais. Se você quiser alterar o escurecimento apenas enquanto a guia estiver em foco, edite somente o valor de ociosidade por visualização. Aumentar os valores por visualização e o valor de descarregamento do documento simultaneamente dificulta a identificação da configuração que resolveu o problema.

Valide o XML usando as ferramentas de configuração compatíveis com sua implementação e, em seguida, reinicie ou recarregue o Collabora usando o método documentado para esse pacote. Observe os logs de inicialização em busca de erros de análise de configuração e confirme se o processo em execução carregou o arquivo correto. Uma alteração de configuração que não esteja presente no processo ativo não terá efeito.

Configure as mesmas opções no Docker ou no Kubernetes.

Na imagem Docker da Collabora, os administradores geralmente passam opções de configuração usando extra_paramsa --o:sintaxe de opção. O seguinte valor no estilo Compose ilustra o mesmo exemplo:

extra_params=--o:per_view.idle_timeout_secs=1800 --o:per_view.out_of_focus_timeout_secs=900 --o:per_document.idle_timeout_secs=7200

Use isso somente se sua imagem e gráfico de implantação forem compatíveis extra_params. Para Kubernetes, Helm ou uma instalação gerenciada pelo operador, insira as opções no campo de configuração compatível do gráfico ou recurso personalizado, em vez de editar um arquivo de contêiner gerado. Ao alterar variáveis ​​de ambiente no Compose, recrie ou reimplemente o serviço para que os novos valores cheguem ao contêiner; uma simples reinicialização pode reutilizar a configuração existente do contêiner.

Não defina a mesma opção em locais conflitantes, como em um arquivo XML montado e em um parâmetro de ambiente, sem verificar as regras de precedência para essa versão. Após a reimplementação, inspecione os logs de inicialização do contêiner e a configuração ativa. O repositório de código-fonte do projeto Collabora e a documentação de implantação correspondente à versão são as referências apropriadas quando os nomes das opções ou o comportamento do contêiner forem diferentes.

Verifique os tempos limite do proxy reverso separadamente.

O editor do Collabora usa WebSockets para comunicação contínua com o navegador. Um proxy pode fechar um WebSocket válido mesmo quando os tempos limite do documento e da visualização do Collabora estão configurados para valores muito maiores. Nesse caso, os usuários podem ver uma desconexão, uma solicitação de reconexão ou um editor que para de receber atualizações, em vez de uma simples visualização escurecida.

Compare o tempo limite de leitura/envio do proxy, o tempo limite de inatividade de qualquer entrada ou balanceador de carga na nuvem e o comportamento de sessão pretendido do Collabora. Os tempos limite devem ser compatíveis em toda a rota. O guia de configurações de proxy do Collabora inclui exemplos de configuração de proxy WebSocket e conexões de longa duração. Aplique as orientações apropriadas ao seu proxy e versão específicos; não copie um bloco antigo do Nginx indiscriminadamente para um proxy diferente ou uma rota não relacionada.

Uma pista útil é o padrão de falha. Se os usuários apenas virem a visualização inativa escurecer, examine o log per_view. Se todos os usuários se desconectarem aproximadamente no mesmo instante, inspecione os logs do proxy e do balanceador de carga nesse momento. Se um documento for fechado somente depois que todos os participantes saírem, o tempo limite por documento torna-se mais relevante.

Teste um tempo limite por vez.

1. Anote os valores atuais da configuração ativa e observe a versão do Collabora e o método de implantação.
2. Abra um documento de teste com dois usuários ou duas sessões de navegador para que você possa observar uma visualização ativa e uma inativa.
3. Altere apenas o tempo limite que corresponde ao sintoma. Por exemplo, para evitar o escurecimento em uma guia em foco, mas silenciosa, ajuste per_view.idle_timeout_secsapenas o tempo limite correspondente.
4. Reinicie ou reimplemente através do método compatível e, em seguida, confirme se o novo valor aparece na configuração ativa ou nos registros de inicialização.
5. Aguarde além do limite anterior. Confirme se a visualização ainda escurece, se o segundo usuário ainda recebe atualizações e se as edições continuam sendo salvas.
6. Feche todas as visualizações do documento de teste e observe se o documento ocioso é descarregado dentro do intervalo pretendido.
7. Verifique os registros do Collabora e do proxy em busca de fechamento de WebSocket, erros de análise XML, falhas de salvamento ou limpeza inesperada de processos.

Não teste a alteração em um documento de produção não salvo. Confirme se os arquivos modificados são salvos no servidor de armazenamento antes de permitir que um processo de documento ocioso seja concluído. Se o problema for percebido apenas com alterações não salvas, verifique os erros de salvamento automático e de armazenamento como um problema separado, em vez de aumentar o tempo limite a cada alteração.

Equilibrar conveniência, uso de recursos e confiabilidade.

Tempos limite mais longos por visualização são adequados para equipes que revisam documentos em intervalos ou trabalham com várias abas do navegador. Valores mais curtos podem fazer com que as visualizações inativas parem de atualizar mais cedo, o que pode reduzir a atividade em segundo plano, mas pode interromper um leitor que ainda está visualizando o documento. O tempo limite por documento é uma escolha de gerenciamento de recursos separada: aumentá-lo mantém os documentos não utilizados carregados por mais tempo, enquanto reduzi-lo pode exigir um novo carregamento quando o usuário retornar.

Para a maioria das implementações, altere o mínimo de configurações necessárias para corresponder ao comportamento observado. Mantenha os intervalos de salvamento, defina um tempo limite de inatividade razoável por visualização para a equipe, mantenha o tempo limite da guia em segundo plano intencional e ajuste os limites do proxy WebSocket somente quando os registros ou o tempo indicarem um problema na camada de conexão. Verifique novamente o modelo de configuração da versão instalada após as atualizações, pois os valores padrão e as configurações suportadas podem mudar.