Remove local cfg#10
Merged
Merged
Conversation
- Delete backend/local.cfg - Remove COPY of local.cfg from backend.dockerfile - Add plugin sequence (PasswordAuthentication) and ip.bioIPsRange1/2 placeholder env vars to the backend service in docker-compose.yml, mirroring the __P__-encoded env-var pattern used by the Kubernetes ConfigMap in deepblue-documents-kube - Update README.md: remove local.cfg references; document env-var approach - Update dspace/README.md: replace stale "Secrets mounted as files" note with correct ConfigMap/env-var description
Contributor
There was a problem hiding this comment.
Pull request overview
Removes the local development backend/local.cfg override file and shifts its settings into Docker Compose environment variables, aligning local configuration delivery with the production pattern of runtime configuration via env vars.
Changes:
- Deleted
backend/local.cfgand removed the correspondingCOPYstep frombackend.dockerfile. - Added three
__P__-encoded DSpace configuration environment variables to thebackendservice indocker-compose.yml. - Updated documentation/task tracking to remove
local.cfgreferences and describe the env-var approach.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| dspace/README.md | Updates production configuration note to describe runtime env-var delivery. |
| docker-compose.yml | Adds env vars to disable OIDC locally and provide placeholder IP ranges to avoid startup NPEs. |
| backend/local.cfg | Removes the local override file (no longer needed). |
| backend.dockerfile | Stops copying backend/local.cfg into the image. |
| README.md | Removes local.cfg references; documents env-var-based configuration for local/prod. |
| TODO.md | Minor formatting cleanup. |
| DONE.md | Records completion of the local.cfg removal/documentation updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
Replace local.cfg with Docker Compose environment variables
Summary
Removes backend/local.cfg and its COPY instruction from backend.dockerfile, replacing it with explicit environment: entries in the backend service of docker-compose.yml. This aligns local development with the Kubernetes ConfigMap pattern already used in production (backend-cm.jsonnet), where all DSpace configuration is delivered as P-encoded environment variables rather than baked-in config files.
Changes
backend/local.cfg — deleted; no longer needed now that its three settings are expressed as env vars in docker-compose.yml
backend.dockerfile — removed COPY ./backend/local.cfg … instruction; the root Dockerfile (used for local dev and CI) no longer copies any config file into the image
docker-compose.yml — added three env vars to the backend service:
plugin__P__sequence__P__org__P__dspace__P__authenticate__P__AuthenticationMethod=org.dspace.authenticate.PasswordAuthentication — disables OIDC, enables password auth for local dev
ip__P__bioIPsRange1=192.0.2.0/24 — non-routable placeholder so OidcAuthenticationBean does not throw NullPointerException at startup
ip__P__bioIPsRange2=192.0.2.0/24 — same
README.md — removed all backend/local.cfg references; updated "For other institutions" section and the Notes bullet to document the env-var approach instead
dspace/README.md — corrected the NOTE under "build images": replaced the stale "Kubernetes Secrets mounted directly as single files (dspace.cfg, authentication-oidc.cfg)" description with the accurate statement that production config is supplied via environment variables from a Kubernetes ConfigMap (non-sensitive) and Secrets (sensitive), both managed in deepblue-documents-kube
TODO.md / DONE.md — task tracking updated; completed tasks archived