Extension Storage


Extension Basics

Title
Storage
Name
ckanext-storage
Type
Public extension
Description
CKAN extension that adds blob storage capabilities with API methods and upload interface, supporting S3, Google Storage and local filesystem via OFS. Deprecated: merged into CKAN core as of v1.6.
CKAN versions

~1.5

Show details

These CKAN Versions are exactely matched:

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


Background Infos

Description (long)
Show details

ckanext-storage

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 (http://packages.python.org/ofs/) to talk to the backing storage so can support anything that OFS supports including local filesystem, S3, Google Storage etc.

Installation

Install the extension:

pip install ckanext-storage

Note that for use of S3-like backends you will need boto. For local filesystem backend you need pairtree (pip install pairtree).

In your config you need something like:

ckan.plugins = storage

## OFS configuration (Google Storage example)
ofs.impl = google
ofs.gs_access_key_id = GOOGCABCDASDASD
ofs.gs_secret_access_key = 134zsdfjkw4234addad
ckanext.storage.bucket = ....
# ckanext.storage.max_content_length = 1000000000
# ckanext.storage.key_prefix = file/

For local file storage:

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

Upload Web Interface

Direct upload available as part of dataset resource creation process (as of CKAN v1.5). Also a new upload page at /storage/upload.

Metadata API

/api/storage/metadata/{label} - GET, POST, PUT for metadata.

Auth API

Request Authentication at /api/storage/auth/request/{label}, Form Authentication at /api/storage/auth/form/{label}.

License

AGPL

Version
0.5
Version release date
(not set)
Contact name
Open Knowledge Foundation
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Requires OFS configuration. For S3-like backends needs boto, for local filesystem needs pairtree. Deprecated - merged into CKAN core as of v1.6.

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