tlux / database_yaml_config_provider

An Elixir 1.9+ config provider to load a Rails style database.yml file

Database YAML Config Provider

An Elixir 1.9+ config provider to load a Rails style database.yml file with the following structure when booting up the application.

production:
  adapter: postgresql
  database: testdb
  username: testuser
  password: myPa$sw0rd
  host: pgsqlhost
  port: 5432

The primary intention of this library is to simplify the migration process from a Rails app to Phoenix Framework.

Prerequisites

• Elixir >= 1.9

Installation

def deps do
  [
    {:database_yaml_config_provider, "~> 0.1", only: :prod}
  ]
end

Usage

You need to register this DatabaseYamlConfigProvider as config provider in the releases section of your mix.exs file.

releases: [
  my_app: [
    config_providers: [
      {DatabaseYamlConfigProvider,
       repo: MyApp.Repo,
       path: "/production/shared/config/database.yml"}
    ],
    ...
  ]
]

By default, this config provider expects an ENV environment variable that contains the current hosting environment name to be present when booting the application.

Alternatively, you can set the environment directly when defining the config provider.

{DatabaseYamlConfigProvider,
 repo: MyApp.Repo,
 path: "/production/shared/config",
 env: "production"}

Or you can speficy another env var containing the particular hosting environment on application startup:

{DatabaseYamlConfigProvider,
 repo: MyApp.Repo,
 path: "/production/shared/config",
 env: {:system, "RAILS_ENV"}}

The same works for the location of the database file. You can specify an env var containing the path to a folder that contains the database.yml file:

{DatabaseYamlConfigProvider,
 repo: MyApp.Repo,
 path: {:system, "RELEASE_CONFIG_PATH"}}

When the filename deviates from database.yml you can customize it, too:

{DatabaseYamlConfigProvider,
 repo: MyApp.Repo,
 path: {:system, "RELEASE_CONFIG_PATH", "my_custom_database.yml"}}

Docs

Documentation can be found at HexDocs.