gitea/ckan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #215 from BWibo/uwsgi-opts
Some checks are pending
Build CKAN Docker / build (push) Waiting to run
Details

Browse Source 
Add documentation for for new uWSGI env var configs
This commit is contained in:
Adrià Mercader 2025-05-07 12:40:03 +02:00 committed by GitHub
commit fc90a89227
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 49 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -1,27 +1,30 @@
# Docker Compose setup for CKAN # Docker Compose setup for CKAN
* [1. Overview](#1-overview) - [Docker Compose setup for CKAN](#docker-compose-setup-for-ckan)
* [2. Installing Docker](#2-installing-docker) - [1. Overview](#1--overview)
* [3. docker compose vs docker-compose](#3-docker-compose-vs-docker-compose) - [2. Installing Docker](#2--installing-docker)
* [4. Install (build and run) CKAN plus dependencies](#4-install-build-and-run-ckan-plus-dependencies) - [3. docker compose *vs* docker-compose](#3--docker-compose-vs-docker-compose)
* [Base mode](#base-mode) - [4. Install (build and run) CKAN plus dependencies](#4--install-build-and-run-ckan-plus-dependencies)
* [Development mode](#development-mode) - [Base mode](#base-mode)
* [Create an extension](#create-an-extension) - [Development mode](#development-mode)
* [Running HTTPS on development mode](#running-https-on-development-mode) - [Create an extension](#create-an-extension)
* [Remote Debugging with VS Code](#remote-debugging-with-vs-code) - [Running HTTPS on development mode](#running-https-on-development-mode)
* [Updating the environment file for development mode](#updating-the-environment-file-for-development-mode) - [Remote Debugging with VS Code](#remote-debugging-with-vs-code)
* [5. CKAN images](#5-ckan-images) - [Updating the environment file for development mode](#updating-the-environment-file-for-development-mode)
* [Extending the base images](#extending-the-base-images) - [5. CKAN images](#5-ckan-images)
* [Applying patches](#applying-patches) - [Extending the base images](#extending-the-base-images)
* [6. Debugging with pdb](#6-debugging-with-pdb) - [Applying patches](#applying-patches)
* [7. Datastore and Datapusher](#7-datastore-and-datapusher) - [_uWSGI_ command line arguments](#uwsgi-command-line-arguments)
* [8. NGINX](#8-nginx) - [6. Debugging with pdb](#6-debugging-with-pdb)
* [9. ckanext-envvars](#9-ckanext-envvars) - [7. Datastore and datapusher](#7-datastore-and-datapusher)
* [10. CKAN_SITE_URL](#10-CKAN_SITE_URL) - [8. NGINX](#8-nginx)
* [11. Manage new users](#11-manage-new-users) - [9. ckanext-envvars](#9-ckanext-envvars)
* [12. Changing the base image](#12-changing-the-base-image) - [10. CKAN\_SITE\_URL](#10-ckan_site_url)
* [13. Replacing DataPusher with XLoader](#13-replacing-datapusher-with-xLoader) - [11. Manage new users](#11-manage-new-users)
- [12. Changing the base image](#12-changing-the-base-image)
- [13. Replacing DataPusher with XLoader](#13-replacing-datapusher-with-xloader)
- [Copying and License](#copying-and-license)
## 1. Overview ## 1. Overview
@ -275,9 +278,23 @@ ckan
├── setup ├── setup
├── Dockerfile ├── Dockerfile
└── Dockerfile.dev └── Dockerfile.dev
``` ```
### _uWSGI_ command line arguments
The images use the application server [_uWSGI_](https://uwsgi-docs.readthedocs.io/en/latest/) to run _CKAN_. There are two environment variables, that allow to configure _uWSGI_ using [command line arguments](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html#command-line-arguments). The available options are described [here](https://uwsgi-docs.readthedocs.io/en/latest/Options.html).
For most use cases, the defaults specified in `ckan-X.XX/setup/start_ckan.sh` in `DEFAULT_UWSGI_OPTS` of the [ckan/ckan-docker-base](https://github.com/ckan/ckan-docker-base) image are fine. If required, you can either _overwrite_ the defaults or _append_ additional arguments.
| Variable | Description | Defaults |
|:--------------------|:------------------------------------------------------| :------------------|
| `UWSGI_OPTS` | If set, overwrites `DEFAULT_UWSGI_OPTS`. If not set, `UWSGI_OPTS` will bet set to `DEFAULT_UWSGI_OPTS`. | unset |
| `EXTRA_UWSGI_OPTS` | If set, appends its content to `UWSGI_OPTS`. | unset |
> [!IMPORTANT]
> These setting **do not** apply for the dev images.
## 6. Debugging with pdb ## 6. Debugging with pdb
Add these lines to the `ckan-dev` service in the docker-compose.dev.yml file Add these lines to the `ckan-dev` service in the docker-compose.dev.yml file