Mudanças entre as edições de "Instalando isis-oai-provider"
(→oai-databases.php) |
(→Antes de iniciar a configuração) |
||
Linha 80: | Linha 80: | ||
$ ln -s /opt/bireme/isis-oai-provider/cgi-bin/isis-oai-provider/ . | $ ln -s /opt/bireme/isis-oai-provider/cgi-bin/isis-oai-provider/ . | ||
− | == | + | == Ajustes antes de configurar == |
− | Para que o ISIS-OAI-Provider funcione corretamente é necessário renomear alguns | + | Para que o ISIS-OAI-Provider funcione corretamente é necessário renomear alguns diretórios de acordo com a plataforma utilizada. |
− | # Se for um '''sistema operacional Linux''', renomeie os | + | # Se for um '''sistema operacional Linux''', renomeie os diretórios abaixo: |
− | #* de: | + | #* Executáveis binários (WWWISIS) |
− | #* para: | + | #** de: cgi-bin/isis-oai-provider-linux |
− | #* de: | + | #** para: cgi-bin/isis-oai-provider |
− | #* para: | + | #* Tabela de tradução de metadados (oai_dc) |
− | # Se for um '''sistema operacional Windows''', renomeie os | + | #** de: htdocs/isis-oai-provider/gizmo-linux |
− | #* de: | + | #** para: htdocs/isis-oai-provider/gizmo |
− | #* para: | + | # Se for um '''sistema operacional Windows''', renomeie os diretórios abaixo: |
− | #* de: | + | #* Executáveis binários (WWWISIS) |
− | #* para: | + | #** de: cgi-bin/isis-oai-provider-windows |
+ | #** para: cgi-bin/isis-oai-provider | ||
+ | #* Tabela de tradução de metadados (oai_dc) | ||
+ | #** de: htdocs/isis-oai-provider/gizmo-windows | ||
+ | #** para: htdocs/isis-oai-provider/gizmo | ||
'''NOTAS''': | '''NOTAS''': | ||
# Garanta que os arquivos executáveis estejam com permissão para execução tanto na linha de comando como via interface CGI; | # Garanta que os arquivos executáveis estejam com permissão para execução tanto na linha de comando como via interface CGI; | ||
# As versões dos arquivos executáveis do pacote são todas 32 bits; | # As versões dos arquivos executáveis do pacote são todas 32 bits; | ||
− | # | + | # Há versões 64 bits compiladas somente para Linux. |
==Arquivos de configuração== | ==Arquivos de configuração== |
Edição das 16h28min de 16 de dezembro de 2014
Isis-oai-provider é uma aplicação que provê acesso a bases de dados ISIS através do protocolo OAI para ser coletada.
A aplicação executa sob PHP 5.3.x.
Índice
Instalação
Método 1 - Arquivos para download
Baixe a última versão na opção Downloads no repositório github (arquivo zip ou tar gz) e extraia o arquivo para seu servidor.
Exemplos:
- Criando uma estrutura e extraíndo os arquivos da aplicação no diretório /opt/ de um servidor Linux:
$ cd /opt/ $ mkdir bireme $ cd bireme $ wget https://github.com/bireme/isis-oai-provider/tarball/master -O isis-oai-provider.tar.gz $ tar xvfzp isis-oai-provider.tar.gz $ mv bireme-isis-oai-provider-53c0abc/ isis-oai-provider
NOTA: o termo 53c0abc é gerado automaticamente durante a criação do arquivo tar.gz e portanto, será diferente a cada execução.
- Baixando os arquivos da aplicação em um servidor Windows:
- acesse a página do aplicativo em https://github.com/bireme/isis-oai-provider
- clique no botão download zip para carregar os arquivos do aplicativo
- descarregue no diretório onde deseja instalar o pacote
Método 2 - Clonar o repositório do projeto no git
A vantagem deste método é que se pode facilmente atualizar a aplicação posteriormente, mas é necessário ter o pacote git-core instalado.
Exemplo: Criando uma estrutura e baixando a aplicação do repositório no diretório /opt/ do servidor:
$ cd /opt/ $ mkdir bireme $ cd bireme $ git clone git://github.com/bireme/isis-oai-provider.git
Publique a aplicação no servidor web (ex. Apache Web Server)
Opção A - Usando um VirtualHost específico para a aplicação web
<VirtualHost *:80> ServerName isis-oai-provider.local DocumentRoot /opt/bireme/isis-oai-provider/htdocs/
<Directory "/opt/bireme/isis-oai-provider/cgi-bin"> Options +ExecCGI AllowOverride None Order deny,allow </Directory>
ScriptAlias /cgi-bin/ /opt/bireme/isis-oai-provider/cgi-bin/ LogLevel warn CustomLog /var/log/apache2/isis-oai-provider.log combined ServerSignature On </VirtualHost>
Opção B - Usando um VirtualHost específico
Assumindo-se que já exista um site web executando, será apenas necessário descobrir os diretórios para os seguintes componentes:
- DocumentRoot --- o diretório onde os arquivos estáticos e scripts PHP se localizam - geralmente htdocs
- cgi-bin --- o diretório com permissões especiais para executar scripts CGI - geralmente cgi-bin
- bases de dados ISIS --- o diretório onde as bases de dados ISIS se localizam - geralmentebases
Em seguida mova/copie ou crie links simbólicos para os diretórios do isis-oai-provider:
Ex. Assumindo um site web com a seguinte estrutura de diretório:
/home/sites/ /site1/ htdocs/ cgi-bin/ bases/
Siga os passos abaixo para criar links simbólicos para os diretórios da aplicação:
$ cd /home/sites/site1/htdocs $ ln -s /opt/bireme/isis-oai-provider/htdocs/isis-oai-provider/ . $ cd /home/sites/site1/cgi-bin $ ln -s /opt/bireme/isis-oai-provider/cgi-bin/isis-oai-provider/ .
Ajustes antes de configurar
Para que o ISIS-OAI-Provider funcione corretamente é necessário renomear alguns diretórios de acordo com a plataforma utilizada.
- Se for um sistema operacional Linux, renomeie os diretórios abaixo:
- Executáveis binários (WWWISIS)
- de: cgi-bin/isis-oai-provider-linux
- para: cgi-bin/isis-oai-provider
- Tabela de tradução de metadados (oai_dc)
- de: htdocs/isis-oai-provider/gizmo-linux
- para: htdocs/isis-oai-provider/gizmo
- Executáveis binários (WWWISIS)
- Se for um sistema operacional Windows, renomeie os diretórios abaixo:
- Executáveis binários (WWWISIS)
- de: cgi-bin/isis-oai-provider-windows
- para: cgi-bin/isis-oai-provider
- Tabela de tradução de metadados (oai_dc)
- de: htdocs/isis-oai-provider/gizmo-windows
- para: htdocs/isis-oai-provider/gizmo
- Executáveis binários (WWWISIS)
NOTAS:
- Garanta que os arquivos executáveis estejam com permissão para execução tanto na linha de comando como via interface CGI;
- As versões dos arquivos executáveis do pacote são todas 32 bits;
- Há versões 64 bits compiladas somente para Linux.
Arquivos de configuração
Renomeie os arquivos de exemplo de configuração como segue:
$ cd htdocs/isis-oai-provider/ $ mv oai-config-sample.php oai-config.php $ mv oai-databases-sample.php oai-databases.php
Modifique os arquivos oai-config.php e oai-databases.php de acordo com os passos abaixo:
oai-config.php
- altere o conteúdo da variável DATABASE_PATH para o diretório 'bases' da instalação corrente
DATABASE_PATH=/home/www/my-iah/bases
- altere o conteúdo da variável NAME para um nome que identifique aquela instância
NAME=MyIAHdb
- altere o conteúdo da variável EMAIL para o endereço de e-mail da pessoa encarregada pelos dados
EMAIL=me@institution.org
- altere o conteúdo das variáveis IDPREFIX e IDDOMAIN de acordo com a informação de domínio de sua instância
IDPREFIX=br
IDDOMAIN=bvs
- configure a variável EARLIESTDATESTAMP para uma data próxima do início de entrada de dados da instância
EARLIESTDATESTAMP=1998-12-30
oai-databases.php
Cada base de dados deve ser configurada tendo-se em mente a seguinte estrutura e campos obrigatórios:
[set-spec]
name= description= database= mapping= prefix=oai_date_ isis_key_length=<1660|1030> identifier_field=<tag> datestamp_field=<tag>
- [set-spec] inicia e descreve uma seção para aquela base de dados e identifica o nome lógico daquele conjunto de dados. Esta informação é apresentada no verbo ListSets e também faz parte do identificador único de cada documento.
ex.
[lilacs]
- A variável name serve como um rótulo para o conjunto de dados que será mostrado no verbo ListSets.
ex.
name=LILACS
- A variável description contém a descrição do conjunto de dados que será mostrada no verbo ListSets.
ex.
description="LILACS Database"
- A variável database contém o caminho para o diretório e o nome do arquivo master da base de dados.
ex.
database=/home/www/my-iah/bases/iah/dblil
- A variável mapping se refere ao nome do formato utilizado para mapear os elementos de dados. (Localizado no subdiretório map/)
ex.
mapping=lilacs-dc.pft
- A variável prefix especifica um prefixo para o campo de data. Este prefixo deverá ser incluído no arquivo FST da base de dados para regeração do invertido.
ex.
prefix=oai_date_
ex. de inversão para incluir na LILACS.FST
93 0 |oai_date_|v93^*/
- A variável isis_key_length define os tamanhos mínimo e máximo de chave utilizada para inverter a base. Muita atenção com a versão utilizada especialmente de acordo com sua origem (ex. LILACS é 1660, IAH é 1030)
ex.
isis_key_length=1660
- A variável identifier_field informa a tag do identificador único de registros
ex.
identifier_field=2
- A variável datestamp_field informa a tag da data de criação do registro
ex.
datestamp_field=93
Portanto, havendo necessidade de adicionar novas bases de dados à configuração, basta preencher os campos acima de acordo com os parâmetros necessários e adicioná-los ao arquivo.
NOTE: Uma vez que o nome de seção é também o nome da base de dados, não são permitidas duplicidades de nome.
Testando
Teste a aplicação abrindo seu navegador de internet e informando o nome do domínio no modelo: http://nome_do_servidor/isis-oai-provider/
Ex. http://isis-oai-provider.local/isis-oai-provider/ [Em manutenção]