Para administradores
← Todos os tópicos

Instalação passo a passo

O guia completo: baixar e verificar o pacote, ./draften install, HTTPS, a licença, os e-mails e a proteção do servidor.

O procedimento inteiro, de um servidor vazio até uma operação segura: download do pacote, instalação, HTTPS, primeiro login, configuração e proteção do servidor. O que o servidor precisa atender está no artigo Ambiente compatível; do que uma instalação é feita está descrito em Instalação no seu próprio servidor.

Antes de começar

Tenha em mãos:

Passo 1: Prepare o servidor

Instale o Docker Engine com o plugin compose. No Ubuntu, pelo repositório oficial do Docker:

sudo apt-get update
sudo apt-get install -y ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin

Em outras distribuições, siga https://docs.docker.com/engine/install/. O pacote docker.io dos repositórios da distribuição costuma ser antigo e não tem o plugin compose.

Confira as versões – o Docker precisa ser 24 ou mais recente e o docker compose precisa responder:

docker version --format '{{.Server.Version}}'
docker compose version

Passo 2: Baixe o pacote

O pacote é baixado de download.draften.ai com a chave que está dentro do arquivo de licença. Estes comandos tiram a chave da licença e listam as versões disponíveis:

KEY=$(sed -n 's/.*"payload":"\([^"]*\)".*/\1/p' licence-<número>.json | tr '_-' '/+' | awk '{ while (length($0) % 4) $0 = $0 "="; print }' | base64 -d | sed -n 's/.*"key": *"\([^"]*\)".*/\1/p')
curl -fsS -H "Authorization: Bearer $KEY" https://download.draften.ai/v1/latest.json | sed -n 's/.*"payload":"\([^"]*\)".*/\1/p' | tr '_-' '/+' | awk '{ while (length($0) % 4) $0 = $0 "="; print }' | base64 -d

A lista mostra as versões dos últimos seis meses – de cada uma, a versão, a data, as notas, o tamanho e o checksum sha256 – e, em latest, a mais recente que não foi retirada de circulação. Baixe essa versão:

curl -fS -H "Authorization: Bearer $KEY" -o draften-<versão>.tar https://download.draften.ai/v1/bundles/draften-<versão>.tar

O pacote tem cerca de 500 MB. Quando o portal responde com o erro 403, a licença é desconhecida, foi revogada ou expirou – a mensagem diz o motivo.

Servidor sem internet: baixe o pacote em outra máquina com os mesmos comandos e transfira-o para o servidor (por exemplo com scp). Nesse caso, também podemos mandar o checksum junto com o pacote.

Passo 3: Confira o pacote

Calcule o checksum e compare-o com o valor sha256 dessa versão na lista do passo 2:

sha256sum draften-<versão>.tar

Se os checksums forem diferentes, não instale o pacote e fale com a gente. Esta é a única verificação manual: cada atualização posterior a instalação confere sozinha com as nossas chaves.

Passo 4: Descompacte o pacote e execute o instalador

Escolha o diretório em que a instalação vai ficar, descompacte o pacote nele e execute o instalador:

sudo mkdir /srv/draften
sudo tar -xf draften-<versão>.tar -C /srv/draften
cd /srv/draften
sudo ./draften install

Primeiro, o instalador carrega as imagens (um ou dois minutos) e confere a assinatura e o conteúdo do pacote. Se a verificação falhar (“this bundle does not check out”), o pacote está corrompido – baixe-o de novo.

Passo 5: Responda às perguntas do instalador

O instalador pergunta em inglês:

PerguntaO que informar
Where will people open draften (the full address)o endereço com https://, por exemplo https://draften.firma.cz. Precisa ser o endereço que as pessoas realmente usam – os endereços de retorno do login com a Microsoft e o Google também são montados a partir dele
The organisation's nameo nome da sua organização
Its short nameum nome curto: letras minúsculas, dígitos e hífens. O instalador sugere um a partir do nome da organização
The first administrator's e-mailo e-mail do primeiro administrador. Ele se torna o proprietário da organização e o operador da instalação inteira
Their nameo nome dele
Their languagecs, en, de, fr, es, it, pt ou pl (padrão en)
Run the updateryes ou no (padrão yes). O updater permite atualizar, alterar o número de processos, trocar a chave de criptografia e fazer backup pela interface web. Ele tem acesso ao Docker, o que significa direitos de root no servidor. Sem ele, tudo funciona pela linha de comando
HTTPS certificate file (PEM)o caminho do certificado, se o HTTPS for terminar diretamente no draften; caso contrário, deixe vazio
Its private key fileo caminho da chave do certificado

Com um certificado, o endereço precisa começar com https://. Cada resposta também pode ser dada diretamente no comando, para que você possa automatizar a instalação com um script; ./draften help lista as opções:

sudo ./draften install --url https://draften.firma.cz --org "Firma Ltda." \
  --admin-email jan@firma.cz --admin-name "Jan Novák" --locale en --updater yes

Passo 6: O que o instalador faz

  1. Grava as configurações e os segredos no arquivo .env – que só o proprietário pode ler. As senhas do banco de dados, a chave de criptografia MASTER_KEY e os segredos das sessões são gerados aleatoriamente e não são exibidos em lugar nenhum.
  2. Cria as pastas data/ e backups/ e a primeira organização com o administrador.
  3. Inicia o draften e confere se ele responde.
  4. No final, mostra o endereço e o link para definir a senha do primeiro administrador, e lembra você de guardar uma cópia do .env.

Se a primeira inicialização falhar (“the first start failed”), veja docker compose ps e docker compose logs. Se o link não aparecer, você o encontra com o comando docker compose logs worker | grep set-password – o worker o mostra a cada inicialização enquanto a senha não existir.

Guarde logo uma cópia do .env fora do servidor – pelo menos o valor de MASTER_KEY. Essa chave criptografa o acesso às caixas de e-mail, as chaves dos modelos e as senhas para envio de e-mails. Sem ela ninguém consegue lê-los, nem a partir de um backup – e nós não a temos.

Passo 7: Publique o draften por HTTPS

Escolha uma variante conforme o lugar onde o HTTPS termina. Aponte o registro de DNS do seu endereço para o servidor (ou para o proxy).

HTTPS diretamente no draften

Se você deu um certificado ao instalador, o draften escuta na porta 443 e redireciona da porta 80 para HTTPS. Basta o DNS e as portas 80 e 443 abertas. O certificado também pode ser adicionado depois, e com o mesmo comando você o troca após a renovação sem perder uma única requisição:

sudo ./draften certificate cert.pem key.pem --url https://draften.firma.cz

A renovação do certificado (por exemplo com um cliente ACME) fica por sua conta; depois de cada renovação, execute esse comando.

O seu proxy reverso

Sem certificado, o draften escuta só em 127.0.0.1:8085. Um proxy na mesma máquina envia as requisições para esse endereço e repassa os cabeçalhos Host e X-Forwarded-Proto. Por exemplo, para o Caddy (ele obtém o certificado sozinho):

draften.firma.cz {
    reverse_proxy 127.0.0.1:8085
}

ou para o nginx:

server {
    listen 443 ssl;
    server_name draften.firma.cz;
    ssl_certificate     /etc/ssl/draften/fullchain.pem;
    ssl_certificate_key /etc/ssl/draften/privkey.pem;

    location / {
        proxy_pass http://127.0.0.1:8085;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto https;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Quando o proxy roda em outra máquina, defina WEB_BIND=0.0.0.0:8085 no .env, execute sudo docker compose up -d e libere a porta 8085 só para o proxy (veja o passo 13).

Cloudflare Tunnel

Não precisa de nenhuma porta aberta. No Cloudflare Zero Trust, crie um túnel e copie o token dele. Coloque CLOUDFLARE_TUNNEL_TOKEN=<token> no .env, adicione tunnel a COMPOSE_PROFILES (por exemplo COMPOSE_PROFILES=updater,tunnel) e execute:

sudo docker compose up -d

Depois, na Cloudflare, adicione ao túnel um endereço público (Public hostname) que leve a http://127.0.0.1:8085. Deixe WEB_BIND em 127.0.0.1:8085. A imagem cloudflared o Docker baixa do Docker Hub – ela não está no pacote.

Passo 8: Defina sua senha e entre

Abra o link que o instalador mostrou, defina a senha e você já estará dentro. O link funciona uma vez e vale por 7 dias. Como é a página para definir a senha você vê no guia Entrar.

Não copie o link para lugar nenhum nem o repasse a ninguém – quem tiver o link define a senha do administrador.

Passo 9: Carregue a licença

Na interface, abra Instalação → Instalação, escolha o arquivo no cartão Licença, na parte de baixo, e carregue-o. Enquanto a instalação não tiver licença, os assistentes não processam e-mails e não é possível criar caixa de e-mail nem assistente. Com a licença, o updater acompanha sozinho as novas versões. Mais em A licença.

Passo 10: Defina as chaves padrão e o envio de e-mails

Na mesma página Instalação:

Passo 11: Conecte os e-mails e as pessoas

  1. Decida como o assistente vai chegar aos e-mails e prepare isso na Microsoft ou no Google: Microsoft 365, Google Workspace, outra caixa de e-mail por IMAP.
  2. Quem vai entrar com conta Microsoft ou Google, configure em Como os membros entram.
  3. Adicione e conecte uma caixa de e-mail.
  4. Configure um assistente com a configuração guiada.
  5. Convide mais pessoas – Pessoas e perfis de acesso.

Passo 12: Confira se tudo está rodando

sudo ./draften status

mostra a versão, a saúde da interface web e dos workers, o status do HTTPS e os backups. Na interface, a página Operação mostra se os workers dão sinal – veja Operação e capacidade. Quando algo não funciona, ajuda a Solução de problemas; o arquivo para o nosso suporte é gerado por sudo ./draften diagnose.

Passo 13: Proteja o servidor

Quem tem acesso ao servidor tem acesso a tudo: aos e-mails nas mensagens, ao .env com a chave e aos backups. Por isso, proteja o servidor como um servidor de e-mail.

Firewall. De fora, libere só o necessário:

O Docker contorna as regras do UFW (e do firewalld) nas portas que ele publica. ufw deny 8085 não fecha uma porta que o Docker abriu em 0.0.0.0. Por isso, deixe WEB_BIND em 127.0.0.1:8085 sempre que possível; quando não for, restrinja o acesso com um firewall na frente do servidor ou com regras na cadeia DOCKER-USER.

As conexões de saída basta liberar para os endereços do Ambiente compatível.

SSH. Login só com chave (PasswordAuthentication no), sem login direto do root (PermitRootLogin no), administradores com contas próprias e sudo.

Quem pode usar o Docker. Fazer parte do grupo docker significa ter direitos de root. Dê isso só aos administradores do servidor.

Atualizações do sistema. Ative as atualizações automáticas de segurança (no Ubuntu, unattended-upgrades) e atualize o Docker junto com o sistema. As atualizações do draften ficam por conta do updater – veja Atualizar com o updater.

Updater. Ele tem acesso ao Docker, o que significa direitos de root. Se você não precisa dele, desative-o: no .env, tire updater de COMPOSE_PROFILES e, no diretório da instalação, execute sudo docker compose rm -sf updater. Atualizações e backups você faz então pela linha de comando.

Arquivos da instalação. O .env só pode ser lido pelo proprietário, e a pasta backups/ também – deixe assim. Não compartilhe o diretório da instalação.

Backups fora do servidor. O draften faz backup do banco de dados todos os dias em backups/, no mesmo disco. Configure a cópia de backups/ e do .env para outro lugar, criptografada – os dumps contêm e-mails. Detalhes: Backup e restauração.

Chave de criptografia. Quando sair alguém que conhecia o .env, troque a MASTER_KEY (sudo ./draften rotate-key, ou em Instalação) e guarde a nova cópia do .env fora do servidor.

Próximos passos

Versão em texto