Skip to content

Improve portability of configurations - #4

Merged
jscgh merged 11 commits into
masterfrom
portable-config
Mar 31, 2026
Merged

jscgh merged 11 commits into
masterfrom
portable-config

Conversation

@jscgh

@jscgh jscgh commented Mar 31, 2026

Copy link
Copy Markdown
Owner

To ease institutional deployments this PR refactors configuration to be standardised via the .env file.
Introduces required variable checks for job scripts, centralises and documents environment variable usage, and clarifies instructions.

  • Added a comprehensive .env.example file listing all required and optional environment variables, with documentation for each, to serve as a template for site-specific configuration (template/.env)
  • Introduced portal_default_* variables at the top of form.yml.erb and submit.yml.erb, and used ERB to set cluster, queue, and script defaults, making it easier to adapt the portal to new sites.
  • Updated the README to clarify the distinction between portal-side defaults (in ERB templates) and runtime configuration (in .env), and provided improved instructions for site admins on how to configure and deploy the app.
  • Refactored submit.yml.erb to decouple settings from hardcoded values.

@jscgh jscgh self-assigned this Mar 31, 2026
@jscgh jscgh added the enhancement New feature or request label Mar 31, 2026
@jscgh jscgh changed the title Port Improve portability of configurations Mar 31, 2026
@jscgh
jscgh merged commit 1b5d2d3 into master Mar 31, 2026
1 check passed
@jscgh
jscgh deleted the portable-config branch March 31, 2026 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant