Pular para o conteúdo

Instalação pela web ​

Depois de iniciar o Sayrud com um binário, Docker Compose ou Kubernetes, abra http://server-address:2830/setup. Antes da instalação, a página inicial também redireciona para esse endereço.

A instalação tem quatro etapas: verificação, banco de dados, administrador e conclusão. Você pode mudar o idioma no canto superior direito.

Verificar identidade ​

Se nenhum token for especificado, os logs de inicialização mostram Setup token: e um link de instalação com o token. Copie o token para a página e clique em “Verificar”. Em implantações remotas, substitua localhost no link pelo endereço real.

Forma de implantaçãoOnde consultar os logs
Processo em primeiro planoTerminal atual
systemdsudo journalctl -u sayrud -n 100 --no-pager
Docker Composedocker compose logs --tail=100 sayrud
Kuberneteskubectl -n sayrud logs deployment/sayrud --tail=100

Se SAYRUD_SETUP_TOKEN estiver definido, informe seu valor. As instruções de K8s usam esse método; o token está no arquivo local usado para criar o Secret.

Um token personalizado deve ter pelo menos 16 caracteres, sem contar espaços e hífens. Você pode gerá-lo com openssl rand -hex 24. A verificação ignora maiúsculas e minúsculas, espaços e hífens.

Sem um token fixo, reiniciar o processo durante a instalação gera um novo token. Consulte os logs mais recentes. Compartilhe o token e o link que o contém apenas com o responsável pela instalação; os endpoints de instalação são fechados após a criação do administrador.

Configurar os bancos de dados ​

Em uma instalação nova, preencha os seguintes dados:

ServiçoCampos
PostgreSQLHost, porta, nome do banco de dados, usuário, senha, modo SSL
RedisEndereço no formato host:porta e, opcionalmente, usuário e senha

As conexões partem do processo do Sayrud, não do computador onde o navegador está aberto. A configuração do Docker Compose usa postgres e redis:6379; o K8s usa nomes de Service internos do cluster ou domínios externos acessíveis.

Os modos SSL do PostgreSQL são “Sem criptografia”, “Criptografado”, “Criptografado, verificar CA” e “Criptografado, verificar CA e nome do host”. Escolha conforme os requisitos do serviço de banco de dados. Para verificar certificados, o ambiente de execução também precisa confiar na CA correspondente.

Clique em “Testar conexão”, confirme que PostgreSQL e Redis se conectam com sucesso e clique em “Salvar e continuar”.

Criar o administrador ​

Informe o e-mail, o usuário, a senha e a confirmação de senha e clique em “Concluir instalação”.

Isso cria o primeiro administrador do sistema e faz o login automaticamente. Clique em “Começar” para entrar na aplicação.

Após a instalação, confira se consegue criar projetos, editar registros e enviar anexos, e se a configuração e os arquivos enviados são persistidos pela implantação. As configurações do site, a permissão de cadastro, os métodos de login e os modelos de IA podem ser ajustados no painel de administração.

Fornecer a configuração antecipadamente ​

Se um sistema de gerenciamento de configuração fornecer os dados de conexão, você pode preparar sayrud.yaml antecipadamente. A configuração abaixo usa armazenamento local; substitua a senha de conexão e auth.secret_key primeiro:

yaml
postgres:
  dsn: "postgres://sayrud:[email protected]:5432/sayrud?sslmode=disable"
redis:
  address: "127.0.0.1:6379"
  username: ""
  password: ""
auth:
  secret_key: "REPLACE_WITH_BASE64_KEY"
storage:
  type: local
  local:
    path: ./data/storage

Gere auth.secret_key com este comando e insira a saída completa na configuração:

sh
openssl rand -base64 32

Ao escrever uma URL do PostgreSQL manualmente, codifique para URL os caracteres especiais da senha, como @, : e /. Ao usar o assistente, o programa faz a codificação.

Coloque o arquivo no caminho indicado pelos argumentos de inicialização. Consulte as demais opções na configuração de exemplo. Reinicie o programa após alterar a configuração.

Solução de problemas ​

A página de instalação não aparece ​

Se os logs indicarem uma inicialização bem-sucedida e o banco já tiver usuários, o programa abre a aplicação diretamente. Entre com uma conta existente.

O token de instalação é inválido ​

Verifique se o processo reiniciou durante a instalação. Se SAYRUD_SETUP_TOKEN não estiver definido, use o token dos logs mais recentes. No K8s, confirme que o Pod usa o Secret esperado e mantenha apenas uma réplica durante a instalação inicial. Tentativas incorretas consecutivas ativam o limite de solicitações; confira o token antes de tentar novamente.

O teste de conexão com o banco falha ​

Verifique se o banco foi criado, se as credenciais estão corretas e se o host ou Pod da aplicação consegue acessar o endereço. Dentro de um contêiner, 127.0.0.1 aponta para ele mesmo. Se a conexão funcionar, mas o salvamento falhar, confira também as permissões de migração do esquema.

O assistente de uma instalação nova não assume um banco que já tenha usuários. Para restaurar uma instância, recupere a configuração, a chave e os arquivos originais e conecte ao banco pela inicialização normal, sem repetir a etapa de configuração do banco.

Erro de permissão ao salvar a configuração ​

O assistente grava um arquivo temporário no diretório de configuração antes de confirmá-lo como sayrud.yaml, portanto o diretório precisa permitir gravação. Verifique se há montagens somente leitura, ConfigMaps, Secrets ou diferenças entre o UID/GID do processo e o proprietário do volume. As imagens Docker e K8s usam 10001:10001.

A configuração foi salva, mas é necessário reiniciar ​

Consulte os logs, resolva a falha posterior de inicialização e reinicie com o mesmo caminho de configuração. O arquivo salvo será lido novamente; não é preciso excluí-lo e reinstalar.

A página de instalação reaparece após recriar o contêiner ​

Confira se o diretório de configuração está montado em /home/app/config, se continua usando o banco PostgreSQL original e se o nome do projeto do Compose ou o PVC do K8s mudou. Recupere a configuração e os dados originais antes de iniciar outra instalação.