An extension for the CKAN open data platform for storing resources on cloud storage
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ckanext
.gitignore
LICENSE.txt
README.md
setup.py

README.md

CKAN CloudConnector

A package of extensions for CKAN open data platform for storing resources on CloudStorage.

Requirements

This extension was developed and tested under CKAN-2.2

For now extension supports only Amazon S3 Cloud storage. In order to use this extension you should have AWS account because AWS Key and AWS Secret Key are required for connection to Cloud.

Installation

To install CKAN CloudConnector:

  1. Activate your CKAN virtual environment, for example:

    $ . /usr/lib/ckan/default/bin/activate

  2. Install the ckanext-cloudconnector Python package into your virtual environment:

    $ cd /some/dir/ckanext-cloudconnector
    $ python setup.py install
    
  3. Add cloud_connector to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    $ sudo service apache2 reload

Config Settings

This extension defines additional settings in config file

 ckan.cloud_storage_enable=true|false    //is connector enabled or not?
 ckan.s3_aws_key=AWS_S3_KEY              //customer key of your AWS instance
 ckan.s3_secret_key=AWS_S3_SECRET        //secret key of your AWS instance
 ckan.cloud_failover=1|2                  //1 - save file locally in case of fail, 2 - raise exception

This configs aren't required and can be setted or changed under the 'Cloud connector' tab in admin settings section

Development Installation

To install CKAN CloudConnector for development, activate your CKAN virtualenv and do:

 $ cd /some/dir/ckanext-cloudconnector
 $ python setup.py develop

All dependencies will be installed automatically

Copying and License

This material is copyright © 2015 Link Web Services Pty Ltd

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at:

http://www.fsf.org/licensing/licenses/agpl-3.0.html