This repo builds a Phoenix Framework docker image.
This image is based on the Elixir Alpine docker image.
The included prepare script will
create a Phoenix Framework project without database support.
The naming convention is branched into Standard and Extended and is
based on similar projects based on the Alpine Linux distribution, where
-alpine is appended to the end of the tag.
The Standard branch is based on the latest stable version of Elixir provided by the Elixir docker image.
The Extended branch may either be based on the previous stable version of Elixir or the cutting edge version of Elixir.
aviumlabs/phoenix:<version | latest>-alpine
Where version is either numeric based on the Phoenix version or the literal 'latest'.
aviumlabs/phoenix:<version | latest>-elixir<version>-alpine
The image defaults to building the latest version of Phoenix Framework.
docker build --no-cache -t aviumlabs/phoenix:latest-alpine .
Update the base image:
docker build --pull --no-cache -t aviumlabs/phoenix:latest-alpine .
To build a specific version of the Phoenix Framework; pass in the Phoenix version you want to build:
export PHX_VERSION=1.7.10
docker build --no-cache -t aviumlabs/phoenix:$PHX_VERSION-alpine \
--build-arg PHX_VERSION=$PHX_VERSION .
Run the docker image and confirm alpine version, postgresql client version:
docker run -it --rm aviumlabs/phoenix:latest-alpine /bin/sh
/opt # cat /etc/alpine-release
3.19.1
/opt # psql --version
psql (PostgreSQL) 16.2
This repo is a template repo.
GitHub documentation for using a template repository is here:
https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
gh repo create <application_name> -c -d "Application description" \
--private|public -p aviumlabs/phoenix
Created repository <github_userid><application_name> on GitHub
Cloning into '<application_name>'...
There is a companion project to this project for building a Phoenix Framework project integrated with PostgreSQL.
https://github.com/aviumlabs/phoenix-compose.git
The aviumlabs/phoenix-compose repo is also a template repository.
The services included are:
- PostgreSQL 16.2
- Phoenix Framework 1.7.12 or later
Testing prior to a new build:
$ cd <image/directory>
./prepare -i apptest
Initializing Phoenix Framework project...
Application container root... /opt
Application name............. apptest
Running phx.new --install --no-ecto...
...
- running mix deps.get
- running mix assets.setup
- running mix deps.compile
...We are almost there! The following steps are missing:
$ cd testapp
Start your Phoenix app with:
$ mix phx.server
You can also run your app inside IEx (Interactive Elixir) as:
$ iex -S mix phx.server
The above 3 steps are completed by the prepare script with -f flag:
./prepare -f
Compiling 14 files (.ex)
Generated apptest app
[info] Running ApptestWeb.Endpoint with cowboy 2.10.0 at 0.0.0.0:4000 (http)
[info] Access ApptestWeb.Endpoint at http://localhost:4000
[debug] Downloading esbuild from https://registry.npmjs.org/@esbuild/linux-x64/0.17.11Rebuilding...
[watch] build finished, watching for changes...Done in 765ms.
Prepare -f finalizes the configuration and brings the docker container up in the foreground.
In a separate terminal session, confirm the application is running:
curl -X 'GET' http://localhost:4000
<!-- <ApptestWeb.Layouts.root> lib/apptest_web/components/layouts/root.html.heex:1 --> <!DOCTYPE html>
<html lang="en" class="[scrollbar-gutter:stable]">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="csrf-token" content="LT8sMxZVDDJOXDckWgEJOBsaCTF2cj5ffIYfA2CfziVuc2qTpnMp45w-">
<title data-suffix=" · Phoenix Framework">
Apptest
· Phoenix Framework</title><!-- </Phoenix.Component.live_title> -->
<link phx-track-static rel="stylesheet" href="/assets/app.css">
<script defer phx-track-static type="text/javascript" src="/assets/app.js">
</script>
</head>
<body class="bg-white antialiased">
...
<iframe hidden height="0" width="0" src="/phoenix/live_reload/frame"></iframe></body>
</html><!-- </ApptestWeb.Layouts.root> -->
Output from apptest runtime terminal:
[info] GET /
[debug] Processing with ApptestWeb.PageController.home/2
Parameters: %{}
Pipelines: [:browser]
[info] Sent 200 in 760µs
Press ctrl-c a to stop running apptest
The Avium Labs Phoenix docker image includes the MIX_ENV environment variable in the Dockerfile.
The prepare script creates a docker environment file - .env in the
applications root directory. Change the MIX_ENV variable to test before
running the mix test task.
MIX_ENV=test
Run docker compose down/docker compose up to load the updated configuration and
then run mix test.
Change the MIX_ENV setting back to dev, run docker compose down/up to go back
to development mode.
Internal notes for pushing images to Docker Hub.
docker push aviumlabs/phoenix:<tagname>-alpine
docker push aviumlabs/phoenix:latest-alpine