Extension Environment Variables


Extension Basics

Title
Environment Variables
Name
ckanext-envvars
Type
Public extension
Description
Allows CKAN configuration settings to be overridden by environment variables.
CKAN versions
Download-Url (zip)
Download-Url commit date
2024-09-11
Url to repo
Category
Cloud Infrastructure & Storage


Background Infos

Description (long)
Show details

CKAN Environment Variables extension enables configuration of CKAN settings through environment variables, making it ideal for containerized deployments and DevOps workflows. The extension maps environment variables to CKAN configuration settings using a specific naming convention where variables must be uppercase, start with CKAN or CKANEXT, and use double underscores instead of periods. For example, ckan.site_id becomes CKAN__SITE_ID. This approach simplifies configuration management in Docker containers, Kubernetes deployments, and CI/CD pipelines by eliminating the need to modify configuration files directly. The extension processes environment variables at startup and overrides corresponding configuration file settings, providing a clean separation between code and configuration.

Version
0.0.6
Version release date
2024-09-11
Contact name
CKAN Development Team
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Must be the last plugin in ckan.plugins list to ensure all settings are overridden. Use CKAN__SETTING__NAME format for environment variables.

Plugins to configure (ckan.ini)
envvars
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions