materialdigital / pmd-ckan

Docker Compose Stack for PMD CKAN instances.
GNU General Public License v3.0
1 stars 0 forks source link

PMD-CKAN

This composition of applications provides a solution for hosting material science data for projects in the material digital initiative to participate in a decentralized linked data space with a central data portal instance. It also features an ontology agnostic transformation pipeline and a triple store integration.

Features

Prerequisites

Before you begin, make sure you have the following installed:

Installation

  1. Clone this repository to your local machine and init submoduls:

    git clone https://github.com/materialdigital/pmd-ckan.git
    git submodule update --init
  2. Navigate to the pmd-ckan directory:

    cd ckan-docker-compose
  3. create a .env file, use (example.env)[config/example.env] as a template

    all variables starting with CKANEXT will be translated to the ckan.ini removing CKANINI, replacing "__" with "." and putting the name to lowercase examples: CKANINICSVTOCSVWFORMATS -> csvtocsvw.formats CKANINICSVTOCSVWSSL_VERIFY -> csvtocsvw.ssl_verify

  4. replace all values in <> braces or are comented to be changed

  5. make changes according to your ssl or proxy configuration in config/nginx/default.template

  6. Run the docker compose stack, it will pull and build the necessary containers

    docker-compose up
  7. After first successful startup, login into ckan with the admin password you defined in your .env

  8. create an API token for the supervisor background tasks at /user//api-tokens, and paste it into your .env file at BACKGROUNDJOBS_API_TOKEN

  9. restart the docker compose stack in detached mode

    docker-compose down
    docker-compose up -d

Acknowledgments

The authors would like to thank the Federal Government and the Heads of Government of the Länder for their funding and support within the framework of the Platform Material Digital consortium. Funded by the German Federal Ministry of Education and Research (BMBF) through the MaterialDigital Call in Project KupferDigital - project id 13XP5119.