Socket
Socket
Sign inDemoInstall

ckanext-cloudstorage_api

Package Overview
Dependencies
0
Maintainers
2
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

ckanext-cloudstorage_api

Extension to manage CKAN resources in any S3-like object storage.

    0.2.0

Maintainers
2

Readme

CKAN Cloudstorage API

Extension to manage CKAN resources in any S3-like object storage.
Package version Downloads Licence

Documentation: https://envidat.gitlab-pages.wsl.ch/ckanext-cloudstorage_api/

Source Code: https://gitlabext.wsl.ch/EnviDat/ckanext-cloudstorage_api


This plugin is primarily intended for custom frontends built on the CKAN API.

Supports any S3-like API, e.g. Minio, Ceph Object Gateway.

Full support for all Apache libcloud drivers was dropped, due to primarily relying on S3 multipart and pre-signed URL capabilities.

Install

pip install ckanext-cloudstorage-api

Config

Required variables are set in your ckan.ini:

  • ckanext.cloudstorage_api.host
    • Type: str.
    • Description: The S3 host URL.
  • ckanext.cloudstorage_api.region
    • Type: str.
    • Description: The S3 host region.
  • ckanext.cloudstorage_api.access_key
    • Type: str.
    • Description: Access key for S3.
  • ckanext.cloudstorage_api.secret_key
    • Type: str.
    • Description: Secret key for S3.
  • ckanext.cloudstorage_api.bucket_name
    • Type: str.
    • Description: The name of the S3 bucket to store files.
  • ckanext.cloudstorage_api.bucket_path
    • Type: str.
    • Description: (Optional) The path within the S3 to store files. Default: "/", i.e. bucket root.
  • ckanext.cloudstorage_api.max_multipart_lifetime
    • Type: str.
    • Description: (Optional) maximum time a multipart part can exist. Multiparts will be cleaned if older than this by calling the cloudstorage_clean_multiparts endpoint.
  • ckanext.cloudstorage_api.leave_files
    • Type: bool.
    • Description: (Optional) leave files on S3 after resource deletion.

Endpoints

Actions

{CKAN_HOST}/api/3/action/{ACTION_NAME}

  • cloudstorage_initiate_multipart
  • cloudstorage_get_presigned_url_download
  • cloudstorage_get_presigned_url_multipart
  • cloudstorage_get_presigned_url_list_multipart
  • cloudstorage_multipart_list_parts
  • cloudstorage_finish_multipart
  • cloudstorage_abort_multipart
  • cloudstorage_check_multipart
  • cloudstorage_clean_multipart

Blueprints

  • /download/<resource_id>
    • Description: redirect to download a resource directly.

Keywords

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc