Pular para o conteúdo

You're viewing the prerelease documentation siteContent here is for testing and may differ from the live docs.

Go to live docs

Visão geral da auto-hospedagem

Execute sua própria instância e cada mensagem confidencial, conta e linha de log permanece em infraestrutura que você controla. Você decide como as contas são autenticadas, se a instância fica acessível pela internet pública e qual marca a interface exibe.

O modo determina o que mais precisa estar em execução, então defina-o antes de instalar.

simple é o padrão de fábrica e precisa apenas do armazenamento de dados Valkey/Redis. full adiciona um banco de dados SQL para as contas, cujo padrão é SQLite em sqlite://data/auth.db; o PostgreSQL é uma opção suportada, não um requisito. Em um contêiner, esse arquivo precisa de um volume montado para sobreviver a uma reinicialização.

Simple ou Full explica o que cada modo desbloqueia, onde esse banco de dados precisa ficar e quão difícil é trocar o modo mais tarde.

Com pressa e com um Valkey ou Redis já em execução? A forma de um único docker run em Instalar com Docker coloca uma instância em funcionamento na porta 3000 com uma chave SECRET gerada. Todo o restante desta página continua valendo depois que ela estiver no ar.

  • Imagens e variantes — qual das imagens publicadas executar e como funcionam as tags de release.
  • Instalar com Docker — as duas stacks Compose que o projeto distribui.
  • Instalar no Linux — uma instalação bare-metal no Debian ou Ubuntu. Nenhuma outra família de distribuições é coberta pelos testes de instalação do projeto.
  • Executar como serviço — as unidades systemd que o repositório distribui e o executor de Procfile para hosts sem systemd.
  • Proxy reverso e TLS — a aplicação nunca faz a terminação TLS, então pressupõe-se um proxy na frente dela. Leia isto antes de expor a instância.
  • Verifique sua instalação — comprove que a instância está realmente servindo antes de entregá-la a alguém, e crie a primeira conta: a função de operador do site é concedida apenas pela CLI.

Atualizando uma instalação existente? Os Guias de atualização listam os guias disponíveis, do mais recente para o mais antigo. Comece pelo primeiro guia após a release que você executa agora e avance a partir dele, lendo as notas de release de cada versão intermediária.

Recomendado para uma instância executando o modo de autenticação simple:

  • 2+ núcleos de CPU
  • 2GB+ de RAM
  • 10GB+ de espaço em disco

Uma implantação em modo full que também executa PostgreSQL, o worker em segundo plano e o agendador precisa de aproximadamente o dobro disso.

Parte do trabalho administrativo não tem tela na aplicação e é feita pela linha de comando da instância.

Transferir uma organização para um novo proprietário é a principal delas. Os proprietários de organização não têm tela nem endpoint para isso, então a transferência cabe a você. Use o comando abaixo. Para automação, a API do Colonel expõe a mesma operação em POST /api/colonel/organizations/:org_id/transfer-ownership; ela exige a função colonel, recebe o nome da organização como confirmação e é aplicada imediatamente, sem pré-visualização.

Janela do terminal
bin/ots org transfer-ownership ORG NEW_OWNER

ORG é o ID público da organização (extid, o ID que a CLI exibe) ou o seu ID interno (objid). NEW_OWNER é um endereço de e-mail, o extid de um cliente ou um ID de conta Rodauth, e a pessoa já precisa ser um membro ativo — o comando nunca cria um cliente, então execute bin/ots memberships add ORG CUSTOMER antes, caso ela não seja.

Execute-o sem --yes e ele planeja a transferência antes de alterar qualquer coisa, exibindo quem perde a propriedade, quantas associações de proprietário seriam rebaixadas e para qual função, e depois pedindo sua confirmação. Responder n é a forma de pré-visualizar uma transferência. As opções são --demote-to ROLE (qualquer função de associação exceto owner, padrão admin), --yes (também -y e -f) e --json.

O proprietário que sai é rebaixado, não removido. A operação promove o novo proprietário antes de rebaixar o antigo — a proteção de proprietário único recusa qualquer outra ordem —, então, durante essas duas gravações, a organização tem duas associações de proprietário e bin/ots org doctor reporta a verificação 4 (membership_role_sync) como um aviso. Se uma transferência for interrompida dentro dessa janela, execute o comando de transferência novamente, não o org doctor. A transferência é idempotente e rebaixa todos os outros proprietários; o org doctor marca essa verificação como repairable: false e não a corrige.

Para o lado do usuário final, consulte Propriedade e transferência, que é o que seus usuários terão lido antes de procurar você.