Extension Storage


Extension Basics

Title
Storage
Name
ckanext-storage
Type
Public extension
Description
CKAN storage extension.
CKAN versions

~1.5, ~1.6

Show details

These CKAN Versions are exactely matched:

Download-Url (zip)
Last commit
13 years ago (2012-01-25 00:38:45)
Url to repo
Category
Cloud Infrastructure & Storage


Background Infos

Description (long)
Show details

======================

CKAN Storage Extension

Advance Deprecation Notice: as of CKAN v1.6 (expected Feb 2012), this extension and its storage capabilities will have been merged into CKAN core.

This extension adds ‘blob’ storage capabilities to CKAN along with:

  • Some new methods to the CKAN API for dealing with storage
  • A /storage/upload page to web interface for doing file uploads

It uses OFS_ to talk to the backing storage so can support anything that OFS supports including local filesytem, S3, Google Storage etc.

.. _OFS: http://packages.python.org/ofs/

Installation

Install the extension::

# using pip (could use easy_install)
pip install ckanext-storage
# could install from source
# hg clone https://github.com/okfn/ckanext-storage.git
# cd ckanext-storage
# pip install -e .

Note that for use of S3-like backends (S3, Google Storage etc) you will need boto (this is installed by default at the moment). For local filesystem backend you need to install pairtree (pip install pairtree).

In your config you need something like::

ckan.plugins = storage

## OFS configuration ## This is for google storage. Example for another backend is below ## See OFS docs for full details ofs.impl = google ofs.gs_access_key_id = GOOGCABCDASDASD ofs.gs_secret_access_key = 134zsdfjkw4234addad ## bucket to use in storage You must set this ckanext.storage.bucket = ….

## optional ## maximum content size for uploads in bytes, defaults to 1Gb # ckanext.storage.max_content_length = 1000000000 ## prefix for all keys. Useful because we may use a single bucket and want to ## partition file uploads. Defaults to file/ # ckanext.storage.key_prefix = file/

For local file storage you would replace ofs arguments with::

ofs.impl = pairtree ofs.storage_dir = /my/path/to/storage/root/directory

If when uploading and using the local file storage you receive a pairtre

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
storage
CKAN Settings (ckan.ini)
# ckanext.storage.bucket = ....
# ckanext.storage.max_content_length = 1000000000
# ckanext.storage.key_prefix = file/
DB migration to be executed
(not set)
<< back to Extensions