Guia de Instalação no Windows para digna Release 2026.06¶

Release: 2026.06

Última Atualização: 30 de agosto de 2026

Sumário¶

1. Introdução
2. Requisitos do Sistema
3. Configuração Pré-Instalação
4. Configuração do Servidor PostgreSQL
5. Configuração do Servidor Web
6. Instalação Inicial
7. Configuração do Backend
8. Configuração do Dashboard
9. Executando o digna como Serviço do Windows
10. Atualizando para uma Nova Release

Introdução¶

Sobre o digna¶

digna é uma plataforma abrangente orientada por IA projetada para otimizar a gestão da qualidade de dados em diversos ambientes, como data warehouses, data lakes e lakehouses. Construída para ser altamente escalável e adaptável, a digna resolve desafios modernos de dados por meio de automação, monitoramento em tempo real e detecção de anomalias.

digna consiste em dois componentes principais:

• digna: o núcleo da aplicação, responsável por processar os dados e executar as verificações de qualidade. Reúne o backend e a interface de linha de comando em um único executável, substituindo os programas separados dignabackend e dignacli das versões anteriores.
• dignadashboard: Uma interface web hospedada em um servidor web, oferecendo uma maneira amigável de interagir com a plataforma digna e visualizar métricas de qualidade de dados.

Novidades na Release 2026.06¶

Esta release traz capacidades de observabilidade de dados diretamente para o seu código, permitindo que desenvolvedores monitorem a qualidade dos dados na origem. Consulte as notas de release para detalhes completos.

Procurando macOS ou Linux?¶

Este guia cobre o Windows. Para outras plataformas, veja o macOS Installation Guide ou o Linux Installation Guide.

Requisitos do Sistema¶

Antes de iniciar a instalação, verifique se o seu sistema atende aos seguintes requisitos mínimos:

Opções de Instalação do Banco de Dados¶

Se o PostgreSQL já estiver instalado: Você pode adicionar um novo banco de dados para o digna no seu servidor PostgreSQL existente.

Se for instalar o PostgreSQL na mesma máquina do digna:

Configuração Pré-Instalação¶

Antes de instalar o digna, verifique se dois pré-requisitos principais estão em vigor:

1. Servidor PostgreSQL – para armazenar métricas calculadas e dados de performance
2. Servidor Web – para hospedar o digna Dashboard

Se esses componentes ainda não estiverem configurados, siga as seções abaixo para instalá-los e configurá-los.

Configuração do Servidor PostgreSQL¶

Se Você Já Tiver PostgreSQL¶

Se o PostgreSQL já está instalado e em execução na sua máquina local ou se você estiver usando um servidor PostgreSQL remoto gerenciado, você pode pular para a próxima seção.

Instalando o PostgreSQL¶

Siga estes passos para instalar o PostgreSQL no Windows:

Passo 1: Baixar o PostgreSQL¶

1. Visite a página de downloads do PostgreSQL
2. Selecione Windows
3. Baixe o instalador mais recente

Passo 2: Executar o Instalador¶

1. Dê um duplo clique no arquivo do instalador baixado
2. Siga as instruções do assistente de instalação

Passo 3: Escolher o Diretório de Instalação¶

Selecione o diretório onde o PostgreSQL será instalado. O local padrão geralmente é adequado.

Passo 4: Selecionar Componentes¶

Para uma instalação padrão, mantenha as opções de componentes padrão selecionadas.

Passo 5: Definir a Senha do Superusuário do PostgreSQL¶

Digite e confirme uma senha para o superusuário do PostgreSQL (postgres). Armazene essa senha com segurança — você precisará dela mais tarde.

Passo 6: Configurar o Número da Porta¶

A porta padrão do PostgreSQL é 5432. Você pode usar a padrão ou especificar uma porta diferente, se necessário.

Passo 7: Escolher Localidade (Locale)¶

Selecione a localidade para o seu banco de dados. A configuração padrão geralmente é adequada para a maioria das instalações.

Passo 8: Concluir a Instalação¶

Clique em Next nas etapas restantes e, em seguida, clique em Finish.

Passo 9: Verificar a Instalação¶

Abra o Prompt de Comando e verifique se o PostgreSQL foi instalado:

psql --version

Você verá a versão do PostgreSQL se a instalação tiver sido bem-sucedida.

Configuração do Servidor Web¶

O digna exige um servidor web para hospedar o dashboard. Escolha uma das seguintes opções:

• Internet Information Services (IIS)
• Apache Tomcat

Você só precisa instalar e configurar um desses servidores.

Configuração do IIS¶

Visão Geral¶

Internet Information Services (IIS) é o servidor web da Microsoft para hospedagem de sites e aplicações web.

Habilitando o IIS¶

1. Abra o Painel de Controle
2. Pressione Win + R

3. Digite control e pressione Enter

4. Navegue até Recursos do Windows

5. Clique em Programs

6. Selecione Turn Windows features on or off

7. Habilite o Internet Information Services

8. Role para baixo e encontre Internet Information Services (IIS)
9. Marque a caixa de seleção para habilitá-lo

10. Clique no + para expandir e verifique se os seguintes subcomponentes estão selecionados:

    • Web Management Tools
    • World Wide Web Services

11. Clique em OK para aplicar as alterações

12. Verifique a Instalação do IIS

13. Abra seu navegador
14. Acesse http://localhost
15. Você deverá ver a página de boas-vindas do IIS

Obrigatório: Módulo URL Rewrite¶

O IIS requer o componente URL Rewrite. Baixe e instale a partir da página oficial da Microsoft.

Obrigatório: Tipo MIME para Arquivos Markdown¶

Para garantir que arquivos Markdown (.md) sejam servidos corretamente pelo IIS:

1. Abra o IIS Manager (pressione Win + R, digite inetmgr, pressione Enter)
2. Navegue até Your Site > MIME Types
3. Clique em Add...
4. Configure:
5. File name extension: .md
6. MIME type: text/markdown

Configuração do Apache Tomcat¶

Visão Geral¶

Apache Tomcat é um contêiner de servlets Java e servidor web de código aberto.

Instalação¶

1. Baixar o Apache Tomcat
2. Visite Apache Tomcat Downloads

3. Baixe a distribuição ZIP para Windows

4. Extrair o Arquivo

5. Extraia o arquivo ZIP para um diretório no seu sistema

6. Exemplo: C:\Program Files\Apache Tomcat

7. Verificar se o Tomcat Está em Execução

8. Abra seu navegador
9. Acesse http://localhost:8080
10. Você deverá ver a página de boas-vindas do Apache Tomcat

Instalação Inicial¶

Passo 1: Configurar o Repositório do digna¶

O repositório do digna armazena todas as métricas calculadas pela plataforma. Ele atua como o banco de dados central para dados analíticos e de performance.

Criar Schema do Repositório e Usuário¶

Abra seu cliente PostgreSQL (pgAdmin, psql ou similar) e execute os seguintes comandos SQL:

CREATE SCHEMA <digna_repo_schema>;

CREATE USER <digna_repo_user> WITH PASSWORD '<digna_repo_password>';

GRANT ALL PRIVILEGES ON SCHEMA <digna_repo_schema> TO <digna_repo_user>;

Substitua os seguintes placeholders:

• <digna_repo_schema> — Nome do schema desejado (ex.: dignarepo)
• <digna_repo_user> — Nome de usuário desejado (ex.: digna_user)
• <digna_repo_password> — Uma senha segura para este usuário

Exemplo:

CREATE SCHEMA dignarepo;

CREATE USER digna_user WITH PASSWORD 'YourSecurePassword123!';

GRANT ALL PRIVILEGES ON SCHEMA dignarepo TO digna_user;

Passo 2: Extrair o Pacote de Instalação do digna¶

1. Localize o arquivo ZIP de instalação do digna fornecido a você
2. Extraia-o para o local de instalação desejado
3. Após a extração, você deverá ver os seguintes itens:
4. dashboard/ — Interface web do dashboard
5. digna — Executável principal (backend + CLI combinados)

Passo 3: Instalar o Arquivo de Licença¶

1. Localize o arquivo license.toml fornecido a você
2. Copie-o para o diretório raiz da instalação do digna (onde config.toml e o executável digna estão localizados)

Por que isso importa: O arquivo de licença contém suas informações de cliente, data de expiração da licença e assinatura digital. Não modifique este arquivo — qualquer alteração o invalidará.

Estrutura de diretórios após a configuração:

digna_installation/
├── config.toml         (arquivo de configuração)
├── license.toml        (SEU ARQUIVO DE LICENÇA - copie aqui)
├── digna               (executável principal)
└── dashboard/          (interface web)
    └── (arquivos do dashboard)

Configuração do Backend¶

Passo 1: Criar e Editar o Arquivo de Configuração¶

O arquivo config_template.toml é fornecido no diretório de instalação do digna. Você só precisa renomeá-lo para config.toml.

Localização: digna_installation/config.toml

Abra config.toml em um editor de texto e configure cada seção abaixo.

Seção [app]¶

Esta seção configura as definições da aplicação backend do digna:

[app]
digna_APP_CORS_ALLOW_ORIGINS = ["http://localhost:5173"]
digna_APP_CORS_ALLOW_CREDENTIALS = true
digna_APP_CORS_ALLOW_METHODS = ["*"]
digna_APP_CORS_ALLOW_HEADERS = ["*"]

Seção [repo]¶

Esta seção configura a conexão com o banco de dados PostgreSQL:

[repo]
digna_REPO_HOST = "localhost"
digna_REPO_PORT = 5432
digna_REPO_DB = "postgres"
digna_REPO_SCHEMA = "dignarepo"
digna_REPO_USER = "digna_user"
digna_REPO_PASSWORD = "YourSecurePassword123!"

Seção [base]¶

Esta seção contém configurações de segurança e cookies:

[base]
DIGNA_FERNET_KEY = "DU4a0yJ-OqvbKCL4hNQn_CsknH-V1vWmHZqBUl-AY44="
digna_COOKIE_DOMAIN = "localhost"
digna_COOKIE_PATH = "/"
digna_COOKIE_SECURE = false
digna_COOKIE_HTTPONLY = true
digna_COOKIE_SAME_SITE = "lax"
digna_TOKEN_EXPIRES_IN = 86400
digna_MAX_WORKERS = 4
DIGNA_SCHEDULER_MAX_DELAY = 100
DIGNA_CLEANUP_TIME = "12:00"

Seção [encryption]¶

Esta seção contém a chave usada para criptografar os valores sensíveis armazenados no repositório. Ela é obrigatória — config check informa a seção [encryption] como FAILED se a chave estiver ausente.

[encryption]
DIGNA_ENCRYPTION_KEY = 'ycELf6IbcO55dYIZHpPv6kQv/bbnUXoIaHLh2bh1kMg='

Seção [logging]¶

Esta seção configura o comportamento de logging:

[logging]
digna_LOGGING_MODE = "INFO"
digna_LOGGING_BACKUP_COUNT = 10

Passo 2: Validar a Configuração¶

Antes de inicializar o repositório, verifique se o config.toml está completo e bem formado. No diretório de instalação do digna, execute:

digna config check

Cada seção é validada separadamente, de modo que um único erro não esconde o estado das demais:

Configuration validation report (source: config.toml):
 - App config: OK
 - Repository config: OK
 - Base config: OK
 - Logging config: OK
 - Encryption config: OK
 - OIDC config(s): OK

Overall: OK

Corrija tudo o que for informado como FAILED e execute o comando novamente antes de continuar. A lista completa de opções está na referência da CLI.

Passo 3: Inicializar o Repositório¶

1. Abra o Prompt de Comando
2. Navegue até o diretório de instalação do digna (onde config.toml e o executável digna estão localizados)
3. Execute o teste de conexão:

digna repo check

Você deverá ver uma confirmação de que a conexão foi estabelecida (o repositório em si ainda não foi inicializado).

Passo 4: Instalar o Schema do Repositório¶

No mesmo diretório, execute:

digna repo install

Esse comando instala as tabelas e o schema necessários no seu banco de dados PostgreSQL.

Passo 5: Criar um Usuário Admin¶

1. Abra uma nova janela do Prompt de Comando
2. Navegue até o diretório de instalação do digna
3. Execute o seguinte comando para criar um usuário admin:

digna user add <email> <password> "<display_name>" --admin

Exemplo:

digna user add admin@example.com "AdminPassword123!" "Admin User" --admin

Isto cria um usuário com privilégios administrativos completos.

Passo 6: Iniciar o Servidor digna¶

No diretório de instalação do digna, inicie o servidor com:

digna serve --address <host> --port <port>

Parâmetros: - --address — Nome do host/IP do servidor - --port — Porta do servidor

Você deverá ver mensagens de inicialização confirmando que o servidor está em execução:

INFO:     Started server process [1234]
INFO:     Waiting for application startup.
INFO:     Application startup complete
INFO:     Uvicorn running on http://localhost:8082

Configuração do Dashboard¶

Passo 1: Implantar o Dashboard no Servidor Web¶

O dashboard do digna lê sua própria configuração do arquivo dashboard/dashboard_config.toml. Esse arquivo não acompanha a instalação — você o cria no diretório dashboard/, junto com os arquivos do dashboard.

O conteúdo dele está descrito em Single Sign-On, que é também onde o arquivo é necessário: ele contém as opções de login que o dashboard oferece e, em implantações multi-instância, a conexão com o backend.

Escolha seu servidor web e siga os passos de implantação correspondentes.

Implantando no IIS¶

1. Abra o IIS Manager

2. Pressione Win + R, digite inetmgr, pressione Enter

3. Crie um Novo Website

4. No painel esquerdo, clique com o botão direito em Sites

5. Selecione Add Website...

6. Configure o Website

7. Site Name: Insira um nome (ex.: "dignaDashboard")
8. Physical Path: Clique em Browse e selecione a pasta dashboard

9. Binding: Defina o endereço IP e porta (porta padrão 80 para HTTP, 443 para HTTPS)

10. Inicie o Website

11. Clique em OK para criar o site

12. Clique com o botão direito no novo site e selecione Start

13. Testar a Instalação

14. Abra seu navegador
15. Acesse http://localhost (ou a URL configurada)
16. Você deverá ver a página de login do digna dashboard

Implantando no Apache Tomcat¶

1. Copiar o Dashboard para o Tomcat
2. Copie a pasta dashboard para o diretório webapps do Tomcat
3. Renomeie se necessário (ex.: para digna)

4. Exemplo: C:\Program Files\Apache Tomcat\webapps\digna

5. Verificar a Implantação

6. Atualize ou recarregue a página de gerenciamento do Tomcat (http://localhost:8080)

7. Você deverá ver "digna" (ou o nome escolhido) listado nas aplicações implantadas

8. Acessar o Dashboard

9. Abra seu navegador
10. Acesse http://localhost:8080/digna
11. Você deverá ver a página de login do digna dashboard

Executando o digna como um Serviço do Windows¶

Por que Usar um Serviço do Windows?¶

Executar o backend do digna como um serviço do Windows garante que ele: - Inicie automaticamente quando o servidor for inicializado - Execute em segundo plano sem a necessidade de um Prompt de Comando aberto - Reinicie automaticamente em caso de falha - Seja gerenciável através dos Serviços do Windows

Os Comandos windows¶

O serviço é gerenciado pelo próprio executável digna, por meio dos subcomandos digna windows. Não há arquivos batch para executar.

Todos os comandos aceitam --name para se referir a um serviço registrado com um nome diferente do padrão. A lista completa de opções está na referência da CLI.

Instalando o Serviço¶

1. Abra o Prompt de Comando como Administrador
2. Clique com o botão direito no Prompt de Comando

3. Selecione "Run as Administrator"

4. Navegue até o diretório de instalação do digna

   cd C:\path\to\digna
   

5. Registre o serviço

   digna windows install
   

digna windows install --address 0.0.0.0 --port 8082

O serviço é registrado com inicialização automática, então ele iniciará junto com o Windows. Ele não inicia imediatamente — veja a próxima seção.

Opções de Instalação¶

Iniciando e Parando o Serviço¶

Para Iniciar o Serviço¶

digna windows start

Para Parar o Serviço¶

digna windows stop

Movendo o Serviço para um Novo Diretório¶

Se precisar realocar a instalação do digna:

1. Pare o serviço atual e remova o registro dele

   cd C:\old\path\digna
   digna windows stop
   digna windows uninstall
   

2. Mova os Arquivos da Aplicação

3. Mova toda a pasta de instalação do digna para o novo local

4. Registre o serviço novamente a partir do novo local

   cd C:\new\path\digna
   digna windows install
   

Repita os valores de --address, --port ou --account que você usou na primeira vez — o registro anterior não existe mais.

1. Inicie o Serviço

   digna windows start
   

Desinstalando o Serviço¶

1. Pare o Serviço em Execução

   cd C:\path\to\digna
   digna windows stop
   

2. Remova o Registro do Serviço

   digna windows uninstall
   

O servidor digna agora está removido do registro como serviço do Windows.

Atualizando para uma Nova Release¶

Antes de Atualizar¶

Verifique Primeiro Todas as Conexões de Banco de Dados

A partir da Release 2026.06, o digna acessa cada tecnologia de origem por ODBC. As versões anteriores ofereciam a escolha entre um driver próprio por tecnologia e ODBC, selecionada pelo botão Use ODBC. A equipe do digna decidiu se apoiar apenas em ODBC, porque uma interface única e padronizada oferece mais do que um conjunto de drivers sob medida:

• Autenticação — a autenticação faz parte do ODBC, então uma conexão pode usar tudo o que o seu driver suportar: senhas, tokens e PATs, Kerberos e Active Directory, MFA e logon único pelo navegador, identidades na nuvem, certificados de cliente e TLS. Novos métodos chegam com uma atualização do driver, em vez de esperar por uma versão do digna.
• Drivers mantidos pelos fabricantes dos bancos de dados — o driver do próprio fabricante acompanha as novas versões do servidor e as correções de segurança, e você pode atualizá-lo no seu próprio ritmo, independentemente do digna.
• Uma única forma de configurar tudo — cada tecnologia é uma lista de propriedades chave/valor, com a mesma interface, a mesma criptografia de valores sensíveis e a mesma solução de problemas, em vez de um conjunto de campos diferente por origem.
• Ajuste e alcance — opções do driver como tempos limite, configurações de TLS, proxies e tamanhos de leitura estão disponíveis para todas as origens, e qualquer tecnologia com um driver ODBC compatível pode ser conectada, inclusive aquelas para as quais o digna não publica um guia dedicado.

Na prática, isso significa que o botão Use ODBC e os campos separados de host, porta, banco de dados, usuário e senha não existem mais. Toda conexão que ainda não usa ODBC precisa ser convertida para ODBC — não há conversão automática, portanto planeje isso antes de atualizar:

1. Revise cada conexão de banco de dados definida na sua instalação e anote as que ainda não usam ODBC — cada uma precisará ser reconfigurada.
2. Instale o driver ODBC correspondente no host do digna — as conexões são abertas pelo servidor que executa o backend do digna, não pelo navegador. Consulte Instalar o Driver ODBC no Host do digna.
3. Tenha as propriedades ODBC prontas para cada conexão afetada. Os guias por tecnologia trazem, para cada origem, um conjunto de propriedades comprovado.

Após a atualização, converta cada conexão afetada para ODBC e teste-a pelo dashboard — consulte Criar uma Conexão de Banco de Dados e Testar uma Conexão.

É Obrigatório Criar um Backup do Repositório do digna

Antes de atualizar o digna, faça backup do seu repositório (PostgreSQL) para proteger contra perda de dados. Um backup garante que você possa recuperar caso a atualização encontre problemas inesperados.

Processo de Atualização¶

Passo 1: Parar o Serviço Antigo e Remover Seu Registro¶

Se o digna estiver sendo executado como serviço do Windows, pare-o com os arquivos batch da sua instalação atual — os comandos digna windows pertencem à nova release e ainda não estão disponíveis:

cd C:\path\to\digna\bin
stop_service.bat

Em seguida, remova o registro do serviço, novamente com o arquivo batch antigo. O registro aponta para o executável antigo e seus scripts, que esta atualização substitui, portanto ele não pode ser reaproveitado:

uninstall_service.bat

Passo 2: Fazer Backup da Instalação Atual¶

No diretório de instalação do digna, renomeie as pastas da instalação atual para que a nova release possa ser implantada ao lado delas:

# Rename the folder containing dignabackend
ren dignabackend dignabackend_old

# Rename the folder containing dignacli
ren dignacli dignacli_old

# Rename dashboard
ren dashboard dashboard_old

Passo 3: Extrair e Implantar a Nova Versão¶

1. Extraia o novo arquivo ZIP de instalação do digna
2. Copie o novo executável digna e a pasta dashboard para o seu diretório de instalação

Passo 4: Restaurar Seus Arquivos de Configuração¶

copy dashboard_old\dashboard_config.toml dashboard\dashboard_config.toml

[base]
DIGNA_SCHEDULER_MAX_DELAY = 100
DIGNA_CLEANUP_TIME = "12:00"

[encryption]
DIGNA_ENCRYPTION_KEY = 'ycELf6IbcO55dYIZHpPv6kQv/bbnUXoIaHLh2bh1kMg='

[[oidc_clients]]
DIGNA_OIDC_KEY = 'microsoft'
DIGNA_OIDC_CLIENT_ID = '<client_id>'
DIGNA_OIDC_CLIENT_SECRET = '<client_secret>'
DIGNA_OIDC_REDIRECT_URI = 'http://localhost:3000/oidc/callback'
DIGNA_OIDC_CONFIGURATION_URL = 'https://login.microsoftonline.com/<tenant_id>/v2.0/.well-known/openid-configuration'

[oidc_clients.microsoft]
DIGNA_OIDC_CLIENT_ID = '<client_id>'
DIGNA_OIDC_CLIENT_SECRET = '<client_secret>'
DIGNA_OIDC_REDIRECT_URI = 'http://localhost:3000/oidc/callback'
DIGNA_OIDC_CONFIGURATION_URL = 'https://login.microsoftonline.com/<tenant_id>/v2.0/.well-known/openid-configuration'

Passo 5: Recarregar o Servidor Web¶

O dashboard é um conjunto de arquivos estáticos, então seu servidor web — e o navegador — podem ainda estar servindo a versão anterior. Recarregue ou reinicie o servidor web que hospeda a pasta dashboard e, em seguida, recarregue a página com uma atualização forçada (Ctrl+F5).

Passo 6: Validar a Configuração¶

Confirme que o config.toml atualizado está completo antes de mexer no repositório:

digna config check

Todas as seções devem informar OK. Corrija tudo o que for informado como FAILED e execute o comando novamente antes de continuar.

Passo 7: Substituir o Arquivo de Licença¶

Cada release é licenciada separadamente. Copie o license.toml que a equipe do digna forneceu para esta release para o diretório de instalação, substituindo o antigo:

copy /Y C:\path\to\new\license.toml license.toml

digna license check

Passo 8: Atualizar o Schema do Repositório¶

Navegue até o diretório de instalação do digna e execute:

digna repo upgrade

Isso atualiza o schema do PostgreSQL para a versão mais recente preservando todos os dados existentes.

Passo 9: Registrar e Iniciar o Serviço¶

O registro antigo foi removido no Passo 1, então o serviço é registrado novamente — desta vez com o executável digna, que não tem arquivos batch:

cd C:\path\to\digna
digna windows install --address <address> --port <port>
digna windows start

Informe em --address e --port os valores em que o serviço antigo atendia, a menos que você queira os novos padrões 127.0.0.1 e 8000; eles são gravados no registro e não são mais lidos do config.toml. Acrescente --account e --password se o serviço antigo era executado com uma conta de domínio. Consulte Executando o digna como um Serviço do Windows para a lista completa de opções.

Se estiver executando manualmente, reinicie o servidor:

cd C:\path\to\digna
digna serve --address <address> --port <port>

Se estiver usando IIS ou Tomcat, reinicie o respectivo servidor web.

Passo 10: Verificar a Atualização¶

1. Acesse o digna dashboard
2. Verifique se a interface carrega corretamente
3. Confira os logs do servidor em busca de erros
4. Converta para ODBC todas as conexões que ainda não o usavam e depois teste todas as conexões — consulte Testar uma Conexão