Skip to content

Introduce env example file - #333

Draft
Samk13 wants to merge 1 commit into
inveniosoftware:masterfrom
Samk13:introduce-env-example-file
Draft

Introduce env example file#333
Samk13 wants to merge 1 commit into
inveniosoftware:masterfrom
Samk13:introduce-env-example-file

Conversation

@Samk13

@Samk13 Samk13 commented Jun 5, 2026

Copy link
Copy Markdown
Member

❤️ Thank you for your contribution!

Description

build based on #304

Background

During review of the cookiecutter upgrade PR, we discussed reducing hard-coded CHANGE_ME values in docker-services and moving configuration into environment files.

The discussion surfaced a few possible approaches:

  • Use a single .env file for both service/container configuration and Invenio application configuration.
  • Keep service and application configuration separated (e.g. .containers-env and .invenio-env).
  • Use an additional private configuration file such as invenio-private.cfg for application secrets, mounted at runtime rather than baked into images.
  • Provide example configuration files (example.env or .env.example) and keep real environment files excluded from version control.

Goal

Evaluate whether the remaining hard-coded CHANGE_ME values should be moved to environment variables and whether we should consolidate configuration into a single .env-based workflow (or adopt another approach).

Checklist

Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:

Frontend

Reminder

By using GitHub, you have already agreed to the GitHub’s Terms of Service including that:

  1. You license your contribution under the same terms as the current repository’s license.
  2. You agree that you have the right to license your contribution under the current repository’s license.

* Refactor docker-services.yml to use variables for PostgreSQL
  credentials and other environment variables.
* Introduce example.env for local Docker Compose setup with
  necessary configurations.
@Samk13
Samk13 force-pushed the introduce-env-example-file branch from 8579686 to 97b64a4 Compare June 19, 2026 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant