Manual de instalación de Viafirma Documents

Instalación

Revisión: 18-nov-2019

Carpeta de configuración DOCUMENTS_HOME

  • Crea una carpeta de configuración que usaremos más adelante para definir la variable DOCUMENTS_HOME. También usaremos esta carpeta más adelante en los ajustes de arranque del Apache Tomcat.
  • una vez creada ya puedes copiar en ella el contenido de la carpeta DOCUMENTS_HOME de tu KIT DE INSTALACIÓN.

Configuración

config.properties

Dentro de la carpeta DOCUMENTS_HOME tienes el fichero general de propiedades, config.properties. Revisa que contiene la configuración adecuada que te permita arrancar por primera vez Viafirma Documents. Podrás completar el resto de configuración avanzada en otro momento.

La siguiente configuración mínima te permitirá arrancar Viafirma Documents:

URL_PROTOCOL=http

JDBC_DRIVER=org.postgresql.Driver
JDBC_URL=jdbc:postgresql://127.0.0.1:5432/vdocuments
JDBC_USER=myUser
JDBC_PASSWORD=****

Existen diferentes formas de instalar Viafirma Documents dependiendo de la carga de trabajo esperada por el sistema. Es posible instalar una o varias instancias del modulo de tareas y del modulo de jobs. Para una instalación brásica con los dos modulos integrados se configurará de la siguiente forma:

JOBS_BACKEND_INTEGRATION=true
TASKS_BACKEND_INTEGRATION=true

Si se desea desacoplar alguno de los modulos habrá que indicar estos parámetros a "false". Se ejecutarán como JAR/s independientes.

Para conocer todas las opciones de configuración revisa el capítulo de Configuración.

logback.xml

También encontrarás dentro de la carpeta de configuración el fichero logback.xml, que se utiliza para configurar todo el sistema de LOGS del producto. En el siguiente enlace encontrarás la documentación oficial del framework con las opciones de configuración:

Configuración logback.xml

Ajustes en Apache Tomcat

A continuación te explicamos los ajustes recomendados en servicio de arranque del servidor, modificando el Catalina.sh:

CATALINA_OPTS="-Dfile.encoding=UTF-8 -Dcom.sun.management.jmxremote
-Djava.awt.headless=true -Xmx1512M -server -Xms512M  -XX:NewSize=128m
-XX:MaxNewSize=256m -XX:SurvivorRatio=5 -XX:TargetSurvivorRatio=30
-XX:PermSize=128m -XX:MaxPermSize=256m -Xincgc -XX:+CMSIncrementalMode
-XX:+CMSIncrementalPacing -XX:+CMSParallelRemarkEnabled -XX:+UseParNewGC
-XX:+UseTLAB -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled
-Dsun.jnu.encoding=ISO-8859-15 -Djava.net.preferIPv4Stack=true -Dviafirma.documents.home.path=/home/viafirma/documents-home"
CATALINA_PID=/tmp/tomcat.pid

Nota: fíjate que agregamos el path donde se encuentra la carpeta donde puedes dejar el fichero de configuración. Revisa que coincide con tu path de instalación y en caso contrario puedes modificarlo.

Dviafirma.documents.home.path={ruta donde se encuentra la carpeta documents-home}

Deploy

En este punto ya tienes todo preparado para desplegar Viafirma Documents, para ello sólo tienes que copiar documents-web.war incluido en el KIT DE INSTALACIÓN en el directorio webapp de tu Apache Tomcat.

Una vez desplegado, Viafirma Documents se publicará por defecto en la URL http://localhost:8080/documents-web

Para realizar la instalación del módulo Api Rest sólo tienes que copiar documents.war incluido en el KIT DE INSTALACIÓN en el directorio webapp de tu Apache Tomcat junto con el war del backend documents-web.war, de forma que estarán los 2 wars instalados en el mismo Tomcat.

Licencia

Para el primer acceso tendrás que informar la licencia contenida en tu KIT DE INSTALACIÓN. Para ello ve a la URL de licencia y la adjuntas:

http://localhost:8080/documents-web/license