Update README
This commit is contained in:
parent
ee186376bd
commit
7a325d4be3
55
README.rst
55
README.rst
|
@ -1,6 +1,6 @@
|
|||
=============================================
|
||||
ckanext-harvesting - CSW harvesting extension
|
||||
=============================================
|
||||
================================================
|
||||
ckanext-harvest - Remote harvesting extension
|
||||
================================================
|
||||
|
||||
This extension will contain all harvesting related code, now present
|
||||
in ckan core, ckanext-dgu and ckanext-csw.
|
||||
|
@ -16,16 +16,55 @@ Configuration
|
|||
=============
|
||||
|
||||
The extension needs a user with sysadmin privileges to perform the
|
||||
harvesting jobs. The user's API key must be defined in the CKAN
|
||||
configuration file (.ini) in the [app:main] section.
|
||||
harvesting jobs. You can create such a user running these two commands in
|
||||
the ckan directory::
|
||||
|
||||
paster user add harvest
|
||||
|
||||
paster sysadmin add harvest
|
||||
|
||||
The user's API key must be defined in the CKAN
|
||||
configuration file (.ini) in the [app:main] section::
|
||||
|
||||
ckan.harvesting.api_key = 4e1dac58-f642-4e54-bbc4-3ea262271fe2
|
||||
|
||||
ckan.harvesting.api_key = 4e1dac58-f642-4e54-bbc4-3ea262271fe2
|
||||
|
||||
The API URL used can be also defined in the ini file (it defaults to
|
||||
http://localhost:5000/).
|
||||
http://localhost:5000/)::
|
||||
|
||||
ckan.api_url = <api_url>
|
||||
ckan.api_url = <api_url>
|
||||
|
||||
|
||||
Command line interface
|
||||
======================
|
||||
|
||||
The following operations can be run from the command line using the
|
||||
``paster harvester`` command::
|
||||
|
||||
harvester source {url} [{user-ref} [{publisher-ref}]]
|
||||
- create new harvest source
|
||||
|
||||
harvester rmsource {url}
|
||||
- remove a harvester source (and associated jobs)
|
||||
|
||||
harvester sources
|
||||
- lists harvest sources
|
||||
|
||||
harvester job {source-id} [{user-ref}]
|
||||
- create new harvesting job
|
||||
|
||||
harvester rmjob {job-id}
|
||||
- remove a harvesting job
|
||||
|
||||
harvester jobs
|
||||
- lists harvesting jobs
|
||||
|
||||
harvester run
|
||||
- runs harvesting jobs
|
||||
|
||||
The commands should be run from the ckanext-harvest directory and expect
|
||||
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
|
||||
|
||||
|
|
Loading…
Reference in New Issue