Commit 79d307f66cafd9851c0e4826904f5c4dec14fad3
1 parent
e8072cfc
Exists in
master
Cria README.md para o SPB
Cria arquivo com instruções e informações sobre o sistema para inclusão no Portal do Software Público.
Showing
2 changed files
with
68 additions
and
0 deletions
Show diff stats
... | ... | @@ -0,0 +1,23 @@ |
1 | +# Faça um breve resumo das alterações | |
2 | +# Devemos escrever nosso comentário de forma a completar a frase abaixo, utilizando o verbo no presente. | |
3 | +# Esse commit: <Seu resumo> | |
4 | +# | |
5 | +# Exemplos: | |
6 | +# Corrige erro de sessão | |
7 | +# Adiciona funcionalidade de cadastro de livros | |
8 | +# |<---- Use no máximo 50 caracteres ---->| | |
9 | + | |
10 | + | |
11 | +# | |
12 | +# Descreva o que foi realizado no commit. | |
13 | +# | |
14 | +# Procure responder as três perguntas: "O que?", "Como?" e "Porquê?" | |
15 | +# |<--- Tente limitar as linhas para terem no maximo 72 caracteres --->| | |
16 | + | |
17 | + | |
18 | +# | |
19 | +# Número do ticket da ferramenta de controle utilizada. | |
20 | +# Exemplo: | |
21 | +# OTRS - 2017030220001019 | |
22 | +# OS - 050/2016 | |
23 | + | ... | ... |
... | ... | @@ -0,0 +1,45 @@ |
1 | +# Gerenciador de templates - Interface web de utilização do [templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) | |
2 | +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. | |
3 | + | |
4 | +## Requisitos | |
5 | +- 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) | |
6 | +- [Apache Maven](https://maven.apache.org/) para baixar as dependências e compilar o pacote. | |
7 | +- Servidor [JBoss EAP 7.0.4](https://developers.redhat.com/products/eap/download/) ou [Wildfly 10](http://wildfly.org/downloads/). | |
8 | +- [Templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) implantado e configurado. | |
9 | +- Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências. | |
10 | + | |
11 | +## Procedimentos para instalação | |
12 | +### Criar e configurar os arquivos de propriedades no JBoss | |
13 | +O Gerenciador de Templates faz uso de dois arquivos de propriedades que ficam na pasta `<JBOSS_HOME>\ans\properties`, os arquivos necessários são `services.properties` e `ws-users.properties`. Abaixo as propriedades que se fazem necessárias nestes arquivos. | |
14 | + | |
15 | +<table class="tg"> | |
16 | + <tr> | |
17 | + <th>Arquivo</th> | |
18 | + <th>Propriedade</th> | |
19 | + <th>Descrição</th> | |
20 | + </tr> | |
21 | + <tr> | |
22 | + <td>services.properties</td> | |
23 | + <td>templates.broker.uri</td> | |
24 | + <td>URL do templates-broker</td> | |
25 | + </tr> | |
26 | + <tr> | |
27 | + <td rowspan="2">ws-users.properties</td> | |
28 | + <td>templates.web.user</td> | |
29 | + <td>Usuário utilizado para se autenticar no broker</td> | |
30 | + </tr> | |
31 | + <tr> | |
32 | + <td>templates.web.password</td> | |
33 | + <td>Senha do usuário utilizado para se autenticar no broker</td> | |
34 | + </tr> | |
35 | +</table> | |
36 | + | |
37 | +### Criar security-domain no JBoss | |
38 | +É 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`. | |
39 | +[^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 | |
40 | +[^2]: https://en.wikipedia.org/wiki/Role-based_access_control | |
41 | + | |
42 | +### Implantar pacote gerado pelo Maven | |
43 | +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. | |
44 | + | |
45 | +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. | ... | ... |