CatalogueRevamping
/
harvester-d4science
14
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved info on running paster commands.

This commit is contained in:
David Read 2012-04-10 16:20:43 +01:00
parent a971f7be79
commit 48d7f4b7f8
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.rst
View File

@ -31,18 +31,16 @@ well as the harvester for CKAN instances (included with the extension)::
Configuration Configuration
============= =============
Run the following command (in the ckanext-harvest directory) to create Run the following command to create the necessary tables in the database::
the necessary tables in the database::
paster harvester initdb --config=../ckan/development.ini paster --plugin=ckanext-harvest harvester initdb --config=mysite.ini
The extension needs a user with sysadmin privileges to perform the The extension needs a user with sysadmin privileges to perform the
harvesting jobs. You can create such a user running these two commands in harvesting jobs. You can create such a user running these two commands::
the ckan directory::
paster user add harvest paster --plugin=ckan user add harvest
paster sysadmin add harvest paster --plugin=ckan sysadmin add harvest
After installation, the harvest interface should be available under /harvest After installation, the harvest interface should be available under /harvest
if you're logged in with sysadmin permissions, eg. if you're logged in with sysadmin permissions, eg.
@ -54,7 +52,7 @@ Command line interface
====================== ======================
The following operations can be run from the command line using the The following operations can be run from the command line using the
``paster harvester`` command:: ``paster --plugin=ckanext-harvest harvester`` command::
harvester initdb harvester initdb
- Creates the necessary tables in the database - Creates the necessary tables in the database
@ -94,11 +92,9 @@ The following operations can be run from the command line using the
harvester job-all harvester job-all
- create new harvest jobs for all active sources. - create new harvest jobs for all active sources.
The commands should be run from the ckanext-harvest directory and expect The commands should be run with the pyenv activated and refer to your sites configuration file (mysite.ini in this example)::
a development.ini file to be present. Most of the time you will specify
the config explicitly though::
paster harvester sources --config=../ckan/development.ini paster --plugin=ckanext-harvest harvester sources --config=mysite.ini
The CKAN haverster The CKAN haverster
================== ==================
@ -243,21 +239,21 @@ Running the harvest jobs
The harvesting extension uses two different queues, one that handles the The harvesting extension uses two different queues, one that handles the
gathering and another one that handles the fetching and importing. To start gathering and another one that handles the fetching and importing. To start
the consumers run the following command from the ckanext-harvest directory the consumers run the following command
(make sure you have your python environment activated):: (make sure you have your python environment activated)::
paster harvester gather_consumer --config=../ckan/development.ini paster --plugin=ckanext-harvest harvester gather_consumer --config=mysite.ini
On another terminal, run the following command:: On another terminal, run the following command::
paster harvester fetch_consumer --config=../ckan/development.ini paster --plugin=ckanext-harvest harvester fetch_consumer --config=mysite.ini
Finally, on a third console, run the following command to start any Finally, on a third console, run the following command to start any
pending harvesting jobs:: pending harvesting jobs::
paster harvester run --config=../ckan/development.ini paster --plugin=ckanext-harvest harvester run --config=mysite.ini
After packages have been imported, the search index will have to be updated After packages have been imported, the search index will have to be updated
before the packages appear in search results (from the ckan directory): before the packages appear in search results::
paster search-index paster --plugin=ckan search-index rebuild