Estrutura
Estrutura do Sistema Accessus
Este manual tem por objetivo demonstrar a estrutura do sistema, bem como esclarecer o papel de determinados arquivos e comandos do sistema. Antes de iniciar a instalação do sistema, leia sobre:
➟ Instalação Completa do Sistema
Atenção:
Para iniciar a instalação do sistema Accessus, é necessário antes, a instalação do Docker e do Docker Compose.
Diretório do Sistema
É necessário criar um diretório local para a instalação do sistema Accessus.
1. Diretório "/toptic"
mkdir /toptic
Arquivos do Sistema
Todos os arquivos importantes do sistema Accessus ficam contidos no diretório "/toptic":
1. data
Neste diretório ficam armazenados os dados do sistema. É nesse diretório que o banco de dados escreve e lê cada registro.
/toptic/data/
2. toptic-deploy
Contém os arquivos de configuração para implantação da aplicação.
/toptic/toptic-deploy/
Nesse diretório é possível encontrar os seguintes arquivos:
➟ .env
Armazena os parâmetros do ambiente de instalação do sistema. É nele que o sistema consulta informações antes de inicializar, além da possibilidade de definir o nível de logs, timezone do sistema, portas que rodam cada microsserviço e verificação/alteração da senha do banco de dados.
/toptic/toptic-deploy/.env
➟ toptic.conf.sample
Arquivo de exemplo que permite o cliente salvar preferências da sua instalação. Para se tornar válido, é preciso copiá-lo e alterar o seu nome para "/toptic/toptic.conf". Desta forma é possível definir quais módulos do sistema estão ativos por padrão, faixa de rede para o Docker e também apontar o caminho para os certificados SSL customizados.
cp /toptic/toptic.conf.sample /toptic/toptic.conf
➟ scripts
Contém os scripts do sistema, entre eles o script que possibilita o funcionamento da CLI "toptic".
/toptic/toptic-deploy/scripts/
Comandos do Sistema
O sistema Accessus possui diferentes comandos para as funções do sistema como veremos a seguir:
1. Iniciar aplicação
toptic start
2. Parar aplicação
toptic stop
3. Reiniciar aplicação
toptic restart
4. Registrar token do cliente
toptic register -t <licenseKey>
5. Criar despejo de banco de dados
toptic dump -o <dumpFile>
6. Restaurar banco de dados
toptic restore -f <dumpFile>
7. Visualizar logs do Accessus
Para visualização completa dos logs do sistema Accessus:
toptic logs
8. Limitar a visualização dos logs
Para visualização dos logs exclusivamente de um serviço (ex: eventus):
docker compose -f toptic-deploy.yml logs -f toptic_eventus
Para limitar o número de linhas de logs, utilize a opção --tail <numero-linhas>:
docker compose -f toptic-deploy.yml logs -f toptic_eventus --tail 1000
9. Configurar CLI toptic
toptic configure-cli
10. Iniciar somente banco de dados e flyway
toptic database
11. Atualizar versão
toptic update
12. Exibir versão
toptic version
13. Exibir ajuda
toptic help
CLI do Sistema Accessus
Para conhecer todos os comandos disponíveis via CLI, acesse o terminal e digite o comando:
toptic --help
1. Lista dos comandos do sistema:
| Comandos do sistema | Descrição dos comandos |
|---|---|
| start | Iniciar serviços |
| stop | Parar serviços |
| restart | Reiniciar serviços |
| register | Registrar token do cliente |
| dump | Criar despejo de banco de dados |
| restore | Restaurar banco de dados |
| logs | Ver logs do Accessus |
| help, -h, --help | Imprime na tela ajuda |
| version, -v, --version | Imprime na tela versão |
| configure-cli | Configurar CLI toptic |
| database | Iniciar serviços somente de banco de dados e flyway |
| update | Atualizar versão |
2. Lista das opções do sistema:
| Opções do sistema | Descrição das opções |
|---|---|
| --dev | Ativa o modo dev (usado com comandos "start" ou "restart") |
| -t, --clientToken \<token> | Define o token do cliente (usado com o comando "register") |
| -o, --outputFile \<filename> | Saída de despejo do banco de dados para um arquivo (usado com o comando "dump") |
| -f, --fileLocation \<filename> | Configura o arquivo para restaurar o banco de dados (usado com o comando "restore") |
| --debug-accessus | Habilita o modo de depuração (usado com os comandos "start" ou "restart") |
| --debug-eventus | Habilita o modo de depuração (usado com os comandos "start" ou "restart") |
Serviço NTP
Atenção:
É fundamental que o horário esteja corretamente sincronizado em todas as controladoras gerenciadas pelo sistema. Deste modo, preferencialmente, é recomendável o uso de um serviço NTP.
Acesse: Serviço NTP