From f670543c4f36583eb09a7590229492be76fa9ff9 Mon Sep 17 00:00:00 2001 From: amercader Date: Thu, 23 Jan 2014 11:52:08 +0000 Subject: [PATCH] [#1446] Clarify DataPusher issues in docs --- doc/datastore.rst | 25 +++++++++++++++++++++---- doc/install-from-package.rst | 9 +++++++-- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/doc/datastore.rst b/doc/datastore.rst index 80fe5955bc3..026c1f303fd 100644 --- a/doc/datastore.rst +++ b/doc/datastore.rst @@ -15,6 +15,11 @@ When a resource is added to the DataStore, you get: The DataStore is integrated into the :doc:`CKAN API ` and authorization system. +The DataStore is generally used alongside the +`DataPusher `_, which will +automatically upload data to the DataStore from suitable files, whether +uploaded to CKAN's FileStore or externally linked. + .. contents:: :depth: 1 :local: @@ -126,7 +131,16 @@ Option 1: Paster command This option is preferred if CKAN and PostgreSQL are on the same server. -To set the permissions, use this paster command after you've set the database URLs (make sure to have your virtualenv activated): +To set the permissions, use the following paster command after you've set the database URLs. + +If you did a package install, the easiest way is to use the ``ckan`` command wrapper: + +.. parsed-literal:: + + sudo ckan datastore set-permissions postgres + +If you did a source install, make sure to have your virtualenv activated and +run the command from the CKAN source directory: .. parsed-literal:: @@ -230,10 +244,13 @@ DataStore. This requires some processing, to extract the data from your files and to add it to the DataStore in the format the DataStore can handle. This task of automatically parsing and then adding data to the DataStore is -performed by a DataPusher, a service that runs asynchronously and can be installed -allongside CKAN. +performed by the `DataPusher `_, a service that runs asynchronously and can be installed +alongside CKAN. + +To install this please look at the docs here: http://docs.ckan.org/projects/datapusher + -To install this please look at the docs here: http://datapusher.readthedocs.org +.. _DataPusher_docs: http://docs.ckan.org/projects/datapusher ----------------- diff --git a/doc/install-from-package.rst b/doc/install-from-package.rst index f42bb92e30f..690ad7577c2 100644 --- a/doc/install-from-package.rst +++ b/doc/install-from-package.rst @@ -9,6 +9,11 @@ and easiest way to install CKAN, but it requires **Ubuntu 12.04 64-bit**. If you're not using Ubuntu 12.04 64-bit, or if you're installing CKAN for development, you should follow :doc:`install-from-source` instead. +At the end of the installation process you will end up with two running web +applications, CKAN itself and the DataPusher, a separate service for automatically +importing data to CKAN's :doc:`datastore`. + + .. _run-package-installer: --------------------------- @@ -86,8 +91,8 @@ CKAN: sudo ckan db init -#. Optionally, setup the DataStore by following the instructions in - :doc:`/datastore`. +#. Optionally, setup the DataStore and DataPusher by following the + instructions in :doc:`/datastore`. #. Also optionally, you can enable file uploads by following the instructions in :doc:`filestore`.