From f8a3696db94ce22b8ec6d5dbc94adce5fb7ab3d4 Mon Sep 17 00:00:00 2001 From: amercader Date: Thu, 5 Oct 2023 13:57:06 +0200 Subject: [PATCH] Document how to run the dev server with HTTPS This requires https://github.com/ckan/ckan-docker-base/pull/29 and the images to be rebuilt and pushed before merging --- .env.example | 3 +++ README.md | 15 +++++++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index 07ab2b5..3508b6e 100644 --- a/.env.example +++ b/.env.example @@ -32,6 +32,9 @@ TEST_CKAN_SQLALCHEMY_URL=postgres://ckan:ckan@db/ckan_test TEST_CKAN_DATASTORE_WRITE_URL=postgresql://ckan:ckan@db/datastore_test TEST_CKAN_DATASTORE_READ_URL=postgresql://datastore_ro:datastore@db/datastore_test +# Dev settings +USE_HTTPS_FOR_DEV=false + # CKAN core CKAN_VERSION=2.10.0 CKAN_SITE_ID=default diff --git a/README.md b/README.md index 4ba6346..6bab616 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ * [Install CKAN plus dependencies](#install-ckan-plus-dependencies) * [Development mode](#development-mode) * [Create an extension](#create-an-extension) + * [Running HTTPS on development mode](#running-https-on-development-mode) * [CKAN images](#ckan-images) * [Extending the base images](#extending-the-base-images) * [Applying patches](#applying-patches) @@ -96,8 +97,6 @@ To start the containers: See [CKAN Images](#ckan-images) for more details of what happens when using development mode. - - ##### Create an extension You can use the ckan [extension](https://docs.ckan.org/en/latest/extensions/tutorial.html#creating-a-new-extension) instructions to create a CKAN extension, only executing the command inside the CKAN container and setting the mounted `src/` folder as output: @@ -109,6 +108,18 @@ You can use the ckan [extension](https://docs.ckan.org/en/latest/extensions/tuto The new extension files and directories are created in the `/srv/app/src_extensions/` folder in the running container. They will also exist in the local src/ directory as local `/src` directory is mounted as `/srv/app/src_extensions/` on the ckan container. You might need to change the owner of its folder to have the appropiate permissions. +##### Running HTTPS on development mode + +Sometimes is useful to run your local development instance under HTTPS, for instance if you are using authentication extensions like [ckanext-saml2auth](https://github.com/keitaroinc/ckanext-saml2auth). To enable it, set the following in your `.env` file: + + USE_HTTPS_FOR_DEV=true + +and update the site URL setting: + + CKAN_SITE_URL=https://localhost:5000 + +After recreating the `ckan-dev` container, you should be able to access CKAN at https://localhost:5000 + ## 5. CKAN images ![ckan images](https://user-images.githubusercontent.com/54408245/207079416-a01235af-2dea-4425-b6fd-f8c3687dd993.png)