Esta página é uma tradução automática da página em inglês, que é a versão de referência. Ler a página em inglês
Lista de verificação de produção
Siga esta lista antes de abrir o servidor para os usuários e para outros servidores, e de novo depois de qualquer mudança na implantação. Algumas configurações não podem ser alteradas depois que o servidor já federou, e alguns erros, como perder a chave de criptografia de chaves, não têm como ser desfeitos.
Cada item diz por que importa, como verificar e onde estão os detalhes. Comece pela parte automática:
my config check # the configuration, and the settings that do not suit productionmy config check -instance # also the instance settings in the databaseO que o my config check verifica
Seção intitulada “O que o my config check verifica”No perfil production (o padrão de profile), o my config check primeiro valida cada configuração e depois verifica se as configurações válidas são adequadas a uma instância de produção.
Os problemas são listados em dois grupos, sob um resumo no idioma da localidade do processo, cada um com o detalhe técnico em inglês:
- Erros fazem o
my config checkterminar com código 1. São configurações que quebram uma instância de produção ou enfraquecem a sua segurança:hostouaccount_domainque outros servidores não conseguem alcançar: com uma porta,localhost, um nome sem ponto ou um nome sob um domínio de topo reservado para uso local ou testes (.localhost,.local,.test,.example,.invalid,.internal,.home.arpa).web_origincomhttp.- Um
database_urldo SQLite que mantém o banco de dados na memória. - Um
kekque não é aleatório, como todos zeros ou um byte repetido. - Uma chave de site ou chave secreta do
captchaque é uma das chaves de teste publicadas pelos serviços de CAPTCHA. worker_job_types,worker_job_types_exceptou uma rota de fila que não nomeia nenhum tipo de job (em todos os perfis;my job typesos lista).- Com
-instance, umworker_job_concurrencyque o pool de conexões do banco de dados não consegue atender.
- Avisos mantêm o código de saída em 0. São configurações comuns em desenvolvimento e que podem ser deliberadas em produção:
mail = none.- Um banco de dados SQLite ou o armazenamento de blobs
fsem um diretório temporário (/tmp,/var/tmp,/dev/shmou$TMPDIR). queue = inline.- Nenhum
vapid_private_key. stream = huboukv = memorycom umrolediferente deall: elas funcionam apenas dentro de um processo.- Configurações de voz que provavelmente não foram pretendidas, como
voice = p2psem STUN ou TURN. - Um plugin em um endereço
http://, ou em um endereçohttps://sem token nem certificado de cliente. - Uma chave de modo de teste do provedor de pagamento.
origin_secretdefinido comtrusted_proxiesvazio, eorigin_secret_previousdeixado definido depois de uma rotação.- Com
-instance: os textos da instâncianame,short_description,termseprivacy_policy; as configurações da instânciacontact_account,contact_emailesecurity_contactquando não estão definidas; e um servidor sem regras. Quando não é possível alcançar o banco de dados, isso é mais um aviso, e o restante da verificação continua.
my serve registra os mesmos achados como avisos quando inicia, mas inicia mesmo assim.
O perfil development pula essas verificações; use-o para desenvolvimento local e testes, nunca para uma instância que outras pessoas usam.
Execute my config check no mesmo ambiente do servidor (as mesmas variáveis de ambiente, arquivos de segredo e arquivo de configuração),
por exemplo como um passo da implantação, antes que a nova versão receba tráfego.
Configurações que você não pode mudar depois
Seção intitulada “Configurações que você não pode mudar depois”O domínio do servidor e o domínio dos identificadores
Seção intitulada “O domínio do servidor e o domínio dos identificadores”- Por quê:
hostfaz parte de todo id do ActivityPub do servidor, e outros servidores armazenam esses ids.account_domainé o domínio dos identificadores (@alice@example.org). A primeira execução demy serveou de um comando demyque usa o banco de dados grava os dois nele, e a partir daímy servee esses comandos se recusam a rodar quando a configuração difere: uma mudança depois de federar quebra todo seguimento e toda referência às publicações e contas do servidor. Defina os dois antes da primeira inicialização. Um erro encontrado antes de federar é corrigido recriando o banco de dados, o que apaga todas as linhas. - Decida: se os identificadores usam o domínio do servidor ou um domínio separado (por exemplo, identificadores em
example.orge o servidor emsocial.example.org). Um domínio de identificadores separado precisa redirecionar o seu WebFinger, host-meta e NodeInfo para o servidor. - Verifique:
my config checkmostrahosteaccount_domaine informa um domínio que outros servidores não conseguem alcançar.my config check -instancetambém falha quando eles diferem dos valores no banco de dados, e não grava nada. Com um domínio de identificadores separado,curl -sI "https://<account_domain>/.well-known/webfinger?resource=acct:<user>@<account_domain>"responde301parahttps://<host>/.well-known/webfinger?.... - Detalhes: executando o servidor (os endpoints de federação e a entrega dos identificadores a partir de outro domínio),
hosteaccount_domain.
Acessível por https
Seção intitulada “Acessível por https”- Por quê: outros servidores buscam os ids em
https://<host>/na porta 443, e os navegadores enviam os cookies de login apenas porhttps. - Verifique:
curl -sI https://<host>/health/liveresponde200de fora da sua rede com um certificado válido parahost, emy config checknão relata nenhum erro sobreweb_origin,tls,tls_acme_agree_termsoutls_cert_file.curl -sI http://<host>/responde301parahttps://<host>/. Ou o proxy reverso, o balanceador de carga ou a CDN na frente do servidor termina o TLS e redireciona (com o Docker Compose, a camadacompose.caddy.yamlé esse proxy), ou o próprio servidor faz isso. Comtls = acme,my tls statusmostra um certificado parahost(e para o host deweb_originquando for diferente) cujo emissor não é de homologação:tls_acme_directorynão está definido ou nomeia um diretório de produção. Crie um alerta para a expiração dele e para pedidos com falha (alertas). Comtls = files,my config checkavisa quando restam menos de 14 dias no certificado, e o que quer que o renove precisa mantertls_cert_fileetls_key_fileatualizados. - Detalhes: executando o servidor, servindo HTTPS pelo servidor,
web_origin,tls.
Não acessível por trás da CDN
Seção intitulada “Não acessível por trás da CDN”- Por quê: com uma CDN na frente, e com o endereço próprio do servidor ainda público (
*.run.appno Cloud Run), qualquer pessoa pode chamar o servidor passando pelo WAF e pelo cache, e quem chama a partir da própria plataforma da CDN pode escolher o IP do cliente que os limites de requisições enxergam. Isso só é necessário nesse caso: não quando um firewall ou a plataforma já limita quem pode se conectar, e sem CDN não há o que contornar. - Verifique:
origin_secreteorigin_secret_headerestão definidos e a CDN define o cabeçalho em todos os nomes de host.curl -s -o /dev/null -w '%{http_code}\n' https://<origin address>/responde403, o/health/livedele responde200, ehttps://<host>/responde200. - Detalhes: Recuse requisições que não passaram pela CDN, incluindo como se recuperar quando isso bloqueia todo mundo.
Segredos
Seção intitulada “Segredos”A chave de criptografia de chaves (KEK)
Seção intitulada “A chave de criptografia de chaves (KEK)”- Por quê: a KEK criptografa as chaves privadas de todo ator. Sem ela o servidor não consegue assinar nada, e as chaves não podem ser recuperadas do banco de dados: cada conta teria de ser recriada e os outros servidores deixariam de confiar nele.
- Verifique:
- Ela foi gerada de forma aleatória (
openssl rand -base64 32);my config checkinforma uma chave que não é aleatória. - Ela é guardada em um lugar diferente do banco de dados e dos seus backups, por exemplo em um gerenciador de senhas ou no cofre de segredos da nuvem, e ao menos mais uma pessoa que executa o servidor consegue acessá-la.
- Ela chega ao servidor somente por
MY_KEKouMY_KEK_FILE(o arquivo de configuração recusa segredos). Com o Docker Compose, ela é o arquivosecrets/keke não fica no.env(arquivos do Docker Compose).
- Ela foi gerada de forma aleatória (
- Detalhes: gerenciamento de chaves.
A chave VAPID do Web Push
Seção intitulada “A chave VAPID do Web Push”- Por quê: sem ela o servidor não envia notificações Web Push. Mudá-la depois encerra todas as assinaturas, então gere-a uma vez e guarde-a como a KEK.
- Verifique:
my config checkavisa quandovapid_private_keynão está definida. Gere uma commy config vapid-key. - Detalhes: gerenciamento de chaves (a chave VAPID do Web Push).
Os demais segredos ficam fora do repositório e da imagem
Seção intitulada “Os demais segredos ficam fora do repositório e da imagem”- Por quê: um segredo em um repositório, em uma imagem de contêiner ou em um arquivo de configuração é copiado para todo lugar aonde eles vão.
- Verifique:
database_url,mail_smtp_password,captcha_secret_key, as chaves do provedor de pagamento,valkey_urle toda outra configuração marcada como segredo na referência de configuração vêm de variáveis de ambiente ou de arquivos<NAME>_FILEque o cofre de segredos da plataforma preenche (segredos do Docker ou do Kubernetes, Secret Manager, Parameter Store). O arquivo de configuração não pode conter esses valores:my config checkrecusa um segredo ali. Com o Docker Compose, eles vêm do.env, que só você pode ler (chmod 600). Pesquise no repositório e na imagem para ter certeza de que não sobrou nenhuma cópia dos valores.my config checkmostra(redacted)para cada segredo que estiver definido. - Detalhes: referência de configuração (a coluna Secret), CAPTCHA, Stripe, PAY.JP.
Configurações da instância
Seção intitulada “Configurações da instância”As configurações da instância ficam no banco de dados e podem ser alteradas enquanto o servidor roda, nas telas de administração do servidor
ou com my instance set. my config check -instance avisa sobre os textos, contatos e regras que não estão definidos.
- Nome, descrição curta e descrição: exibidos na página inicial, na página de informações (
/about), nas prévias de link e no NodeInfo. Verifique em/about. - Contatos:
contact_account(a conta a que os usuários recorrem sobre o servidor) econtact_email(o endereço para o qual usuários e outros servidores escrevem; os e-mails enviados pelo servidor também levam as respostas para ele). Verifique em/about. - Contato de vulnerabilidades:
security_contact, um URIhttps:oumailto:. Definido, o servidor responde em/.well-known/security.txt. Verifique comcurl -s https://<host>/.well-known/security.txt. - Termos de serviço e política de privacidade:
termseprivacy_policy. A política de privacidade deve citar os serviços que recebem dados pessoais, como o serviço de CAPTCHA e o provedor de e-mail. Verifique os links em/aboute na tela de cadastro. - Regras do servidor: o que os usuários aceitam ao se cadastrar e o que os moderadores fazem valer. Adicione-as com
my instance rule createou nas telas de administração, e verifique-as em/about. - Modo de cadastro:
registration_modeéapprovalaté que você o altere; escolhaopen,approval,inviteouclosedpara definir como as pessoas entram. Commail = none, os cadastrosopentambém aguardam a aprovação de um moderador. - Buscadores e IA:
search_indexing,ai_usageeindexable_defaultrecusam ambos até que você os permita. Verifique/robots.txte/.well-known/tdmrep.json. - Página de status: defina
status_page_url(uma configuração, não uma configuração da instância, para que o link apareça durante a manutenção) com uma página de status em um serviço separado do servidor.
Detalhes: configurações da instância, cadastro, buscadores e rastreadores de IA, CAPTCHA (o que escrever na política de privacidade), modelo de política de privacidade, modelo de registro de atividades de tratamento, monitoramento (a página de status).
- Por quê: o e-mail verifica endereços e envia redefinições de senha e notificações. Com
mail = none, nenhum e-mail chega aos usuários. - Verifique:
mailésmtp,sesouplugin, email_fromé um endereço de um domínio que você controla;my config checkavisa sobremail = none.- O domínio de
mail_fromtem registros SPF, DKIM e DMARC, e o provedor assina com DKIM. Sem eles, as mensagens caem no spam. - Cadastre-se com uma conta de teste e receba o e-mail de verificação; solicite uma redefinição de senha e receba também esse. Verifique os cabeçalhos da mensagem recebida para
spf=pass,dkim=passedmarc=pass. - Com o SES, a conta saiu do sandbox e as notificações de rejeição e reclamação chegam ao servidor.
- Detalhes: e-mail, cadastro (verificação por e-mail).
Administradores
Seção intitulada “Administradores”- Por quê: a conta de um administrador pode alterar qualquer configuração, ler dados privados e suspender qualquer pessoa.
- Verifique:
- Todo administrador ativou a autenticação em dois fatores (Configurações, Autenticação em dois fatores no cliente web) e guarda os códigos de recuperação.
- Apenas as pessoas que precisam dele têm o papel
admin; os moderadores têmmoderatorou um papel com apenas as permissões que usam. Liste-os commy admin rolee revise-os nas telas de administração.
- Detalhes: administradores e papéis, moderação (permissões e recuperação de login).
Operação
Seção intitulada “Operação”- Backups e recuperação: o banco de dados, o armazenamento de blobs (
blob_fs_dirou o bucket) e a KEK têm backup agendado, em um lugar separado do servidor, e uma restauração para um servidor novo foi ensaiada: o servidor restaurado inicia e as contas conseguem entrar e publicar. Um backup que nunca foi restaurado não se sabe se funciona. O banco de dados e a mídia não podem estar em um diretório temporário;my config checkavisa quando estão. Veja gerenciamento de chaves (backup da KEK) e banco de dados. - Monitoramento e alertas: um monitor externo verifica
/health/livee avisa alguém que possa agir, e os jobs mortos da fila de jobs são observados. Veja monitoramento e executando o servidor (verificações de saúde, métricas e a fila de jobs). - A imagem: a instância executa uma imagem lançada e fixada por digest (
ghcr.io/mycroblog/my:0.1.0@sha256:..., das notas da versão), e não uma que muda a cada reinício, e a sua proveniência foi verificada. Não existe taglatest. Uma atualização muda essa versão de propósito e segue Atualizando, uma versão menor de cada vez. - Código-fonte (AGPL-3.0): o servidor precisa oferecer o seu código-fonte a todos que o usam. Deixe
source_urlno padrão para uma versão lançada sem modificações; aponte-o para o seu próprio código-fonte quando executar um fork ou uma versão modificada. Verifique o link em/about. Veja executando o servidor (publicação do código-fonte). - Manutenção: saiba colocar o servidor em modo de manutenção antes de precisar dele. Veja manutenção.
Federação
Seção intitulada “Federação”- Por quê: outros servidores encontram contas por meio do WebFinger e do NodeInfo e depois buscam o ator. Se qualquer um deles falhar a partir de fora, o servidor fica invisível para o fediverso.
- Verifique a partir de uma máquina fora da sua rede:
curl -s "https://<account_domain>/.well-known/webfinger?resource=acct:<user>@<account_domain>"retorna a conta, seguindo o redirecionamento parahostquando os domínios diferem (curl -L).curl -s https://<host>/.well-known/nodeinfoaponta para/nodeinfo/2.1, que informa o software e o seu código-fonte.curl -s -H 'Accept: application/activity+json' https://<host>/@<user>redireciona para o id do ator, e o ator nesse id é JSON com umpublicKey.- A partir de uma conta no Mastodon ou em outro servidor, pesquise por
@<user>@<account_domain>, siga-a e veja uma nova publicação chegar. - Uma CDN na frente do servidor não faz cache de
/ap/*e/@*, a menos que respeiteVary: Accept.
- Detalhes: executando o servidor (os endpoints de federação), CDN, relays.
Para LLMs e agentes de programação:llms.txt,llms-full.txt, llms-small.txt