VIVO Documentation
Old Release
This documentation relates to an old version of VIVO, version 1.9.x. Looking for another version? See all documentation.
Instalar el software necesario
Antes de instalar VIVO asegúrate de tener instalados los siguientes programas en tu computadora:
- Java (SE) 1.7.x Plataforma Java (JDK)
- VIVO no ha sido probado con OpenJDK
- Apache Tomcat 6.x or 7.x http://tomcat.apache.org
- Apache Ant 1.8 o superior, http://ant.apache.org
- MySQL 5.1 o superior, http://www.mysql.com
Verifica si tienes habilitadas las variables de entorno JAVA_HOME y ANT_HOME al sistema. La configuración de estos requerimientos depende del sistema operativo que estés usando. Consulta las guías de instalación de cada programa para realizar la correcta configuración.
Los siguientes navegadores están soportados para esta versión:
- Mac:
- Chrome 30.0.1599.69 o superior
- FireFox 3.6.28, 10.0.12, 24
- Opera 12.02
- Safari 5.0.3
- PC:
- Chrome 25.1364.2 o superior
- FireFox 10.0.12, 24
- Internet Explorer 8, 9, 10
- Opera 12.02
Funcionó?
Puedes probar la instalación de los programas escribiendo los siguientes comandos:
[~]# java -version java version "1.7.0_25" Java(TM) SE Runtime Environment (build 1.7.0_25-b15) Java HotSpot(TM) 64-Bit Server VM (build 23.25-b01, mixed mode) [~]# mysql --version mysql Ver 14.14 Distrib 5.5.36, for Linux (x86_64) using readline 5.1 [~]# ant -version Apache Ant(TM) version 1.9.1 compiled on May 15 2013
Cada uno de estos comandos va a imprimir las versiones que tienes instaladas. Si alguno de estos comandos imprime un mensaje de error, debes revisar la instalación.
Crear una base de datos vacía y una cuenta de base de datos
Decide un nombre de base de datos, usuario y contraseña. Vas a necesitar estos valores para este paso y otra vez cuando especifiques las propiedades de ejecución.
Inicia sesión en tu servidor de MySQL y crea una nueva base de datos que use la codificación de caracteres en formato UTF-8. En la línea de comandos de MySQL puedes crear la base de datos y el usuario con los siguientes comandos sustituyendo los valores para base_datos, usuario y contraseña. Generalmente el nombre del equipo es llamado localhost.
CREATE DATABASE base_datos CHARACTER SET utf8; GRANT ALL ON base_datos.* TO usuario@'localhost' IDENTIFIED BY 'contraseña';
Construir VIVO
Descarga el código fuente de VIVO
Descarga el código fuente de VIVO desde los enlaces disponibles de descarga con los nombres: rel-1.6.zip o rel-1.6.gz y descomprímelos en tu servidor web. Puedes descargar el archivo desde el siguiente enlace: http://vivoweb.org/download
Especifica las propiedades de construcción
Dentro del directorio de distribución de VIVO, renombra el archivo example.build.properties a build.properties. Edita el archivo para adaptarlo a tu instalación, como se describe en la siguiente sección.
Estas propiedades son usadas cuando se compila VIVO y al momento de desplegar dentro de Tomcat. Estas van a ser incorporadas dentro de VIVO cuando esté totalmente compilado. Si quieres cambiar estas propiedades en otro momento, deberás detener el servicio de Tomcat, repetir el paso de compilar y desplegar, al final, deberás reiniciar el servicio de Tomcat para ver estos cambios.
Nombre de la propiedad | vitro.core.dir |
Descripción | El directorio donde Vitro esta ubicado. En la instalación simple, es asignado a ./vitro-core, el directorio actual. |
Valor predeterminado | Ninguno |
Valor de ejemplo | ./vitro-core |
Nombre de la propiedad | tomcat.home |
Descripción | El directorio donde tomcat está instalado. |
Valor predeterminado | Ninguno |
Valor de ejemplo | /usr/local/tomcat |
Nombre de la propiedad | webapp.name |
Descripción | El nombre de tu aplicación VIVO. Este no es el nombre que va a ser mostrado al usuario. Este nombre aparece en la URL usada para acceder a VIVO, y el nombre de la ruta del directorio VIVO dentro de tomcat. |
Valor predeterminado | Ninguno |
Valor de ejemplo | vivo |
Nombre de la propiedad | vitro.home |
Descripción | Es el directorio donde VIVO va a almacenar los datos que son creados. Esto incluye archivos cargados (usualmente imágenes) y los índices de búsqueda Solr. Asegúrate de que el directorio existe y que es escribible por el servidor Tomcat. |
Valor predeterminado | Ninguno |
Valor de ejemplo | /usr/local/vivo/home |
Compilar y desplegar
En pasos anteriores, has definido la ubicación del directorio de VIVO, especificando en valor de la propiedad vitro.home en el archivo build.properties. Si el directorio no existe, créalo ahora.
En la línea de comandos, dentro del directorio de distribución de VIVO, escribe el siguiente comando:
ant all
para construir VIVO y desplegarlo dentro del directorio webapps de Tomcat.
El script de construcción puede correr hasta por cinco minutos, y crear mas de 100 líneas de salida, el proceso incluye varios pasos:
- Recolectar los archivos fuente del directorio de distribución.
- Compilar el código fuente Java.
- Correr pruebas unitarias.
- Preparar el motor de búsqueda Solr.
- Desplegar Vivo y Solr a Tomcat.
Funcionó?
Si el mensaje de salida finaliza con éxito, entonces la construcción ha terminado correctamente. Procede al siguiente paso.
BUILD SUCCESSFUL
Total time: 1 minute 49 seconds
Si la salida termina con un mensaje de error, la construcción ha fallado. Encuentra la falla del error, corrige el problema, y corre el script otra vez.
BUILD FAILED
Total time: 35 seconds
La salida de construcción puede incluir mensajes de advertencia. El compilador de java puede advertir sobre código obsoleto. Las pruebas de unidad pueden producir mensajes de advertencia, y algunas pruebas pueden ser ignoradas si no producen resultados consistentes. Si la salida finaliza con un mensaje de éxito, estos mensajes van a ser ignorados.
Ejecutar VIVO
Configurar Tomcat
Asignar parámetros JVM
VIVO copia pequeñas secciones de tu base de datos RDF dentro de la memoria para servir peticiones web rápidamente (la copia en memoria y la base de datos se mantiene en sincronía cuando se realizan ediciones).
VIVO puede requerir más memoria asignada que la que tiene Tomcat de forma predeterminada. Como muchas instalaciones de Tomcat, el archivo setenv.sh o setenv.bat en el directorio bin de Tomcat es un lugar conveniente para asignar los parámetros de memoria. Si este archivo no existe dentro de los directorios de Tomcat, puedes crearlo.
Por ejemplo:
export CATALINA_OPTS="-Xms512m -Xmx512m -XX:MaxPermSize=128m"
Esto le dice a tomcat que asigne un valor inicial de 512 megabytes, valor máximo de 512 megabytes, y un espacio de 128 megas a PermGem. Valores inferiores pueden ser insuficientes, especialmente para pequeñas pruebas de instalación.
Configurar límites de seguridad
Vivo es una aplicación web multiproceso que puede requerir mas hilos de los que están permitidos en la configuración predeterminada de tu instalación de Linux. Asegúrate que tu instalación puede soportar el numero de hilos requeridos editando las siguientes líneas en el archivo /etc/security/limits.conf:
apache hard nproc 400 tomcat6 hard nproc 1500
Configurar codificación URI
Para que VIVO maneje correctamente caracteres internacionales, tienes que configurar a Tomcat conforme al estándar de codificación de caracteres UTF-8.
Edita el archivo conf/server.xml y agrega los siguientes atributos para cada elemento Connector:
URIEncoding="UTF-8"
<Server ...> <Service ...> <Connector ... URIEncoding="UTF-8" /> ... </Connector> </Service> </Server>
Tenga cuidado al crear elementos de contexto
Cada aplicación web en la distribución de VIVO (VIVO y Solr) incluye un archivo “fragmento de contexto”, que contiene información de despliegue para la aplicación web.
Tomcat permite que anules estos fragmentos de contexto agregando elementos de contexto Context al archivo server.xml. Si decides hacer esto, asegúrate de que el nuevo elemento de contexto incluye los necesarios parámetros de despliegue a partir del fragmento de contexto reemplazado.
Observa la sección titulada Corriendo Vivo detrás de un Servidor Apache para un ejemplo de reemplazo de fragmento de contexto en VIVO.
Propiedades de ejecución
En el proceso de construcción de VIVO, específicamente en la Compilación y despliegue, se creo un archivo llamado example.runtime.properties en el directorio inicial de VIVO (especificado por vitro.home en el archivo build.properties), renombra este archivo a runtime.properties y edita el archivo de acuerdo a tu instalación, como se describe abajo.
Estas propiedades son cargadas cuando VIVO inicia. Si quieres cambiar estas propiedades en una fecha posterior, necesitas reiniciar Tomcat para que los cambios surtan efecto. No necesitas repetir el paso de compilar y desplegar.
Propiedades básicas
Estas propiedades definen algunos aspectos fundamentales de la instalación de VIVO. Muchos sitios van a necesitar modificar todos estos valores.
Nombre de la propiedad | Vitro.defaultNamespace |
Descripción | El espacio de nombre predeterminado RDF para esta instalación.
La instalación de VIVO hace sus recursos RDF disponibles para cosecha usando datos vinculados. Las solicitudes de URI de recursos RDF redirigen a HTML o RDF según lo que haya especificado el cliente. Para hacer esto posible, el espacio de nombres por defecto de VIVO debe tener una cierta estructura y empezar con una dirección web pública de la instalación de VIVO. Por ejemplo, si la dirección web de una instalación de VIVO es http://vivo.example.edu/ el espacio de nombres debe ser asignado a http://vivo.example.edu/individual con el fin de soportar datos vinculados. Del mismo modo, si VIVO esta instalado en http://www.example.edu/vivo el espacio de nombres debe ser asignado a http://www.example.edu/vivo/individual
*El espacio de nombre debe terminar con “individual/” (incluyendo la barra diagonal). |
Valor predeterminado | Ninguno |
Valor de ejemplo |
Nombre de la propiedad | rootUser.emailAddress |
Descripción | Especifica la dirección de correo electrónico de la cuenta de usuario principal de la aplicación VIVO. Este usuario tendrá una contraseña inicial temporal: rootPassword. Se te pedirá que crees una nueva contraseña en el primer inicio de sesión.
Nota: La cuenta de usuario principal tiene acceso a todos los datos y todas las operaciones en VIVO. Las vistas de datos pueden ser sorprendentes cuando se esta como usuario principal. Es mejor crear una cuenta de administrador de sitio para usarlo en cada tarea administrativa. |
Valor predeterminado | Ninguno |
Valor de ejemplo |
Nombre de la propiedad | VitroConnection.DataSource.url |
Descripción | Especifica la URL JDBC de tu base de datos. Cambia el final de la URL con el nombre de tu base de datos (Si esta no es “vivo”). |
Valor predeterminado | Ninguno |
Valor de ejemplo |
Nombre de la propiedad | VitroConnection.DataSource.username |
Descripción | Cambia el nombre de usuario que coincida con el usuario autorizado que has creado para MySQL. |
Valor predeterminado | Ninguno |
Valor de ejemplo | nombre_usuario |
Nombre de la propiedad | VitroConnection.DataSource.password |
Descripción | Cambia la contraseña que coincida con la que diste de alta en MySQL. |
Valor predeterminado | Ninguno |
Valor de ejemplo | contrasenia |
Nombre de la propiedad | email.smtpHost |
Descripción | Especifica un servicio SMTP que la aplicación va a usar para enviar correos electrónicos (opcional). Si este se deja vacío, el formulario de contacto va a estar oculto y deshabilitado, y los usuarios no van a ser notificados de los cambios en sus cuentas. |
Valor predeterminado | Ninguno |
Valor de ejemplo | smtp.servidor.edu |
Nombre de la propiedad | email.replyTo |
Descripción | Especifica una dirección de correo electrónico el cual va a aparecer como remitente en notificaciones vía e-mail a los usuarios (opcional). Si un usuario contesta la notificación, esta dirección va a recibir la respuesta. Si una dirección de correo electrónico de usuario es inválida, esta dirección va a recibir el mensaje de error. Si este se deja vacío, los usuarios no van a ser notificados de cambios en sus cuentas. |
Valor predeterminado | Ninguno |
Valor de ejemplo |
Conectando el índice de búsqueda Solr
VIVO y el índice de búsqueda están actualmente en dos distintas aplicaciones web, y la instalación simple pone a los dos en la misma instancia de Tomcat. Aun así, hay que decirle a la aplicación VIVO como llegar a la aplicación web Solr.
Nombre de la propiedad | vitro.local.solr.url |
Descripción | La URL en el contexto de Solr usada en la búsqueda local de VIVO. Debe consistir en:
scheme + servername + port + vivoweb_app_name + “solr”
En la instalación estándar, el contexto de Solr va a estar en el mismo servidor como VIVO, y en la misma instancia de Tomcat. La ruta de VIVO tiene que ser webapp.name (especificado abajo) + “solr” |
Valor predeterminado | Ninguno |
Valor de ejemplo |
Propiedades adicionales
El archivo runtime.properties puede aceptar muchas propiedades adicionales, pero no son necesarias para esta instalación simple. Si tu eliges alguna de las opciones de instalación, probablemente vas a necesitar configurar algunas de estas propiedades.
Iniciar Tomcat
Muchas de las instalaciones de Tomcat pueden ser iniciadas corriendo los siguientes archivos startup.sh o startup.bat en el directorio bin de Tomcat. Inicia Tomcat y dirigete a tu navegador a http://localhost:8080/vivo para probar la aplicación.
Observa que Tomcat puede requerir varios minutos en iniciar VIVO.
Al iniciar VIVO, se ejecutarán algunas pruebas de diagnóstico. Si un problema es detectado la página inicial de VIVO redireccionará a la página de estatus de inicio que describe el problema. Puedes detener Tomcat, corregir el problema y procede al paso de compilar y desplegar. Si el problema no es serio, la página de estatus de inicio puede proporcionar un enlace de “continuar” el cual te va a permitir usar VIVO a pesar de los problemas.
Si el inicio ha sido correcto, vas a observar la página de inicio de VIVO.
Si tomcat no inicia, o la aplicación VIVO no es visible, revisa los archivos en el directorio logs de Tomcat.
Los mensajes de error se pueden encontrar en [tomcat]/logs/catalina.out, [tomcat]/logs/vivo.all.log o [tomcat]/logs/localhost.log.