elixir.md

title	Elixir
description	{{% vendor/name %}} supports building and deploying applications written in Elixir. There is no default flavor for the build phase, but you can define it explicitly in your build hook. {{% vendor/name %}} Elixir images support both committed dependencies and download-on-demand. The underlying Erlang version is 22.0.7.

{{% description %}}

Supported versions

{{% major-minor-versions-note configMinor="true" %}}

{{< image-versions image="elixir" status="supported" environment="grid" >}}

{{% language-specification type="elixir" display_name="Elixir" %}}

applications:
    # The app's name, which must be unique within the project.
    <APP_NAME>:
        type: 'elixir:<VERSION_NUMBER>'

For example:

applications:
    # The app's name, which must be unique within the project.
    app:
        type: 'elixir:{{% latest "elixir" %}}'

Built-in variables

{{% vendor/name %}} exposes relationships and other configuration as environment variables. Most notably, it allows a program to determine at runtime what HTTP port it should listen on and what the credentials are to access other services.

To get the PORT environment variable (the port on which your web application is supposed to listen) you would:

String.to_integer(System.get_env("PORT") || "8888")

Some of the environment variables are in JSON format and are base64 encoded. You would need to import a JSON parsing library such as JSON or Poison to read those. (There is an example for doing this to decode the PLATFORM_RELATIONSHIPS environment variable in the section below.)

{{< note title="Tip">}} Remember config/prod.exs is evaluated at build time and has no access to runtime configuration. Use config/releases.exs to configure your runtime environment. {{< /note >}}

Building and running the application

If you are using Hex to manage your dependencies, you need to specify the MIX_ENV environment variable:

applications:
    app:
        type: 'elixir:{{% latest "elixir" %}}'
        variables:
            env:
                MIX_ENV: 'prod'

The SECRET_KEY_BASE variable is generated automatically based on the PLATFORM_PROJECT_ENTROPY variable. You can change it.

Include in your build hook the steps to retrieve a local Hex and rebar, and then run mix do deps.get, deps.compile, compile on your application to build a binary.

applications:
    app:
        type: 'elixir:{{% latest "elixir" %}}'
        hooks:
            build: |
                mix local.hex --force
                mix local.rebar --force
                mix do deps.get --only prod, deps.compile, compile

{{< note >}}

That build hook works for most cases and assumes that your mix.exs file is located at your app root.

{{< /note >}}

Assuming mix.exs is present at your app root and your build hook matches the above, you can then start it from the web.commands.start directive.

The following basic app configuration is sufficient to run most Elixir applications.

applications:
    app:
        type: 'elixir:{{% latest "elixir" %}}'

        variables:
            env:
                MIX_ENV: 'prod'

        hooks:
            build: |
                mix local.hex --force
                mix local.rebar --force
                mix do deps.get --only prod, deps.compile, compile

        web:
            commands:
                start: mix phx.server
            locations:
                /:
                    allow: false
                    passthru: true

Note that there is still an Nginx proxy server sitting in front of your application. If desired, certain paths may be served directly by Nginx without hitting your application (for static files, primarily) or you may route all requests to the Elixir application unconditionally, as in the example above.

Dependencies

The recommended way to handle Elixir dependencies on {{% vendor/name %}} is using Hex. You can commit a mix.exs file in your repository and the system downloads the dependencies in your deps section using the build hook above.

  defp deps do
    [
	  {:platformshconfig, "~> 0.1.0"}
    ]
  end

Accessing Services

{{% access-services version="2" %}}

Accessing Services Manually

The services configuration is available in the environment variable PLATFORM_RELATIONSHIPS.

Given a relationship defined in {{< vendor/configfile "app" >}}:

applications:
    app:
        type: 'elixir:{{% latest "elixir" %}}'
        ...
        relationships:
            postgresdatabase: "dbpostgres:postgresql"

Assuming you have in mix.exs the Poison library to parse JSON:

  defp deps do
    [
      {:poison, "~> 3.0"}
    ]
  end

And assuming you use ecto you could put in config/config.exs:

relationships = Poison.decode!(Base.decode64!(System.get_env("PLATFORM_RELATIONSHIPS")))
[postgresql_config | _tail] = relationships["postgresdatabase"]

config :my_app, Repo,
  database: postgresql_config["path"],
  username: postgresql_config["username"],
  password: postgresql_config["password"],
  hostname: postgresql_config["host"]

and setup Ecto during the deploy hook:

deploy: |
    mix do ecto.setup