Merge branch 'master' of https://github.com/ckan/ckan-docker into ckan-2.9.9

README.md

@@ -3,28 +3,21 @@
 <a href="https://github.com/mjanez/ckan-docker"><img src="https://img.shields.io/badge/Docker%20CKAN-2.9.9-brightgreen" alt="ckan-spatial"></a>
 
 
-<p align="center">
-    <a href="#overview">Overview</a> •
-    <a href="#ckan-docker-roadmap">Branch roadmap</a> •
-    <a href="#environment-docker">Environment: docker</a> •
-    <a href="#install-build-and-run-ckan-plus-dependencies">Install CKAN</a> •
-    <a href="#ckan-images">CKAN images</a> •   
-    <a href="#extending-the-base-images">Extending guide</a> •
-    <a href="#applying-patches">Applying patches</a> •
-    <a href="#ckan-docker-addons">Addons</a> •
-    <a href="#ckan-docker-tips">Info & Backups</a> •
-</p>
-
-**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**:<br>
->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)
+* [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)
 
 
 Available components:
@@ -381,19 +374,23 @@ 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 
 
 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
 [ckan-pycsw](https://github.com/mjanez/ckan-pycsw) is a docker compose environment (based on [pycsw](https://github.com/geopython/pycsw)) for development and testing with CKAN Open Data portals.[^5]
@@ -603,9 +600,5 @@ To have Docker Compose run automatically when you reboot a machine, you can foll
     ```
 
 
-[^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.
+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