Documentação
Escrita na ordem em que as perguntas aparecem quando alguém avalia e instala o produto. A busca no topo (Ctrl + K) cobre todo o conteúdo.
1
Avaliar
Trinta minutos para saber se o produto resolve o seu problema — e o que ele não faz.
2
Instalar do zero
Do diretório vazio ao primeiro login, na ordem que evita refazer trabalho.
3
Operar no dia a dia
Colocar a operação de pé: fila, SLA, frota de agentes e integrações.
De que o produto é feito
Seção intitulada “ De que o produto é feito”Peças conhecidas, sem framework proprietário: o que você opera é o que a sua equipe já sabe operar. Os requisitos exatos de versão estão em Requisitos.
ReactInterface web — a mesma servida ao navegador e ao aplicativo Android
Node.jsServidor da aplicação — um contêiner sem estado
PostgreSQLTodos os dados, com busca textual por
pg_trgmArmazenamento S3Anexos e evidências em qualquer serviço compatível — MinIO inclusive
DockerDistribuição e execução —
compose v2 em qualquer LinuxOpenAPI 3.1510 operações geradas do roteamento real, para qualquer cliente de API
LDAP e Active DirectoryEntrada e papéis vindos do diretório que a organização já tem
TOTPSegundo fator por aplicativo autenticador, sem serviço externo
Entender o produto
Seção intitulada “ Entender o produto”O que é o OpenScalePara quem serve, o problema que resolve, e — sem rodeio — o que já está pronto e o que não existe.
Módulos e serviçosO que cada módulo entrega e qual permissão exige.
Mapa de rotasAs 119 rotas do produto e a guarda de cada uma, extraídas do código.
Instalar
Seção intitulada “ Instalar”RequisitosMáquina, banco, armazenamento e as variáveis que precisam estar certas antes de subir.
Instalação com DockerDo diretório vazio ao primeiro acesso, com o compose completo.
Primeiro acessoComo nasce o primeiro administrador — e por que isso exige um passo manual sem LDAP.
Autenticação: LDAP e TOTPLigar o diretório, mapear grupos para papéis e exigir segundo fator.
Topologia de referênciaComo as peças se organizam, e o tempo de leitura do proxy que quase todo mundo esquece.
Portas e exposiçãoO que precisa ser alcançável de fora — e o que nunca deve ser.
Dimensionamento de hardwareFaixas por volume de uso, com a medição e as premissas de cada número.
Guias práticos
Seção intitulada “ Guias práticos”O que a equipe abre no dia a dia — cada um percorre uma tarefa inteira, na ordem que evita refazer trabalho.
Criar uma pessoa e dar o acesso certoPessoa, papel, permissão e escopo: são quatro coisas diferentes, e fazer só uma produz alguém que entra e não vê nada.
Colocar a primeira fila em produçãoA ordem de configuração que evita refazer trabalho: grupos, escopo, categorias, SLA e catálogo.
Um chamado, quatro pontos de vistaO mesmo chamado por quem pede, pelo Scala, por quem atende e pelo catálogo de serviços.
Do cadastro ao primeiro itemAtivos na ordem certa: cadastros, itens, computadores que chegam sozinhos e empréstimo com aceite.
Instalar o agente em uma frotaToken de lote, instalação silenciosa por política de grupo e o que conferir depois.
Agentes e aplicativos
Seção intitulada “ Agentes e aplicativos”Cliente WindowsO que o agente coleta, como uma máquina entra na frota e o custo em disco da cadência.
Aplicativo AndroidO que ele acrescenta ao navegador do celular — e o que ele não faz.
Integrar
Seção intitulada “ Integrar”Primeiros passos com a APIAs duas rotas de que você precisa, e a terceira de nome quase igual que não serve.
Especificação OpenAPIBaixar as 510 operações e consumir em um cliente de API.
Segurança e conformidade
Seção intitulada “ Segurança e conformidade”Permissões e papéisOs quatro eixos do controle de acesso, e o catálogo completo extraído do produto.
Dados pessoais e LGPDO que é tratado, onde fica, e o que você precisa decidir antes de instalar.