Administradores

Rode seu próprio servidor Welley

Nossa ferramenta de linha de comando instala tudo o que o Welley precisa em uma máquina Linux. Pode ser um servidor na nuvem ou o seu próprio hardware.

Prepare o host, o DNS e o e-mail

Estes são os requisitos iniciais do guia de início rápido. A capacidade de que você precisa depende dos seus usuários e da carga de trabalho.

Host Linux

  • Ubuntu 24.04 LTS ou uma distribuição atual parecida.
  • Comece com 2 vCPU, 4 GB de RAM e 60 GB de disco.
  • Use um endereço IPv4 público fixo e um usuário não root com sudo.

Rede

  • Permita conexões TCP de entrada nas portas 80 e 443 a partir da internet. Permita TCP 22 a partir da sua própria rede.
  • Mantenha a porta 80 livre para o desafio do certificado e para a renovação semanal do certificado.

DNS do site

  • Aponte seu domínio e storage.<domain> para o endereço IP do host.
  • Crie os dois registros antes de instalar. A CLI verifica os registros e interrompe o processo se eles não resolverem para o host.

SMTP e e-mail do administrador

  • Deixe à mão o host SMTP, o usuário, a senha e o endereço de remetente. O padrão é STARTTLS na porta 587.
  • Você também vai precisar de um e-mail de administrador para o primeiro login e para a recuperação de senha.

DNS do e-mail

  • Configure SPF, DMARC e o DKIM que o seu provedor gera, para o domínio do endereço de remetente.
  • Use o valor exato de SPF do seu provedor. Incorpore-o ao registro SPF que você já tem, em vez de adicionar um segundo.
  • A CLI avisa se faltar SPF ou DMARC. Ela não consegue verificar o seletor DKIM do seu provedor.

Instale o Docker Engine e o Compose

Siga as instruções oficiais do Docker para a sua distribuição Linux. Depois, dê ao usuário de implantação acesso ao Docker.

Adicione o usuário ao grupo do Docker

Troque <user> pelo seu usuário de implantação não root. Depois de rodar este comando, saia da sessão e entre de novo.

sudo usermod -aG docker <user>

Confira o Docker e o Compose

Os dois comandos precisam funcionar para esse usuário.

docker ps
docker compose version

Baixe a CLI

Escolha o binário da máquina em que você vai rodar a CLI. O próprio host de implantação precisa rodar Linux.

Linux, x86-64

curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=linux/amd64" -o wlycli
chmod +x wlycli
./wlycli -v

Linux, ARM64

curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=linux/arm64" -o wlycli
chmod +x wlycli
./wlycli -v

macOS, Apple silicon

curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=darwin/arm64" -o wlycli
chmod +x wlycli
./wlycli -v

macOS, Intel

curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=darwin/amd64" -o wlycli
chmod +x wlycli
./wlycli -v
  • Estes comandos baixam do canal estável e mostram a versão da CLI.
  • A versão muda a cada novo lançamento. Use a documentação mais recente da CLI na hora de instalar.

Crie a implantação

Rode este comando no host Linux que você preparou. Troque os valores de exemplo de domínio, e-mail e SMTP pelos seus.

./wlycli deploy create \
-d example.com \
-e admin@example.com \
--smtp-host smtp.example.com \
--smtp-user "$MAIL_USER" \
--smtp-password "$MAIL_PASSWORD" \
--smtp-from noreply@example.com
ConfiguraçãoPadrão
Diretório de instalação~/.welley/<project>. O domínio de exemplo gera o nome de projeto example_com.
Banco de dadosPostgreSQL incluído, com os dados dentro do diretório de instalação.
StackPlataforma Welley, pipeline de RAG, Nginx, Redis e PostgreSQL, com contêineres de manutenção.
CertificadosLet’s Encrypt via Certbot, com renovação semanal.
MídiaUploads e arquivos estáticos em https://storage.<domain>.
AtualizaçõesCanal estável, verificado todo dia. O processo de atualização evita indisponibilidade sempre que possível.
Serviços opcionaisA configuração mínima não adiciona banco de dados gerenciado, CDN, telemetria nem integração com o Slack.
  • Antes de rodar, defina MAIL_USER e MAIL_PASSWORD com as suas credenciais SMTP.
  • O guia de início rápido exige estas seis flags.
  • O comando verifica o DNS, grava os arquivos da implantação, obtém um certificado com o Certbot e inicia os contêineres.
  • O comando deploy é um alias de deployment.

Entre e confira o resultado

A senha de administrador gerada está no log da plataforma. Mantenha essa saída em sigilo.

Encontre a senha inicial

Este nome de contêiner vale para example.com. Para o seu domínio, troque o nome do projeto.

docker logs example_com-platform-blue-1 | grep "Auto-init complete"

Entrar

Abra seu domínio e entre com o e-mail de administrador que você informou com -e. Troque a senha gerada logo em seguida.

Confira os contêineres

O guia de início rápido espera que você veja nginx, platform-blue, rag-pipeline-blue, postgres, redis, autoheal e snoopy.

docker ps

Use a CLI para administrar

A CLI também tem comandos para a API da plataforma. Sua conta ainda precisa das permissões para cada operação.

  • Antes de rodar uma operação, confira as flags atuais na ajuda do comando.
  • O comando login recebe a URL base da API, o e-mail e a senha. Ele salva o token de sessão que recebe de volta.
  • Por enquanto, o comando de login mostra o token de sessão no log de sucesso. Mantenha essa saída privada.

Grupos de comandos: accounts, posts, apps, emojis, feeds, reports, rules, settings.

Mostrar comandos disponíveis

./wlycli --help

Mostrar comandos de implantação

./wlycli deployment --help

Mostrar opções de login

./wlycli login --help

Mostrar opções de configuração

./wlycli settings --help

Atualizações e recuperação

Por padrão, uma implantação verifica atualizações estáveis todos os dias. O administrador do servidor pode gerenciar as versões na interface de administração.

  • Se os arquivos da sua implantação ainda estiverem válidos, mas alguns contêineres falharem, o início rápido manda executar restart, que recria os contêineres.
  • O create não será executado de novo enquanto o diretório do projeto ou seus contêineres ainda existirem.
  • A opção de exclusão forçada remove os arquivos da implantação e o banco de dados incluído. Ela não é um passo de recuperação e não preserva seus dados.
  • A skill deploy-server ainda usa o nome deployment update. A CLI atual tem deployment auto-update no lugar. Confira a ajuda atual da CLI antes de fazer manutenção manual.

Recriar contêineres a partir da implantação existente

./wlycli deploy restart -d example.com

Recria os contêineres a partir da sua configuração salva. Não exclui dados da implantação.

Implante com um assistente de IA

Se o seu assistente de IA aceita pacotes SKILL.md, baixe a nossa skill oficial deploy-server. Ela orienta uma implantação na DigitalOcean.

Por enquanto, a skill cobre apenas a DigitalOcean. O início rápido da CLI também funciona com outras nuvens e com o seu próprio host Linux.

Como usar

  • Extraia o pacote e carregue o diretório deploy-server da maneira como o seu assistente instala skills.
  • Peça ao assistente para usar $deploy-server.
  • A skill pede o domínio, o acesso ao DNS, a configuração de SSH, os dados de SMTP e o e-mail do administrador.
  • Ela pode configurar uma VM na DigitalOcean e, se você quiser, um banco de dados PostgreSQL gerenciado. Ela confirma com você os dados da implantação e o preço do banco de dados gerenciado.

Antes de baixar

  • O pacote é uma cópia sem alterações da skill original.
  • Os exemplos de download e atualização dela estão desatualizados. Pegue a URL de download estável atual no início rápido deste site. Confira a ajuda da CLI antes da manutenção.
  • A skill não vem com credenciais de nuvem nem com um servidor em execução, e não podemos garantir que funcione com todos os assistentes.

O pacote tem SKILL.md, agents/openai.yaml e references/digitalocean.md. Os dois downloads têm os mesmos arquivos.

Documentação de referência

A documentação completa da CLI e os arquivos da skill de implantação. Você pode ler tudo aqui sem uma conta.