diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 0000000..24cfbaa --- /dev/null +++ b/.gitmessage @@ -0,0 +1,23 @@ +# Faça um breve resumo das alterações +# Devemos escrever nosso comentário de forma a completar a frase abaixo, utilizando o verbo no presente. +# Esse commit: +# +# Exemplos: +# Corrige erro de sessão +# Adiciona funcionalidade de cadastro de livros +# |<---- Use no máximo 50 caracteres ---->| + + +# +# Descreva o que foi realizado no commit. +# +# Procure responder as três perguntas: "O que?", "Como?" e "Porquê?" +# |<--- Tente limitar as linhas para terem no maximo 72 caracteres --->| + + +# +# Número do ticket da ferramenta de controle utilizada. +# Exemplo: +# OTRS - 2017030220001019 +# OS - 050/2016 + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c953140 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Gerenciador de templates - Interface web de utilização do [templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) +O Gerenciador de Templates é o sistema responsável por gerenciar os modelos de documentos que são ofertados pelo [templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker), ele serve como uma espécie de IDE para edição dos modelos. O propósito do sistema é permitir que os usuários possam interagir diretamente com os modelos de documentos. + +## Requisitos +- Código-fonte do Gerenciador de Templates pode ser baixado a partir do link [https://softwarepublico.gov.br/gitlab/ans/gerenciador-de-templates/tags](https://softwarepublico.gov.br/gitlab/ans/gerenciador-de-templates/tags) +- [Apache Maven](https://maven.apache.org/) para baixar as dependências e compilar o pacote. +- Servidor [JBoss EAP 7.0.4](https://developers.redhat.com/products/eap/download/) ou [Wildfly 10](http://wildfly.org/downloads/). +- [Templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) implantado e configurado. +- Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências. + +## Procedimentos para instalação +### Criar e configurar os arquivos de propriedades no JBoss +O Gerenciador de Templates faz uso de dois arquivos de propriedades que ficam na pasta `\ans\properties`, os arquivos necessários são `services.properties` e `ws-users.properties`. Abaixo as propriedades que se fazem necessárias nestes arquivos. + + + + + + + + + + + + + + + + + + + + + +
ArquivoPropriedadeDescrição
services.propertiestemplates.broker.uriURL do templates-broker
ws-users.propertiestemplates.web.userUsuário utilizado para se autenticar no broker
templates.web.passwordSenha do usuário utilizado para se autenticar no broker
+ +### Criar security-domain no JBoss +É necessário que haja um security-domain registrado com o nome `ans-form-auth`, o mesmo pode utilizar um banco de dados[^1] ou o LDAP. É importante destacar que o sistema trabalha com autorização baseada em papéis(RBAC[^2]) e que os usuários precisam ter seus papéis atribuídos. No caso do Gerenciador de Templates os usuários precisam ter o papel `usuario_interno`, essa configuração pode ser alterada no `web.xml`. +[^1]: https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html/how_to_configure_identity_management/configuring_a_security_domain_to_use_a_database +[^2]: https://en.wikipedia.org/wiki/Role-based_access_control + +### Implantar pacote gerado pelo Maven +Após a realização de todos os passos anteriores, teremos o JBoss pronto para receber o pacote do Gerenciador de Templates. O deploy pode ser feito de diversas maneiras e não é o foco desse manual. + +Para essa etapa é necessário ter o Maven instalado e configurado. Ao realizar o primeiro build devemos desabilitar os testes automatizados, os testes dependem de uma instância ativa e impedirão a geração do pacote. -- libgit2 0.21.2