From 3c9c3dd41fbb218f5001fdfba0c13978a722f9b7 Mon Sep 17 00:00:00 2001 From: Brett Date: Wed, 3 Jul 2024 16:38:45 +0200 Subject: [PATCH 1/5] Update README Add section: "Updating the .env file for development mode" --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7e4fde876..ad0d66347 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,16 @@ In VS Code: You can now set breakpoints and remote debug your CKAN development instance. +#### Updating the .env file for development mode + +The Docker Compose .env file by default is set up for production mode. There are a few changes needed if you would +like to run in Development mode: + +1. Change the `CKAN_SITE_URL` variable to be: http://localhost:5000 +2. Update the `CKAN__DATAPUSHER__CALLBACK_URL_BASE` variable to use the `ckan-dev` container name: http://ckan-dev:5000 +3. Update the `DATAPUSHER_REWRITE_URL` variable to also use the `ckan-dev` container name http://ckan-dev:5000 + + ## 5. CKAN images ![ckan images](https://user-images.githubusercontent.com/54408245/207079416-a01235af-2dea-4425-b6fd-f8c3687dd993.png) From 020b1b8259d36c4fd05e074b5429028536bd8eff Mon Sep 17 00:00:00 2001 From: Brett Date: Thu, 4 Jul 2024 09:30:17 +0200 Subject: [PATCH 2/5] Update README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad0d66347..6021a4d19 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ * [Create an extension](#create-an-extension) * [Running HTTPS on development mode](#running-https-on-development-mode) * [Remote Debugging with VS Code](#remote-debugging-with-vs-code) + * [Updating the environment file for development mode](#updating-the-environment-file-for-development-mode) * [5. CKAN images](#5-ckan-images) * [Extending the base images](#extending-the-base-images) * [Applying patches](#applying-patches) @@ -152,10 +153,9 @@ In VS Code: You can now set breakpoints and remote debug your CKAN development instance. -#### Updating the .env file for development mode +#### Updating the environment file for development mode -The Docker Compose .env file by default is set up for production mode. There are a few changes needed if you would -like to run in Development mode: +The Docker Compose environment `.env` file by default is set up for production mode. There are a few changes needed if you would like to run in Development mode: 1. Change the `CKAN_SITE_URL` variable to be: http://localhost:5000 2. Update the `CKAN__DATAPUSHER__CALLBACK_URL_BASE` variable to use the `ckan-dev` container name: http://ckan-dev:5000 From 38d1a11265291d24bd6a8ea82420adf8d7e73701 Mon Sep 17 00:00:00 2001 From: Ian Ward Date: Wed, 10 Jul 2024 13:45:32 -0400 Subject: [PATCH 3/5] envvars last plugin in .env.example envvars should be last in the list of plugins so that other plugins can read/update the values it sets --- .env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.env.example b/.env.example index 830cf9497..74ba958ce 100644 --- a/.env.example +++ b/.env.example @@ -69,7 +69,7 @@ NGINX_PORT=80 NGINX_SSLPORT=443 # Extensions -CKAN__PLUGINS="envvars image_view text_view datatables_view datastore datapusher" +CKAN__PLUGINS="image_view text_view datatables_view datastore datapusher envvars" CKAN__HARVEST__MQ__TYPE=redis CKAN__HARVEST__MQ__HOSTNAME=redis CKAN__HARVEST__MQ__PORT=6379 From 18fbe445c1782d887f6ac77813e507d529246b53 Mon Sep 17 00:00:00 2001 From: Ian Ward Date: Wed, 10 Jul 2024 14:46:00 -0400 Subject: [PATCH 4/5] remove broken, confusing CKAN_PORT setting --- .env.example | 2 -- README.md | 3 --- docker-compose.dev.yml | 2 +- 3 files changed, 1 insertion(+), 6 deletions(-) diff --git a/.env.example b/.env.example index 830cf9497..3e556ea1e 100644 --- a/.env.example +++ b/.env.example @@ -30,8 +30,6 @@ USE_HTTPS_FOR_DEV=false CKAN_VERSION=2.10.0 CKAN_SITE_ID=default CKAN_SITE_URL=https://localhost:8443 -CKAN_PORT=5000 -CKAN_PORT_HOST=5000 CKAN___BEAKER__SESSION__SECRET=CHANGE_ME # See https://docs.ckan.org/en/latest/maintaining/configuration.html#api-token-settings CKAN___API_TOKEN__JWT__ENCODE__SECRET=string:CHANGE_ME diff --git a/README.md b/README.md index 6021a4d19..4756a9c57 100644 --- a/README.md +++ b/README.md @@ -248,9 +248,6 @@ ckan Add these lines to the `ckan-dev` service in the docker-compose.dev.yml file ```yaml -ports: - - "0.0.0.0:${CKAN_PORT}:5000" - stdin_open: true tty: true ``` diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index b1a56a493..72cd4a852 100755 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -21,7 +21,7 @@ services: - solr - redis ports: - - "0.0.0.0:${CKAN_PORT_HOST}:${CKAN_PORT}" + - "0.0.0.0:${CKAN_PORT_HOST}:5000" volumes: - ckan_storage:/var/lib/ckan - ./src:/srv/app/src_extensions From 0cb87296d80c554a3f20e2008d1f3fbe1362ad6f Mon Sep 17 00:00:00 2001 From: amercader Date: Wed, 21 Aug 2024 13:14:28 +0200 Subject: [PATCH 5/5] Update project images to latest ckan release --- README.md | 3 +-- ckan/Dockerfile | 2 +- ckan/Dockerfile.dev | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4756a9c57..e209e3b6b 100644 --- a/README.md +++ b/README.md @@ -314,8 +314,7 @@ For convenience the CKAN_SITE_URL parameter should be set in the .env file. For ## 12. Changing the base image -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 +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.10.5 can be used instead of ckan/ckan-base:2.11.0 ## 13. Replacing DataPusher with XLoader diff --git a/ckan/Dockerfile b/ckan/Dockerfile index f9dae59a9..67a431ea5 100644 --- a/ckan/Dockerfile +++ b/ckan/Dockerfile @@ -1,4 +1,4 @@ -FROM ckan/ckan-base:2.10.4 +FROM ckan/ckan-base:2.11.0 # Install any extensions needed by your CKAN instance # See Dockerfile.dev for more details and examples diff --git a/ckan/Dockerfile.dev b/ckan/Dockerfile.dev index 1f70363bd..a81550718 100644 --- a/ckan/Dockerfile.dev +++ b/ckan/Dockerfile.dev @@ -1,4 +1,4 @@ -FROM ckan/ckan-dev:2.10.4 +FROM ckan/ckan-dev:2.11.0 # Install any extensions needed by your CKAN instance # - Make sure to add the plugins to CKAN__PLUGINS in the .env file