OcoMon - versão 5.x

Data: Junho de 2023

Autor: Flávio Ribeiro (flaviorib@gmail.com)

Licença: GPLv3

IMPORTANTE:

Se você deseja instalar o OcoMon por conta própria, é necessário que saiba o que é um servidor WEB e esteja familiarizado com o processo genérico de instalação de sistemas WEB.

Para instalar o OcoMon é necessário ter uma conta com permissão de criação de databases no MySQL ou MariaDB e acesso de escrita à pasta pública do seu servidor web.

Antes de iniciar o processo de instalação ou atualização leia esse arquivo até o final.

REQUISITOS:


INSTALAÇÃO OU ATUALIZAÇÃO EM AMBIENTE DE PRODUÇÃO:

IMPORTANTE (em caso de atualização)

Atualização de versão:

Se a sua versão atual já é da série 5.x:

Alguns usuários tiveram acesso à prévia da versão 5 antes do lançamento oficial. Se este for o seu caso, entre em contato pelo ocomon.oficial@gmail.com para avaliarmos se é necessário atualizar a sua base de dados (dependendo da série da versão pode ser necessário atualizar o banco).

Se a sua versão atual é da série 4.x:

  1. Importe o arquivo de atualização do banco de dados “02-UPDATE_FROM_4.x.sql” (em install/5.x/):

     Ex. via linha de comando:
     mysql -u root -p [database_name] < /caminho_para_o_ocomon_5.x/install/5.x/02-UPDATE_FROM_4.x.sql
     
     Onde: [database_name]: É o nome do banco de dados do OcoMon
    
     PS: Se preferir, você pode utilizar um gerenciador de banco de dados como o phpMyAdmin, por exemplo, para importar o script SQL.
    
  2. Sobrescreva os scripts da sua versão pelos scripts da versão 5 (recomendado: mantenha apenas o seu arquivo de configurações “config.inc.php” e remova (ou mova para um diretório de backup) todos os demais scripts);

  3. Por questões de segurança, após a importação do SQL, remova a pasta install. Pronto! Basta ajustar as novas configurações da versão diretamente via interface administrativa.

Se a sua versão atual é a 3.3:

  1. Importe o arquivo de atualização do banco de dados “03-DB-UPDATE-FROM-3.3.sql” (em install/5.x/):

     Ex. via linha de comando:
     mysql -u root -p [database_name] < /caminho_para_o_ocomon_5.x/install/5.x/03-DB-UPDATE-FROM-3.3.sql
     
     Onde: [database_name]: É o nome do banco de dados do OcoMon
    
     PS: Se preferir, você pode utilizar um gerenciador de banco de dados como o phpMyAdmin, por exemplo, para importar o script SQL.
    
  2. Sobrescreva os scripts da sua versão pelos scripts da versão 5 (recomendado: mantenha apenas o seu arquivo de configurações “config.inc.php” e remova (ou mova para um diretório de backup) todos os demais scripts);

  3. Por questões de segurança, após a importação do SQL, remova a pasta install. Pronto! Basta ajustar as novas configurações da versão diretamente via interface administrativa.

Se a sua versão atual é a 3.2 ou 3.1 ou 3.1.1:

  1. Importe o arquivo de atualização do banco de dados “04-DB-UPDATE-FROM-3.2.sql” (em install/5.x/):

     Ex. via linha de comando:
     mysql -u root -p [database_name] < /caminho_para_o_ocomon_5.x/install/5.x/04-DB-UPDATE-FROM-3.2.sql
     
     Onde: [database_name]: É o nome do banco de dados do OcoMon
    
     PS: Se preferir, você pode utilizar um gerenciador de banco de dados como o phpMyAdmin, por exemplo, para importar o script SQL.
    
  2. Sobrescreva os scripts da sua versão pelos scripts da versão 5 (recomendado: mantenha apenas o seu arquivo de configurações “config.inc.php” e remova (ou mova para um diretório de backup) todos os demais scripts);

  3. Por questões de segurança, após a importação do SQL, remova a pasta install. Pronto! Basta ajustar as novas configurações da versão diretamente via interface administrativa.

Se a sua versão atual é a 3.0 (release final):

  1. Importe o arquivo de atualização do banco de dados “05-DB-UPDATE-FROM-3.0.sql” (em install/5.x/):

     Ex. via linha de comando:
     mysql -u root -p [database_name] < /caminho_para_o_ocomon_5.x/install/5.x/05-DB-UPDATE-FROM-3.0.sql
     
     Onde: [database_name]: É o nome do banco de dados do OcoMon
    
     PS: Se preferir, você pode utilizar um gerenciador de banco de dados como o phpMyAdmin, por exemplo, para importar o script SQL.
    
  2. Sobrescreva os scripts da sua versão pelos scripts da versão 5 (recomendado: mantenha apenas o seu arquivo de configurações “config.inc.php” e remova (ou mova para um diretório de backup) todos os demais scripts);

  3. Por questões de segurança, após a importação do SQL, remova a pasta install. Pronto! Basta ajustar as novas configurações da versão diretamente via interface administrativa.

Se a sua versão atual é qualquer uma das releases candidates(rc) da versão 3.0 (rc1, rc2, rc3):

  1. Importe o arquivo de atualização do banco de dados “06-DB-UPDATE-FROM-3.0rcx.sql” (em install/5.x/):

     Ex. via linha de comando:
     mysql -u root -p [database_name] < /caminho_para_o_ocomon_5.x/install/5.x/06-DB-UPDATE-FROM-3.0rcx.sql
     
     Onde: [database_name]: É o nome do banco de dados do OcoMon
    
     PS: Se preferir, você pode utilizar um gerenciador de banco de dados como o phpMyAdmin, por exemplo, para importar o script SQL.
    
  2. Sobrescreva os scripts da sua versão pelos scripts da versão 5 (recomendado: mantenha apenas o seu arquivo de configurações “config.inc.php” e remova (ou mova para um diretório de backup) todos os demais scripts);

  3. Por questões de segurança, após a importação do SQL, remova a pasta install. Pronto! Basta ajustar as novas configurações da versão diretamente via interface administrativa.

Se a sua versão atual é a versão 2.0 final


Se a sua versão atual é a versão 2.0RC6



Primeira instalação:

O processo de instalação é bastante simples e pode ser realizado seguindo 3 passos:

  1. Instalar os scripts do sistema:

    Descompacte o contéudo do pacote do OcoMon_5x no diretório público do seu servidor web (o caminho pode variar dependendo da distribuição ou configuração, mas de modo geral costuma ser /var/www/html/).

    As permissões dos arquivos podem ser as padrão do seu servidor (exceto para a pasta api/ocomon_api/storage, que precisa permitir escrita pelo usuário do Apache).

  2. Criação da base de dados:

    SISTEMA HOSPEDADO LOCALMENTE (localhost - Se o sistema será instalado em um servidor externo pule para a seção [SISTEMA EM HOSPEDAGEM EXTERNA]):

    Para a criação de toda a base do OcoMon, você precisa importar um único arquivo de instruções SQL:

    O arquivo é:

     01-DB_OCOMON_5.x-FRESH_INSTALL_STRUCTURE_AND_BASIC_DATA.sql (em /install/5.x/).
    

    Linha de comando (caso tenha acesso ao terminal):

     mysql -u root -p < /caminho_para_o_ocomon_5.x/install/5.x/01-DB_OCOMON_5.x-FRESH_INSTALL_STRUCTURE_AND_BASIC_DATA.sql
    

    O sistema irá solicitar a senha do usuário root (ou de qualquer outro usuário que tenha sido fornecido ao invés de root no comando acima) do MySQL.

    O comando acima irá criar o usuário “ocomon_5” com a senha padrão “senha_ocomon_mysql”, e a base de dados “ocomon_5” com todas as informações necessárias para a inicialização do sistema.

    É importante alterar essa senha do usuário “ocomon_5” no MySQL logo após a instalação do sistema.

    Caso prefira, você pode realizar a importação do arquivo SQL utilizando qualquer gerenciador de banco de dados de sua preferência, neste caso, não é necessário utilizar o terminal.

    Caso queira que a base e/ou usuario tenham outro nome (ao invés de “ocomon_5”), edite diretamente no arquivo (identifique as entradas relacionadas ao nome do banco, usuário e senha no início do arquivo):

     01-DB_OCOMON_5.x-FRESH_INSTALL_STRUCTURE_AND_BASIC_DATA.sql
    

    antes de realizar a importação do mesmo. Utilize essas mesmas informações no arquivo de configurações do sistema (passo 3).

    Após a importação, é recomendável a exclusão da pasta “install”.

    SISTEMA EM HOSPEDAGEM EXTERNA:

    Se o sistema será instalado em um servidor externo, nesse caso, em função de eventuais limitações de criação para nomenclatura de databases e usuários (geralmente o provedor estipula um prefixo para os databases e usuários), é recomendado utilizar o nome de usuário oferecido pelo próprio serviço de hosting ou então criar um usuário específico (se a sua conta de usuário permitir) diretamente pela sua interface de acesso ao banco de dados. Sendo assim:

  3. Criar o arquivo de configurações:

    Faça uma cópia do arquivo config.inc.php-dist (/includes/) e renomeie para config.inc.php. Nesse novo arquivo, confira e revise as informações relacionadas à conexão com o banco de dados (servidor, base de dados, usuário e senha).

VERSÃO PARA TESTES:

Caso queira testar o sistema antes de instalar, você pode rodar um container Docker com o sistema já funcionando com alguns dados já populados. Se você já possui o Docker instalado em seu ambiente, então basta executar o seguinte comando em seu terminal:

    docker run -it --name ocomon_5 -p 8000:80 flaviorib/ocomon_demo-5.0:20230627 /bin/ocomon

Em seguida basta abrir o seu navegador e acessar pelo seguinte endereço:

    localhost:8000

E pronto! Você já está com uma instalação do OcoMon prontinha para testes com os seguintes usuários cadastrados:

usuário Senha Descrição
admin admin Nível de administração do sistema
operador operador Operador padrão – nível 1
operador2 operador Operador padrão – nível 2
abertura abertura Apenas para abertura de ocorrências

Caso não tenha o Docker, acesse o site e instale a versão referente ao seu sistema operacional:

https://docs.docker.com/get-docker/

Ou então assista a esse vídeo para ver como é simples testar o OcoMon sem precisar de nenhuma instalação: https://www.youtube.com/watch?v=Wtq-Z4M9w5M

PRIMEIROS PASSOS

ACESSO

usuário: admin

senha: admin (Não esqueça de alterar esse senha tão logo tenha acesso ao sistema!!)

Novos usuários podem ser criados no menu [Admin::Usuários]

CONFIGURAÇÕES GERAIS DO SISTEMA

Algumas configurações precisam ser ajustadas dependendo da intenção de uso para o sistema:

INTEGRAÇÃO:

Acesse a documentação em https://ocomon.com.br/site/integracao/

DOCUMENTAÇÃO:

Toda a documentação do OcoMon está disponível no site do projeto e no canal no Youtube:

Doações

Amigos, como podem imaginar, o desenvolvimento e manutenção de um software livre para a comunidade é uma atividade dispendiosa que requer muita dedicação, motivação e esforço para que o projeto se mantenha relevante e continue agregando boas funcionalidades e evoluindo em diversos aspectos.

Conseguem imaginar a quantidade de tempo que é investido em planejamento, desenvolvimento, criação de material e suporte gratuito para a comunidade? Garanto que não é pouco.

Tudo isso ocorre pela crença na causa do Software Livre. Acreditar no software livre também é acreditar que juntos somos mais fortes e que dessa forma podemos obter realizações e fazermos a diferença.

Se o OcoMon lhe tem sido útil, poupado seu trabalho e lhe permitido direcionar seus recursos para outros investimentos, considere contribuir para a continuidade e crescimento do projeto: https://ocomon.com.br/site/doacoes/


Tenho convicção de que o OcoMon tem potencial para ser a ferramenta que lhe será indispensável na organização e gerência de sua área de atendimento liberando seu precioso tempo para outras realizações.

Bom uso!! :)

Entre em contato:

Flávio Ribeiro flaviorib@gmail.com