Sobre o projeto

O Umami é apresentado como uma plataforma de análise focada em privacidade que reúne tráfego, campanhas, comportamento, conversões e receita em um só lugar. O projeto enfatiza que não utiliza cookies ou técnicas de vigilância, podendo ser operado via auto-hospedagem ou através de uma oferta de nuvem hospedada. Uma demonstração pública está vinculada ao README, e os canais de suporte do projeto incluem GitHub, Twitter, LinkedIn e Discord. O código é lançado sob a licença MIT. A instalação a partir do código-fonte requer um servidor com Node.js 18.18 ou posterior e um banco de dados PostgreSQL (versão 12.14 ou posterior). O fluxo documentado consiste em clonar o repositório, instalar as dependências com pnpm, criar um arquivo `.env` contendo uma string de conexão `DATABASE_URL`, executar o build e, em seguida, iniciar a aplicação. A etapa de build cria as tabelas do banco de dados na primeira instalação e também insere um usuário de login com o nome de usuário `admin` e senha `umami`. Por padrão, o app inicia em `http://localhost:3000`, portanto, a documentação observa que normalmente será necessário fazer o proxy de requisições de um servidor web ou alterar a porta para servi-lo diretamente. Várias opções de ambiente estão documentadas. O `API_URL` pode alterar a URL base usada para chamadas de API internas da UI; caminhos relativos são servidos sob `BASE_PATH`, enquanto URLs absolutas são processadas via proxy através da rota local `/api`. A `TWO_FACTOR_ENCRYPTION_KEY`, uma string hexadecimal de 64 caracteres gerada, por exemplo, com `openssl rand -hex 32`, habilita a autenticação de dois fatores; até que seja configurada, a autenticação de dois fatores estará indisponível e não poderá ser exigida. Para implantação em containers, o projeto publica imagens Docker e fornece um arquivo Docker compose que executa o Umami juntamente com um banco de dados PostgreSQL. As atualizações são gerenciadas seja baixando o código-fonte, reinstalando as dependências e reconstruindo, ou baixando novas imagens e recriando os containers com o Docker compose. Um guia detalhado de início rápido está hospedado no site de documentação do projeto.