Add Django Config Env Var
DevelopmentAdd Django Config Env Var is an Agent Skill for development published in the baserow/baserow repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Add a new environment variable for a Django setting in Baserow and propagate it to the few repo files that usually need it. Use this when a request says a config env var must be added in several places or references `INTEGRATION_LOCAL_BASEROW_PAGE_SIZE_LIMIT` as the pattern to follow.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/baserow/baserow/blob/HEAD/.agents/skills/add-django-config-env-var/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/add-django-config-env-var, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Add Django Config Env Var
Use INTEGRATION_LOCAL_BASEROW_PAGE_SIZE_LIMIT as the template. The env var name should be prefixed with BASEROW_ but the internal var isn't.
Keep the change simple and explicit. Do not add abstractions for this.
Files To Check
When adding a new setting, usually check these files:
backend/src/baserow/config/settings/base.pydocker-compose.ymldocker-compose.no-caddy.ymlweb-frontend/env-remap.mjsdocs/installation/configuration.md— the canonical env-var reference table; add a row in the right section- Backend or frontend code that uses the setting
- A focused test if behavior changes
Workflow
- Add the Django setting in
backend/src/baserow/config/settings/base.pynear the closest related setting.
Example:
MY_SETTING = int(os.getenv("BASEROW_MY_SETTING", 123))
- If the variable should be configurable in Docker, add it everywhere the similar example appears in:
docker-compose.ymldocker-compose.no-caddy.yml
-
If the frontend needs it at runtime, add it to
web-frontend/env-remap.mjs. -
Update consumers to use the setting:
- Backend:
settings.MY_SETTING - Tests:
override_settings(MY_SETTING=...)
-
Add or update a targeted test if the setting changes behavior.
-
Add the related documentation in
docs/installation/configuration.md— find the right section (e.g. Backend Configuration, Integration Configuration) and add a table row matching the format of the nearest existing entry.
Quick Checklist
- Add it in
base.py - Mirror the matching Docker entries
- Add the Nuxt remap if frontend code needs it
- Use
settings.<NAME>in code - Add a focused test if needed
- Add a row to
docs/installation/configuration.mdwhen necessary
Guardrails
- Do not add a raw
os.getenv(...)in application code when the value belongs in Django settings. - Do not update only one Docker location if the example appears in several places.
- Do not expose a backend-only setting to Nuxt unless the frontend actually needs it.
- Prefer copying the closest existing setting instead of inventing a new pattern.