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

This commit is contained in:
mnjnz 2024-03-20 14:00:50 +01:00
commit f39aafefef
No known key found for this signature in database
GPG Key ID: 2654E8DA034EB7B5
5 changed files with 20 additions and 3 deletions

View File

@ -80,6 +80,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
## If use docker-compose.ghcr.yml only "*.*.*" versions available in: https://github.com/mjanez/ckan-docker/pkgs/container/ckan-docker
CKAN_VERSION=2.9.9

View File

@ -203,7 +203,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:
@ -214,6 +213,17 @@ 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
## CKAN images
![CKAN Docker Platform](/doc/img/ckan-docker-images.png)
@ -285,7 +295,6 @@ COPY docker-entrypoint.d/* /docker-entrypoint.d/
NB: There are a number of extension examples commented out in the Dockerfile.dev file
### Applying patches
When building your project specific CKAN images (the ones defined in the `ckan/` folder), you can apply patches
to CKAN core or any of the built extensions. To do so create a folder inside `ckan/patches` with the name of the

View File

@ -0,0 +1,4 @@
Use scripts in this folder to run extra initialization steps in your custom CKAN images.
Any file with `.sh` or `.py` extension will be executed just after the main initialization
script (`prerun.py`) is executed and just before the web server and supervisor processes are
started.

View File

@ -1,4 +1,4 @@
FROM postgres:15-alpine
# Include extra setup scripts (eg datastore)
ADD docker-entrypoint-initdb.d /docker-entrypoint-initdb.d
COPY --chown=postgres:postgres docker-entrypoint-initdb.d /docker-entrypoint-initdb.d

View File

@ -0,0 +1 @@
*.sh text eol=lf