App env specific runtime files with Releases

Questions / Help
, ,
1

I have a Phoenix application that is happily using runtime.exs to configure settings at runtime. The Phoenix app is deployed via a Dockerfile and a mix release.

In that phoenix application we set our own app_env config setting to distinguish between staging / prod / demo environment settings. The file has been growing steadily, so I’d like to introduce app-env specific runtime config files, similar to what mix does with compile-time settings.

My runtime.exs therefore contains generic configuration that is applicable to all envs - and at the very bottom:

# runtime.exs

# [... generic config here] ...

# Import app env specific config. This must remain at the bottom
# of this file so it overrides the configuration defined above.

runtime_file = "runtime_#{app_env}.exs"
IO.puts("Requiring #{runtime_file}")
Code.require_file(runtime_file, __DIR__)

With my config dir looking like this:

 $ tree config/
config/
├── config.exs
├── dev.exs
├── prod.exs
├── runtime_dev.exs
├── runtime.exs
├── runtime_prod.exs
├── runtime_staging.exs
├── runtime_test.exs
└── test.exs

This works well locally and on CI, but inside the Dockerfile the application is packaged and run via mix release. When starting the app, it rightfully complains that it cannot find config/runtime_prod.exs anymore.

Is there a way I can have these app-env specific runtime files while using mix releases? Looking at my Dockerfile, nothing special is happening with the default runtime.exs, it’s simply copied over:

# Changes to config/runtime.exs don't require recompiling the code
COPY config/runtime.exs config/

COPY rel rel
RUN mix sentry.package_source_code
RUN mix release

My attempt to include the other runtime config files via wildcard does not work:

# Changes to config/runtime.exs don't require recompiling the code
COPY config/runtime*.exs config/

COPY rel rel
RUN mix sentry.package_source_code
RUN mix release
2

I dived a bit deeper into the mix release documentation, ConfigProvider specifically supports loading config files from multiple files (Config.Provider — Elixir v1.18.3), but as far as I can see that would require me to build different releases per app-env.

So that

releases: [
  demo: [
    config_providers: [
      {Config.Reader, {:system, "RELEASE_ROOT", "/runtime_demo.exs"}}
    ]
  ],
  staging: [
    config_providers: [
      {Config.Reader, {:system, "RELEASE_ROOT", "/runtime_staging.exs"}}
    ]
  ]
]

the correct runtime file would be included in the release. Currently I am building one Docker image for all app environments, which is very convenient. I guess I need to somehow put in some custom logic to only execute the relevant app-env-specific runtime file if possible.

3

You can do if/case/switch clauses inside runtime.exs, that’s what I do.

Instead of requiring “runtime_#{app_env}.exs” you can do conditional configs inside the same file, then you don’t have to include additional runtime_XXX.exs files at all.

4

Yep, while not as pretty, we decided to go with the naive solution too. Thanks!

1 Like
5

I’m a big fan of dotenv config, so I would say to use Dotenvy.