Docker Compose

​

Visão geral

​

Requisitos do Sistema

• RAM: Certifique-se de que seu ambiente tenha pelo menos 2GB de RAM. Memória insuficiente pode causar falhas nos processos.
• Docker & Docker Compose: Certifique-se de que ambos estão instalados e atualizados.

​

Opção 1: Script de uma linha

bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/scripts/install.sh)

VERSION=vx.y.z BRANCH=branch-name bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/scripts/install.sh)

• Substitua x.y.z pelo número da versão desejada.
• Substitua branch-name pelo nome da branch que você deseja instalar.

​

Opção 2: Etapas manuais

​

Etapa 1: Configure o arquivo de ambiente

1. Crie o arquivo .env Copie o exemplo de arquivo de ambiente para um novo arquivo .env no seu diretório de trabalho:
   curl -o .env https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-docker/.env.example
   
2. Gere Tokens Secretos Execute o seguinte comando para gerar uma string aleatória única:
   openssl rand -base64 32
   
   Importante: Mantenha este valor em segredo / não o compartilhe.
3. Atualize o .env Substitua o valor do espaço reservado no seu arquivo .env pelo token gerado:
   APP_SECRET=first_random_string
   
4. Defina a Senha do Postgres Atualize o valor PG_DATABASE_PASSWORD no arquivo .env com uma senha forte sem caracteres especiais.
   PG_DATABASE_PASSWORD=my_strong_password
   

​

Etapa 2: Obtenha o arquivo Docker Compose

curl -o docker-compose.yml https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-docker/docker-compose.yml

​

Etapa 3: Inicie o Aplicativo

docker compose up -d

​

Etapa 4: Acesse o Aplicativo

curl http://localhost:3000

​

Configuração

​

Expor o Twenty para Acesso Externo

​

Compreendendo SERVER_URL

• Protocolo: Use http ou https dependendo da sua configuração.
  • Use http se você não configurou SSL.
  • Use https se você tiver SSL configurado.
• Domínio/IP: Este é o nome de domínio ou endereço IP onde seu aplicativo está acessível.
• Porta: Inclua o número da porta se você não estiver usando as portas padrão (80 para http, 443 para https).

​

Requisitos de SSL

​

Configurando SERVER_URL

1. Determine sua URL de Acesso
   • Sem Proxy Reverso (Acesso Direto): Se você estiver acessando o aplicativo diretamente sem um proxy reverso:
     SERVER_URL=http://your-domain-or-ip:3000
     
   • Com Proxy Reverso (Portas Padrão): Se você estiver usando um proxy reverso como Nginx ou Traefik e tiver SSL configurado:
     SERVER_URL=https://your-domain-or-ip
     
   • Com Proxy Reverso (Portas Customizadas): Se você estiver usando portas não-padrão:
     SERVER_URL=https://your-domain-or-ip:custom-port
     
2. Atualize o arquivo .env Abra seu arquivo .env e atualize o SERVER_URL:
   SERVER_URL=http(s)://your-domain-or-ip:your-port
   
   Exemplos:
   • Acesso direto sem SSL:
     SERVER_URL=http://123.45.67.89:3000
     
   • Acesso via domínio com SSL:
     SERVER_URL=https://mytwentyapp.com
     
3. Reinicie o Aplicativo Para que as alterações entrem em vigor, reinicie os contêineres Docker:
   docker compose down
   docker compose up -d
   

​

Considerações

• Configuração de Proxy Reverso: Certifique-se de que seu proxy reverso encaminha as solicitações para a porta interna correta (3000 por padrão). Configure a terminação SSL e quaisquer cabeçalhos necessários.
• Configurações de Firewall: Abra as portas necessárias no seu firewall para permitir acesso externo.
• Consistência: A SERVER_URL deve corresponder à forma como os usuários acessam seu aplicativo nos navegadores.

​

Persistência

• Volumes de Dados: A configuração do Docker Compose usa volumes para persistir dados para o banco de dados e armazenamento do servidor.
• Ambientes Sem Estado: Se estiver implantando em um ambiente sem estado (por exemplo, certos serviços de nuvem), configure armazenamento externo para persistir dados.

​

Backup e restauração

​

Crie um backup do banco de dados

docker exec twenty-postgres pg_dump -U postgres twenty > backup_$(date +%Y%m%d).sql

​

Automatize backups diários

0 2 * * * docker exec twenty-postgres pg_dump -U postgres twenty > /backups/twenty_$(date +\%Y\%m\%d).sql

​

Restaurar a partir de um backup

1. Pare o aplicativo:

docker compose stop twenty-server twenty-front

2. Restaure o banco de dados:

docker exec -i twenty-postgres psql -U postgres twenty < backup_20240115.sql

3. Reinicie os serviços:

docker compose up -d

​

Melhores práticas de backup

• Teste as restaurações regularmente — verifique se os backups realmente funcionam
• Armazene os backups fora das instalações — use armazenamento em nuvem (S3, GCS, etc.)
• Criptografe dados confidenciais — proteja os backups com criptografia
• Mantenha várias cópias — guarde backups diários, semanais e mensais

​

Resolução de Problemas