Exportando projetos

No Server Pro e no Community Edition 5.4.0, incluímos um script que permite aos administradores exportar todos os projetos dos usuários (incluindo os que ainda aparecem nas pastas Deleted e Trashed) para um diretório no disco.

O resultado da execução deste script é o mesmo que baixar manualmente um Zip de todos os projetos a partir do painel de projetos do usuário. O script descarrega todas as alterações pendentes antes de iniciar o download, para garantir que a exportação contenha a versão mais recente do projeto.

​

Limitações

O script de exportação tem as seguintes limitações:

• Nenhuma configuração do projeto, como o nome da imagem do TeX Live ou o compilador, é exportada. Elas devem ser definidas quando o projeto for enviado para a conta do usuário.
• Os projetos exportados não contêm nenhum histórico de versões.
• Nenhuma informação sobre colaboradores é preservada. Os projetos precisarão ser compartilhados novamente. Se o compartilhamento por link for usado, os links de visualização e edição serão gerados novamente (não serão os mesmos de antes).
• Comentários e informações de alterações rastreadas não serão exportados.
• O histórico de chat do projeto não será exportado.

Este script não foi projetado para substituir um backup completo do sistema. Para garantir que você consiga recuperar sua instância em um cenário de recuperação de desastres, recomendamos fortemente fazer um backup consistente.

​

Flags

Nome	Descrição
--help	Mostra a ajuda
--user-id	O ID do usuário (obrigatório, a menos que se use --export-all ou --project-id)
--project-id	Exporta um único projeto (não pode ser usado com --user-id ou --export-all)
--list	Lista os projetos do usuário (não pode ser usado com --output)
--output	Arquivo zip de saída (para operações de exportação individuais)
--export-all	Exporta os projetos de todos os usuários (requer --output-dir)
--output-dir	Diretório para armazenar os arquivos de exportação de todos os usuários
--log-level	Níveis de log suportados: trace|debug|info|warn|error|fatal

​

Uso

Use o seguinte comando para exportar os projetos de todos os usuários:

# Overleaf Toolkit users
$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/export-user-projects.mjs --export-all --output-dir=/var/lib/overleaf/data/exports"

# Legacy docker-compose.yml users
docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/export-user-projects.mjs --export-all --output-dir=/var/lib/overleaf/data/exports"

Se você estiver executando o Server Pro ou o Community Edition <= 3.5.13, precisará atualizar o exemplo acima para usar o script export-legacy-user-projects.js.

​

Conclusão

Quando a exportação for concluída, você poderá acessar os arquivos pelo diretório do host que está montado (bind-mount) em /var/lib/overleaf no seu arquivo docker-compose.yml, ou pela variável de ambiente OVERLEAF_DATA_PATH no arquivo config/overleaf.rc, se estiver usando o Toolkit.

Atualmente, o Overleaf permite nomes de projeto duplicados. Se um usuário tiver projetos com nomes duplicados, eles ainda serão adicionados ao Zip de exportação do usuário, mas, ao extrair, apenas uma versão estará presente. No Linux, unzip -B gravará os arquivos com o mesmo nome como arquivos de backup em vez de sobrescrevê-los.