docs: add missing settings to configuration guide - #49
Open
rcbevans wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
CI failure is a Docker Hub timeout pulling testcontainers/ryuk image — unrelated to this docs-only change. Retriggered. |
Document 10 settings that were defined in settings.py but missing from the configuration guide: admin UI require-auth/actions-enabled, SSO backend, health token/require-token, reclaim event visibility delay, keyed reservation/rate-limit caps, and credential reload interval/factory-timeout.
rcbevans
force-pushed
the
chore/docs-configuration
branch
from
July 30, 2026 04:59
729789b to
6f8cdd1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The configuration guide was missing documentation for 10 settings that are defined in
settings.pybut never made it into the reference tables. Operators had no way to discover these without reading source code.TaskQSettings (5 added):
TASKQ_ADMIN_UI_REQUIRE_AUTH— controls whether the admin UI fails closed on missing auth in non-devTASKQ_ADMIN_ACTIONS_ENABLED— gates destructive admin UI actions (retry, cancel, run-now)TASKQ_SSO_BACKEND— selects SSO backend (none/oidc/saml) for the admin UITASKQ_HEALTH_TOKEN— bearer token for health/metrics endpointsTASKQ_HEALTH_REQUIRE_TOKEN— fails closed on empty health token outside devWorkerSettings (5 added):
TASKQ_RECLAIM_EVENT_VISIBILITY_DELAY— trailing-watermark margin for reclaim event orderingTASKQ_MAX_KEYED_RESERVATIONS— guardrail on in-memory keyed reservation entriesTASKQ_MAX_KEYED_RATE_LIMITS— guardrail on in-memory keyed rate-limit entriesTASKQ_RELOAD_INTERVAL— periodic credential hot-reload timer (for platforms without SIGHUP)TASKQ_RELOAD_FACTORY_TIMEOUT— per-factory-call timeout during credential reload