Backups e restauração

Instantâneos completos do servidor, incluindo canais, funções, permissões, emojis, adesivos, regras de automodificação, configurações do servidor, mensagens e funções de membros. Agende backups automáticos e restaure para qualquer servidor.

Visão geral

Os backups do Restore Hub capturam um instantâneo abrangente da estrutura e do conteúdo do seu servidor Discord. Diferentemente das exportações simples de listas de canais, o Restore Hub faz backup de tudo o que é necessário para recriar totalmente um servidor a partir do zero, incluindo substituições de permissões, regras de automodificação e histórico de mensagens (limitado por plano).

Os backups são armazenados com segurança na infraestrutura do Restore Hub e podem ser restaurados no mesmo servidor ou em um completamente diferente. Isso os torna valiosos para recuperação de desastres, migração de servidores e criação de modelos.

O que é armazenado em backup

Um backup do Restore Hub inclui os seguintes dados, capturados por meio da API REST do Discord no momento da criação do backup:

• Canais - Todos os tipos de canal: texto, voz, anúncio, fórum, palco e categorias. Inclui nome do canal, tópico, posição, sinalizador NSFW, limite de taxa (modo lento), taxa de bits (voz), limite de usuário (voz), duração padrão do arquivamento automático, tags disponíveis (fórum) e categoria principal.
• Funções - Todas as funções no servidor: nome, cor (hexadecimal), campo de bits de permissões, posição na hierarquia, bandeira de haste (exibida separadamente), bandeira mencionável e ícone de função (se houver).
• A permissão substitui - Substituições de permissão por função e membro por canal. Para cada canal, o backup armazena quais funções/membros têm substituições específicas de permissão de permitir/negar.
• Emojis - Todos os emojis personalizados: nome, bandeira animada e URL da CDN para recriação. Ao restaurar, os emojis são carregados novamente a partir do URL do CDN.
• Adesivos - Todos os adesivos personalizados: nome, descrição, tipo de formato (PNG/APNG/Lottie), tags e URL da imagem.
• Regras do Automod - Todas as regras do AutoMod: tipo de acionador, metadados do acionador (listas de palavras-chave, padrões de regex, predefinições), ações (bloqueio, alerta, tempo limite), funções isentas e canais isentos.
• Configurações do servidor - Nome do servidor, URL do ícone, URL do banner, URL do splash, descrição, nível de verificação, configuração de notificação padrão, filtro de conteúdo explícito, canal AFK, tempo limite AFK, canal do sistema e sinalizadores do canal do sistema.
• Mensagens - Mensagens recentes de canais de texto (limitado por plano). Cada mensagem armazena: conteúdo, informações do autor (ID, nome de usuário, avatar), incorporações, URLs de anexos, carimbo de data/hora e carimbo de data/hora de edição. As mensagens são capturadas em ordem cronológica inversa até o limite do plano por canal.
• Funções dos membros - Um mapeamento do ID de usuário do Discord para uma matriz de IDs de função. Isso registra quais membros tinham quais funções no momento do backup, permitindo a restauração da função durante uma operação de restauração.

Dica: os backups são instantâneos pontuais. Eles capturam o estado do servidor no momento exato em que o backup é executado. As alterações feitas após o backup não são incluídas.

Como criar um backup

1. No painel de controle - Navegue até seu servidor no painel de controle. Clique em "Backups" na barra lateral e, em seguida, em "Create Backup". O backup é enfileirado e processado em segundo plano pelo operador de backup. Você verá a atualização do status em tempo real.
2. Do Discord (Premium+) - Use o comando /backup em seu servidor Discord. O bot confirmará que o backup foi enfileirado e enviará uma mensagem de texto a você quando ele for concluído.
3. Por meio da API - Envie uma solicitação POST para /api/v1/servers/:id/backups. A resposta inclui o ID do backup e o status "queued" (enfileirado). Faça uma sondagem GET /api/v1/servers/:id/backups para verificar o progresso.

O trabalhador de backup é executado de forma assíncrona. Para um servidor grande com muitos canais e mensagens, um backup pode levar de alguns segundos a vários minutos. O worker obtém todos os dados da API REST do Discord, respeitando os limites de taxa.

Backups programados (Premium+)

Na versão Premium e superior, você pode agendar backups automáticos em intervalos regulares. O agendador é executado de forma independente e cria backups sem nenhuma intervenção manual.

configuração | Descrição | Padrão | Configuração | Descrição | Padrão
|---|---|---|
| Intervalo (dias) Com que frequência um backup é criado (por exemplo, a cada 1 dia, a cada 7 dias)
| Max backups | Número máximo de backups agendados a serem mantidos. Os mais antigos são podados automaticamente. | 5 |
| Active | Se o agendamento está sendo executado no momento | Yes |

Dica: A poda automática afeta apenas os backups programados. Os backups manuais nunca são excluídos automaticamente. Se você tiver 5 backups agendados e o máximo for 5, o backup agendado mais antigo será excluído quando um novo for criado.

Limites do plano

| Plano | Backups máximos | Mensagens por canal | Backups programados
|---|---|---|---|
| Grátis | 3 | 50 | Não |
| Premium | 10 | 200 | Sim |
| Business | 30 | 500 | Sim |
| Enterprise | 50 | 2.000 | Sim |

Aviso: O limite de mensagens é por canal, não por backup. Um backup no plano Free de um servidor com 20 canais de texto captura até 50 mensagens de cada canal (1.000 mensagens no total).

Como restaurar um backup

A restauração reconstrói a estrutura de um servidor a partir de um instantâneo de backup. Você pode restaurar para o mesmo servidor (para reverter alterações) ou para um servidor diferente (para clonar ou migrar).

1. Selecione o backup - No painel, vá para Backups e clique em "Restore" (Restaurar) no backup que você deseja restaurar. Ou use o comando /restore no Discord ou faça um POST para /api/v1/servers/:id/backups/:backupId/restore.
2. Escolha um servidor de destino - Por padrão, o backup é restaurado no mesmo servidor. Opcionalmente, você pode especificar um ID de servidor de destino diferente. O bot deve estar no servidor de destino com as permissões necessárias.
3. Escolha o que restaurar - Você pode restaurar seletivamente: canais (padrão ativado), funções (padrão ativado), substituições de permissão (padrão ativado), emojis (padrão desativado), configurações do servidor (padrão desativado) e funções de membro (padrão desativado).
4. Confirmar e executar - O trabalho de restauração é enfileirado e processado pelo trabalhador de backup. O Restore Hub cria primeiro as funções (para estabelecer a hierarquia), depois os canais com suas substituições de permissão, depois os emojis/adesivos e, por fim, as configurações do servidor.

Aviso: A restauração de canais EXCLUI todos os canais existentes no servidor de destino e os recria a partir do backup. Isso é destrutivo e não pode ser desfeito. A restauração das funções de membro só funciona para os membros que estão atualmente no servidor.

Como a restauração lida com IDs de função

Quando um backup é criado, os IDs de função são capturados conforme existem naquele momento. Ao restaurar em um servidor diferente, esses IDs de função não existem. O Restore Hub lida com isso criando novas funções com o mesmo nome, cor e permissões e, em seguida, mapeando internamente os IDs de função antigos para os novos IDs de função.

Esse mapeamento de ID de função é usado para: substituições de permissão (as permissões de canal fazem referência a funções por ID), restauração de função de membro (reatribuição de funções a membros) e substituições de permissão em nível de canal.

Uso de backups em diferentes servidores

Os backups não são bloqueados no servidor em que foram criados. Você pode restaurar qualquer backup em qualquer servidor em que seu bot tenha as permissões necessárias. Casos de uso comuns:

• Modelos de servidor - Crie um backup de um servidor perfeitamente configurado e restaure-o em novos servidores como ponto de partida.
• Migração - Faça backup de seu servidor antigo, crie um novo e restaure toda a estrutura.
• Recuperação de desastres - Se seu servidor for destruído ou comprometido, restaure a partir do backup mais recente.
• Testes - Restaurar em um servidor de teste para experimentar as alterações sem afetar o servidor ativo.

O trabalhador de backup

Os backups e as restaurações são executados de forma assíncrona por meio de um trabalhador em segundo plano (fila de trabalhos do BullMQ). Quando você cria um backup ou uma restauração, um trabalho é adicionado à fila. O trabalhador pega o trabalho, processa-o (obtendo dados do Discord ou criando recursos) e atualiza o registro de backup no banco de dados.

O worker respeita os limites de taxa da API REST do Discord. Para servidores grandes, o worker pode levar vários minutos para ser concluído. Você pode monitorar o progresso por meio do painel, que pesquisa atualizações de status.