Extension Linked Storage


Extension Basics

Title
Linked Storage
Name
ckanext-linked-storage
Type
Public extension
Description
The **Linked Storage** extension for CKAN enables the creation of dataset resources from files acce
CKAN versions
Download-Url (zip)
Last commit
5 years ago (2020-12-09 18:26:49)
Url to repo
Category
Regional Government Themes


Background Infos

Description (long)
Show details

Tests

ckanext-linked-storage

CKAN extension enabling files accessible via a mounted network share to be created as dataset resources with CKAN acting as a proxy.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.8 and earlier not tested
2.9 yes

Installation

To install ckanext-linked-storage:

  1. Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
  1. Clone the source and install it on the virtualenv:
    git clone https://github.com/USEPA/ckanext-linked-storage.git    
    cd ckanext-linked-storage    
    pip install -e .    
  1. Add linked_storage to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  2. Add storage locations via ckanext.linked_storage.mountpoints and ckanext.linked_storage.net_paths in the CKAN config file

  3. Restart CKAN

Adding resources using linked storage

To create a resource using this functionality via the API call resource_create with url_type = 'link-storage' and provide the path to the resource either as the url or link_path. An example can be seen below:

resource_create(package_id='some package', name='a linked resource package', url_type='link-storage', link_path="\\some-host\share\linked_file.csv" )

Config settings

To connect resources using the linked storage system the available mounted resources need to be defined. This is done using two of the configuration inputs.

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


Installation Guide

Configuration hints

To install ckanext-linked-storage:

  1. Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
  1. Clone the source and install it on the virtualenv:
    git clone https://github.com/USEPA/ckanext-linked-storage.git    
    cd ckanext-linked-storage    
    pip install -e .    
  1. Add linked_storage to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  2. Add

Plugins to configure (ckan.ini)
linked_storage
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions