Extension Linked Storage


Extension Basics

Title
Linked Storage
Name
ckanext-linked-storage
Type
Public extension
Description
US EPA CKAN extension enabling files accessible via mounted network shares to be created as dataset resources with CKAN acting as a proxy.
CKAN versions
Download-Url (zip)
Last commit
4 years ago (2021-04-21 21:22:47)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

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.

Developed by the US Environmental Protection Agency (EPA).

Requirements

CKAN version Compatible?
2.8 and earlier not tested
2.9 yes

Installation

  1. Activate your CKAN virtual environment
  2. Clone and install: pip install -e .
  3. Add linked_storage to ckan.plugins
  4. Add storage locations via config
  5. Restart CKAN

Adding resources using linked storage

Create a resource via API with url_type = 'link-storage':

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

Setting Description
ckanext.linked_storage.mountpoints Specifies mountpoints or folders where data files can be accessed (space delimited)
ckanext.linked_storage.net_paths Specifies paths to match provided resource paths to corresponding mountpoints

Disclaimer

This software is provided by the US EPA on an “as is” basis. EPA has relinquished control of the information and no longer has responsibility to protect its integrity, confidentiality, or availability.

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


Installation Guide

Configuration hints

Requires mountpoints and net_paths configuration for network share access.

Plugins to configure (ckan.ini)
linked_storage
CKAN Settings (ckan.ini)
# ckanext.linked_storage.mountpoints = /mnt/share1 /mnt/share2
# ckanext.linked_storage.net_paths = \\server\share1 \\server\share2
DB migration to be executed
(not set)
<< back to Extensions