From 426cd23f25b055f785f9d4091563b410af51708d Mon Sep 17 00:00:00 2001 From: Alasdair Gray Date: Tue, 20 Jun 2023 17:09:38 +0100 Subject: [PATCH 1/4] Using envvar variables that don't start with CKAN --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6b1931c..ffdfaf3 100644 --- a/README.md +++ b/README.md @@ -218,14 +218,15 @@ This extension checks for environmental variables conforming to an expected form For the extension to correctly identify which env var keys map to the format used for the config object, env var keys should be formatted in the following way: - All uppercase - Replace periods ('.') with two underscores ('__') - Keys must begin with 'CKAN' or 'CKANEXT' + All uppercase + Replace periods ('.') with two underscores ('__') + Keys must begin with 'CKAN' or 'CKANEXT', if they do not you can prepend them with '`CKAN___`' For example: * `CKAN__PLUGINS="envvars image_view text_view recline_view datastore datapusher"` * `CKAN__DATAPUSHER__CALLBACK_URL_BASE=http://ckan:5000` + * `CKAN___BEAKER__SESSION__SECRET=CHANGE_ME` These parameters can be added to the `.env` file From 3a21eb438f964635c5a5d5677a97c01500cb3ee4 Mon Sep 17 00:00:00 2001 From: Brett Jones <54408245+kowh-ai@users.noreply.github.com> Date: Fri, 7 Jul 2023 13:59:39 +0200 Subject: [PATCH 2/4] Update README.md Update for wiki article link --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ffdfaf3..2207071 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ * [The ckanext-envvars extension](#envvars) * [The CKAN_SITE_URL parameter](#CKAN_SITE_URL) * [Changing the base image](#Changing-the-base-image) +* [Replacing DataPusher with XLoader](#Replacing-DataPusher-with-XLoader) ## 1. Overview @@ -240,3 +241,7 @@ For convenience the CKAN_SITE_URL parameter should be set in the .env file. For The base image used in the CKAN Dockerfile and Dockerfile.dev can be changed so a different DockerHub image is used eg: ckan/ckan-base:2.9.9 could be used instead of ckan/ckan-base:2.10.1 + +## 14. Replacing DataPusher with XLoader + +Check out the wiki page for this:https://github.com/ckan/ckan-docker/wiki/Replacing-DataPusher-with-XLoader From 5793f85cb65ba0ae429d18067fad00426847a20d Mon Sep 17 00:00:00 2001 From: Brett Jones <54408245+kowh-ai@users.noreply.github.com> Date: Fri, 7 Jul 2023 14:00:47 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2207071..f45b24b 100644 --- a/README.md +++ b/README.md @@ -244,4 +244,4 @@ could be used instead of ckan/ckan-base:2.10.1 ## 14. Replacing DataPusher with XLoader -Check out the wiki page for this:https://github.com/ckan/ckan-docker/wiki/Replacing-DataPusher-with-XLoader +Check out the wiki page for this: https://github.com/ckan/ckan-docker/wiki/Replacing-DataPusher-with-XLoader From 93831d96f240c9fabbdcfa8ca6d6e60804702f3f Mon Sep 17 00:00:00 2001 From: mjanez <96422458+mjanez@users.noreply.github.com> Date: Mon, 24 Jul 2023 02:06:26 +0200 Subject: [PATCH 4/4] Fix README --- README.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a964913..6244f75 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,28 @@ ckan-spatial -* [Overview](#overview) -* [Installing Docker](#installing-docker) -* [docker compose vs docker-compose](#docker-compose-vs-docker-compose) -* [Install CKAN plus dependencies](#install-ckan-plus-dependencies) -* [Development mode](#development-mode) - * [Create an extension](#create-an-extension) -* [CKAN images](#ckan-images) - * [Extending the base images](#extending-the-base-images) - * [Applying patches](#applying-patches) -* [Debugging with pdb](#pdb) -* [Datastore and Datapusher](#Datastore-and-datapusher) -* [NGINX](#nginx) -* [The ckanext-envvars extension](#envvars) -* [The CKAN_SITE_URL parameter](#CKAN_SITE_URL) -* [Changing the base image](#Changing-the-base-image) +

+ Overview • + Branch roadmap • + Environment: docker • + Install CKAN • + CKAN images • + Extending guide • + Applying patches • + Addons • + Info & Backups • +

+ +**Requirements**: +* [Docker](https://docs.docker.com/get-docker/) + +## Overview +Contains Docker images for the different components of CKAN Cloud and a Docker compose environment (based on [ckan](https://github.com/ckan/ckan)) for development and testing Open Data portals. + +>**Warning**:
+>This is a **custom installation of Docker Compose** with specific extensions for spatial data and [GeoDCAT-AP](https://github.com/SEMICeu/GeoDCAT-AP)/[INSPIRE](https://github.com/INSPIRE-MIF/technical-guidelines) metadata [profiles](https://en.wikipedia.org/wiki/Geospatial_metadata). For official installations, please have a look: [CKAN documentation: Installation](https://docs.ckan.org/en/latest/maintaining/installing/index.html). + +![CKAN Docker Platform](/doc/img/ckan-docker-services.png) Available components: @@ -389,7 +396,6 @@ These parameters can be added to the `.env` file For more information please see [ckanext-envvars](https://github.com/okfn/ckanext-envvars) ## xloader - To replacing DataPusher with XLoader check out the wiki page for this: https://github.com/ckan/ckan-docker/wiki/Replacing-DataPusher-with-XLoader ### ckan-pycsw @@ -600,5 +606,9 @@ To have Docker Compose run automatically when you reboot a machine, you can foll ``` -The base image used in the CKAN Dockerfile and Dockerfile.dev can be changed so a different DockerHub image is used eg: ckan/ckan-base:2.9.9 -could be used instead of ckan/ckan-base:2.10.1 +[^1]: Official CKAN repo: https://github.com/ckan/ckan-docker-base +[^2]: Contains fields needed for the [ckanext-spatial geo search](https://docs.ckan.org/projects/ckanext-spatial/en/latest/spatial-search.html) +[^3]: Development environment. +[^4]: Production environment. +[^5]: [ckan_geodcatap](https://github.com/mjanez/ckanext-scheming/blob/036b8c6503059e0d42b0eba180d5bd39205c64a3/ckanext/scheming/ckan_geodcatap.yaml), more info: https://github.com/mjanez/ckanext-scheming/pull/1 +[^6]: A fork of [COATNor/coat2pycsw](https://github.com/COATnor/coat2pycsw) that has been extended to meet the needs of harvesting GeoDCAT-AP metadata according to INSPIRE ISO19139. \ No newline at end of file