VIVO Documentation
Page History
Table of Contents
Install the necessary software
Before installing VIVO sure you have the following programs installed on your computer
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 Platform (JDK)
- VIVO no ha sido probado con has not been tested with OpenJDK
- Apache Tomcat 6.x or 7.x http://tomcat.apache.org
- Apache Ant 1.8 o superioror higher, http://ant.apache.org
- MySQL 5.1 o superioror higher, 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.
Check if you have enabled and ANT_HOME variables JAVA_HOME system environment. The configuration of these requirements depends on the operating system you are using. Check the installation guides for each program to make the correct settings.
The following browsers are supported for this releaseLos siguientes navegadores están soportados para esta versión:
- Mac:
- Chrome 30.0.1599.69 o superioror higher
- FireFox 3.6.28, 10.0.12, 24
- Opera 12.02
- Safari 5.0.3
- PC:
- Chrome 25.1364.2 o superioror higher
- FireFox 10.0.12, 24
- Internet Explorer 8, 9, 10
- Opera 12.02
Funcionó?
It worked?
You can try installing the programs by typing the following commandsPuedes probar la instalación de los programas escribiendo los siguientes comandos:
Code Block | ||
---|---|---|
| ||
[~] # javaJava -version 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.252325-b01, mixed mode) [~] # mysqlMysql --version version mysql VerView 14.14 Distrib 5.5.36, for Linux (x86_64) using readline 5.1 1 [~] # antAnt -version 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.
Each of these commands will print versions you have installed. If any of these commands print an error message, you must check the installation.
Create an empty database and account database
Decide on a database name, user name and password. You will need these values for this step and again when specify runtime properties.
Login to your MySQL server and creates a new database that uses the character encoding in UTF-8 format. In the MySQL command line you can create the database and the user with the following commands substituting values for database, user and password. Usually the computer name is called 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.
Code Block | ||
---|---|---|
| ||
CREATE DATABASE base_datos CHARACTER SET utf8; for database; GRANT ALL ON base_datos.* TO usuario@ for database user @ 'localhost' IDENTIFIED BY 'contraseñapassword.'; |
Construir VIVO
Descarga el código fuente de VIVO
build LIVE
Download the source code VIVO
Download the source code from the available links LIVE download with namesDescarga el código fuente de VIVO desde los enlaces disponibles de descarga con los nombres: rel-1.6.zip o or rel-1.6.gz y descomprímelos en tu servidor web. Puedes descargar el archivo desde el siguiente enlaceand unzip on your web server. You can download the file from the following link: 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.
Specifies the properties of construction
Within the VIVO distribution directory, renames the file build.properties example.build.properties. Edit file to meet your installation, as described in the next section.
These properties are used when compiling VIVO and when deployed within Tomcat. These will be incorporated into LIVE when fully compiled. If you want to change these properties later, you must stop the Tomcat service, repeat step compile and deploy, in the end, you must restart the Tomcat to see these changes.
Note |
---|
Windows: To install on a Windows operating system, you must include the letter of the hard drive, you must use the slash "/" and not the backslash "\" in the directory path, for example |
Note |
Windows: Para instalar en un sistema operativo Windows, debes incluir la letra de la unidad de disco duro, debes usar la diagonal “/” y no la diagonal invertida “\” en la ruta de directorios, por ejemplo c: / tomcat |
Nombre de la propiedadProperty Name | vitro.core.dir | ||
Description | The directory where Vitro is located. In the simple installation, it is assigned to | Descripción | El directorio donde Vitro esta ubicado. En la instalación simple, es asignado a ./vitro-core, el directorio actualthe current directory. |
Valor predeterminadodefault | Ninguno | Any | |
Example valueValor de ejemplo | ./vitro-core |
Nombre de la propiedadProperty Name | tomcat.home | ||
Descripción | El directorio donde tomcat está instalado. | ||
Valor predeterminado | Ninguno | ||
Description | The directory where tomcat is installed. | ||
default | Any | ||
Example value | / Usr | Valor de ejemplo | /usr / local / tomcat |
Nombre de la propiedadProperty Name | 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 |
Description | The name of your VIVO application. This is not the name that will be displayed to the user. This name appears in the URL used to access LIVE, and the name of the directory path VIVO within tomcat. |
default | Any |
Example value | alive |
Property NameNombre 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.
Description | It is the directory where VIVO will store the data that are created. This includes uploaded files (usually images) and Solr search indexes. Make sure the directory exists and is writable by the Tomcat server. |
default | Any |
Example value | / Usr / local / live / home |
Compile and deploy
In previous steps, you have defined directory location VIVO, specifying property values in the build.properties file vitro.home. If the directory does not exist, create it now.
In the command line within the VIVO distribution directory, type the following commandEn la línea de comandos, dentro del directorio de distribución de VIVO, escribe el siguiente comando:
Code Block | ||
---|---|---|
| ||
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ó?
VIVO to build and deploy in the Tomcat webapps directory.
The build script can run up to five minutes, and create more than 100 output lines, the process includes several steps:
- Collect files distribution source directory.
- Compile the Java source code.
- Running unit tests.
- Prepare the Solr search engine.
- Vivo deployed to Tomcat and Solr.
It worked?
If the outgoing message is successful, then the construction has been completed successfully. Proceed to the next stepSi el mensaje de salida finaliza con éxito, entonces la construcción ha terminado correctamente. Procede al siguiente paso.
Panel | ||
---|---|---|
| ||
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 vezIf the output ends with an error message, building failed. Find the fault of the error, correct the problem, and run the script again.
Panel | ||
---|---|---|
| ||
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.
Construction output may include warning messages. Java compiler can warn of outdated code. Unit tests can produce warning messages, and some tests can be ignored if you do not produce consistent results. If the output ends with a success message, these messages will be ignored.
run LIVE
configuring Tomcat
Assign parameters JVM
VIVO copy small sections of your base RDF data within memory to serve web requests quickly (the copy in memory and the database remains in sync when editing).
VIVO may require more memory than it has assigned Tomcat by default. Like many facilities Tomcat, the file or setenv.bat setenv.sh in Tomcat bin directory is a convenient place to allocate memory settings instead. If this file does not exist within Tomcat directories, you can create it.
For examplePor ejemplo:
Code Block | ||||
---|---|---|---|---|
| ||||
export CATALINA_OPTS = "- Xms512m -Xmx512m -XX: MaxPermSize = 128m" |
Esto le dice a tomcat que asigne un valor inicial de This tells tomcat to assign an initial value of 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
maximum value, and a space of 128 megabytes to PermGem. Lower values may be insufficient, especially for small installation tests.
Set safety limits
Vivo is a multithreaded web application that can require more wires than are allowed in the default configuration of your Linux installation. Make sure your system can support the required number of threads by editing the following lines in the file 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:
Code Block |
---|
apache apache hard hard nproc nproc 400 400 tomcat6 tomcat6 hard hard nproc nproc 1500 |
Configure URI
encoding
LIVE handled properly for international characters, you have to configure Tomcat under standard Para que VIVO maneje correctamente caracteres internacionales, tienes que configurar a Tomcat conforme al estándar de codificación de caracteres UTF-8 characters.
Edita el archivo Edit the conf / server.xml y agrega los siguientes atributos para cada elemento file and add the following attributes for each element Connector:
URIEncoding = "UTF-8"
Code Block |
---|
<Server ...> > <Service ...> > <Connector ... URIEncoding = "UTF-8" /> > ... </Connector> Connector> </Service> Service> </ Server> |
Note |
---|
Algunas versiones de Tomcat traen incluido este atributo como predeterminado. |
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.
Some versions of Tomcat bring this attribute included as default. |
Be careful when creating elements of context
Each Web application in the distribution of VIVO (VIVO and Solr) includes a file "context fragment" containing information for the Web application deployment.
Tomcat allows these fragments override it by adding elements of context Context context the server.xml file. If you decide to do this, make sure the new context item includes the necessary deployment parameters from context chunk replaced.
Look at the section titled Live Running behind an Apache Server for an example replacement snippet LIVE context.
Runtime Properties
In the process of building VIVO, specifically in the compilation and deployment, a file called example.runtime.properties in the home directory LIVE (specified by vitro.home in the build.properties file) was created, rename this file at runtime .properties and edit the file according to your installation, as described below.
These properties are loaded when you start VIVO. If you want to change these properties at a later date, you need to restart Tomcat for the changes to take effect. No need to repeat step compile and deployEstas 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.
Note |
---|
Windows: Para instalar en un sistema operativo Windows, debes incluir la letra de la unidad de disco duro, debes usar la diagonal “/” y no la diagonal invertida “\” en la ruta de directorios, por ejemplo To install on a Windows operating system, you must include the letter of the hard drive, you must use the slash "/" and not the backslash "\" in the directory path, for example c: / tomcat |
Propiedades básicas
Estas propiedades definen algunos aspectos fundamentales de la instalación de VIVO. Muchos sitios van a necesitar modificar todos estos valores.
basic properties
These properties define some fundamental aspects of the installation of VIVO. Many sites will need to modify these values.
Property NameNombre de la propiedad | Vitro.defaultNamespace | ||
Description | The RDF default namespace for this installation | 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. VIVO installation RDF makes its resources available for harvest using linked data. Requests for RDF resource URI redirected to HTML or RDF as that specified by the customer. To make this possible, the default namespace VIVO must have a certain structure and start with a public web address VIVO installation. For example, if the web address VIVO facility is 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 the namespace must be assigned to http://vivo.example.edu/individual con el fin de soportar datos vinculados. Del mismo modo, si VIVO esta instalado en in order to support linked data. Similarly, if LIVE is installed in http://www.example.edu/vivo el espacio de nombres debe ser asignado a the namespace must be assigned to http://www.example.edu/vivo/individual
* El espacio de nombre debe terminar con “individual/” (incluyendo la barra diagonalThe namespace must end with "individual /" (including the slash). |
Valor predeterminadodefault | Ninguno | Any | |
Example valueValor de ejemplo |
Nombre de la propiedadProperty Name | 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 | |
Description | Specifies the email address of the primary user account of the VIVO application. This user will have a temporary initial password: rootpassword. You will be prompted to create a new password at first logon.
Note: The primary user account has access to all data and all operations LIVE. Data views can be amazing when the main user. It is better to create a site administrator account for use in each administrative task. |
default | Any |
Example value |
Property NameNombre 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 |
Description | Specifies the JDBC URL for your database. Changes the end of the URL with the name of your database (If this is not "live"). |
default | Any |
Example valueValor de ejemplo |
Property NameNombre 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 |
Description | Change the user name that matches the authorized user you created for MySQL. |
default | Any |
Example value | username |
Property NameNombre de la propiedad | VitroConnection.DataSource.password | ||
Description | Change the password match which gave high in | Descripción | Cambia la contraseña que coincida con la que diste de alta en MySQL. |
Valor predeterminadodefault | Ninguno | ||
Valor de ejemplo | contrasenia | ||
Any | |||
Example value | features Password |
Property NameNombre 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 |
Description | Specifies an SMTP service that the application will use to send email (optional). If this is left empty, the contact form will be hidden and disabled, and users will not be notified of changes in their accounts. |
default | Any |
Example valueValor de ejemplo | smtp.servidor.edu |
Nombre de la propiedadProperty Name | 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.
Description | Specifies an email address which will appear as the sender on notifications via e-mail users (optional). If a user answers the notification, this address will receive the answer. If an email address is invalid user, this address will receive the error message. If this is left empty, users will not be notified of changes in their accounts. |
default | Any |
Example value |
Connecting the Solr search index
VIVO and search index are currently two different web applications and simple installation puts the two in the same instance of Tomcat. Still, you have to tell the VIVO application how to get to the Solr Web application.
Property NameNombre de la propiedad | vitro.local.solr.url |
DescripciónDescription | La URL en el contexto de Solr usada en la búsqueda local de VIVO. Debe consistir enThe URL in the context of Solr used in local search VIVO. You should consist of:
servername scheme + servername + + port + vivoweb_app_name + “solr”"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 |
In the standard installation, the context of Solr will be on the same server as VIVO, and the same instance of Tomcat. The route has to be webapp.name LIVE (specified below) + "solr" | |
default | Any |
Example valueValor de ejemplo |
Propiedades adicionales
additional properties
The 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
file can accept many additional properties, but are not needed for this simple installation. If you choose any of the installation options, you'll probably need to configure some of these properties.
start Tomcat
Many of the facilities running Tomcat can be started the following files startup.sh or startup.bat in the Tomcat bin directory. Start Tomcat and go to your browser to 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ónlive to test the application.
Observa que Tomcat puede requerir varios minutos en iniciar Note that Tomcat may require several minutes to start 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.
When you start VIVO, some diagnostic tests run. If a problem is detected VIVO home page redirect to the home page status describing the problem. You can stop Tomcat, correct the problem and proceeds to step compile and deploy. If the problem is not serious, the start status page can provide a link to "continue" which will allow VIVO use despite problems.
If the start was successful, you will see the homepage of VIVO.
If tomcat does not start, or the VIVO application is not visible, check the files in the Tomcat logs directory.
Error messages can be found in Los mensajes de error se pueden encontrar en [tomcat] /logs/catalina.out , [tomcat] /logs/vivo.all.log o or [tomcat] /logs/localhost.log.
Note |
---|
Recuerda que Tomcat debe tener permisos de lectura y escritura en sus archivos, y los archivos en el directorio principal de VIVO. Esto quiere decir que tienes que usar un script particular o una cuenta de usuario particular para iniciar Remember that Tomcat must have permissions to read and write files, and files in the root directory of VIVO. This means you have to use a particular script or particular user account to start Tomcat. |