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

Update install instructions

This commit is contained in:
amercader 2013-05-14 17:14:03 +01:00
parent b316cc26a2
commit 2dc1b6a178
1 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.rst
View File

@ -8,31 +8,48 @@ and adds a CLI and a WUI to CKAN to manage harvesting sources and jobs.
Installation Installation
============ ============
The harvest extension can use two different backends. You can choose whichever 1. The harvest extension can use two different backends. You can choose whichever
you prefer depending on your needs: you prefer depending on your needs:
* `RabbitMQ <http://www.rabbitmq.com/>`_: To install it, run:: * `RabbitMQ <http://www.rabbitmq.com/>`_: To install it, run::
sudo apt-get install rabbitmq-server sudo apt-get install rabbitmq-server
* `Redis <http://redis.io/>`_: To install it, run:: * `Redis <http://redis.io/>`_: To install it, run::
sudo apt-get install redis-server sudo apt-get install redis-server
Clone the repository and set up the extension:: 2. Install the extension into your python environment.
git clone https://github.com/okfn/ckanext-harvest *Note:* Depending on the CKAN core version you are targeting you will need to
cd ckanext-harvest use a different branch from the extension.
pip install -r pip-requirements.txt
python setup.py develop
Make sure the CKAN configuration ini file contains the harvest main plugin, as For a production site, use the `stable` branch, unless there is a specific
well as the harvester for CKAN instances (included with the extension):: branch that targets the CKAN core version that you are using.
To target the latest CKAN core release::
(pyenv) $ pip install -e git+https://github.com/okfn/ckanext-harvest.git@stable#egg=ckanext-harvest
To target an old release (if a release branch exists, otherwise use `stable`)::
(pyenv) $ pip install -e git+https://github.com/okfn/ckanext-harvest.git@release-v1.8#egg=ckanext-harvest
To target CKAN `master`, use the extension `master` branch (ie no branch defined)::
(pyenv) $ pip install -e git+https://github.com/okfn/ckanext-harvest.git#egg=ckanext-harvest
3. Install the rest of python modules required by the extension::
(pyenv) $ pip install -r pip-requirements.txt
4. Make sure the CKAN configuration ini file contains the harvest main plugin, as
well as the harvester for CKAN instances if you need it (included with the extension)::
ckan.plugins = harvest ckan_harvester ckan.plugins = harvest ckan_harvester
Also define the backend that you are using with the ``ckan.harvest.mq.type`` 5. Also define the backend that you are using with the ``ckan.harvest.mq.type``
option (it defaults to ``rabbitmq``):: option (it defaults to ``rabbitmq``)::
ckan.harvest.mq.type = redis ckan.harvest.mq.type = redis