aviumlabs/phoenix repository overview

⁠A Phoenix Framework Repo

This repo builds a Phoenix Framework docker image.

The image is based on the Elixir Alpine docker image.

GitHub: https://github.com/aviumlabs/phoenix-img⁠

For the latest changes: CHANGELOG.md

⁠Image Naming Convention

The image naming convention is divided between Standard and Extended. It is based on similar projects running Alpine Linux, where -alpine is appended to the end of the tag.

The Standard naming convention will attempt to be based on the latest version of Alpine, Erlang, Elixir, and the Phoenix Framework except in the case of where a conflict arises.

The Extended naming convention may either be based on the previous stable version of Elixir or the cutting edge version of Elixir.

⁠Standard Naming Convention

aviumlabs/phoenix:<version | latest>-alpine

Where version is either numeric based on the Phoenix version or the literal 'latest'.

⁠Extended Naming Convention

aviumlabs/phoenix:<version | latest>-elixir<version>-alpine

⁠Building an Image

⁠Latest Phoenix Version

This is the default - builds the latest version of Phoenix Framework.

Regular build

docker build --no-cache -t aviumlabs/phoenix:latest-alpine .

Build with sbom and provenance

docker build --no-cache -t aviumlabs/phoenix:latest-alpine --provenance=mode=max --sbom=true .

Update Base Image with Build

docker build --pull --no-cache -t aviumlabs/phoenix:latest-alpine .

With sbom and provenance

docker build --pull --no-cache -t aviumlabs/phoenix:latest-alpine --provenance=mode=max --sbom=true .

⁠Specific Phoenix Version

To build a specific version of Phoenix Framework; pass in the Phoenix version you want to build:

export PHX_VERSION=1.8.8

To build release candidate 4 of Phoenix 1.8:

export PHX_VERSION=1.8.0-rc0

Replace aviumlabs with your docker namespace:

docker build --pull --no-cache -t aviumlabs/phoenix:$PHX_VERSION-alpine \
--build-arg PHX_VERSION=$PHX_VERSION --provenance=mode=max --sbom=true .

⁠Run

Run the docker image and confirm Alpine version, PostgreSQL client version.

Run container in the foreground:

export APP_NAME=app

docker run --name app -it -e APP_NAME=$APP_NAME --rm -p 4000:4000 -w "/opt/phoenix/$APP_NAME" --mount type=bind,src="$(pwd)/src",target="/opt/phoenix/$APP_NAME" aviumlabs/phoenix:latest-alpine

docker run --name app -it -e APP_NAME=$APP_NAME --rm -p 4000:4000 -w "/opt/phoenix/$APP_NAME" --mount type=bind,src="$(pwd)/src",target="/opt/phoenix/$APP_NAME" aviumlabs/phoenix:$PHX_VERSION-alpine

Open an additional shell:

docker exec -it app /bin/ash

cat /etc/alpine-release

psql --version

elixir --version

⁠Application Development

This docker image is designed to work with the host filesystem and the GitHub repository is a template repository.

To create your initial application development environment run the gh repo create command.

⁠Create and Clone a New Repository with GitHub CLI

General command

gh repo create <application_name> -c -d "Application description" \
--private|--public -p aviumlabs/phoenix

Flags

• -c specifies to clone the repository to the current working directory
• -d description of the new repository to be created
• --private|--public specifies if this a private or public repository
• -p make the new repository based on this template repository

gh repo create myapp -c -d "My First Application" --private \
-p aviumlabs/phoenix

The directory structure will now look like this:

• myapp
  • /src
  • /docs
    • /images
    • /pdf
• Dockerfile
• LICENSE
• README.md
• entrypoint.sh

During the first-time run, the application will be configured, and the src directory will be populated with the baseline Phoenix Framwork application.

export APP_NAME=app

docker run --name myapp -it -e APP_NAME=$APP_NAME --rm -p 4000:4000 -w "/opt/phoenix/$APP_NAME" --mount type=bind,src="$(pwd)/src",target="/opt/phoenix/$APP_NAME" aviumlabs/phoenix:latest-alpine 

Browsing to http://localhost:4000⁠ will show you the default landing page of a Phoenix Framework application.

And listing the contents of src directory will show you the standard Phoenix Framework application layout.

• README.md
• assets
• deps
• _build
• config
• lib
• mix.exs
• mix.lock
• priv
• test

As a development environment, live_reload is active.

Edit src/lib/my_webapp/controllers/page_html/home.html.eex

Search for Phoenix Framework and insert some text like MyApp powered by Phoenix Framework.

Save the file and go back to your browser and you will automatically see the change.

Pretty awesome! Much gratitude and appreciation to the Phoenix Framework, Elixir, Erlang, Alpine, and PostgreSQL teams for their amazing work!

Have fun!

References

• https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template⁠

⁠Companion Project

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 18.1 or later
• Phoenix Framework 1.8.3 or later

⁠Project Notes

⁠Project Testing

In a separate terminal session, confirm the application is running:

curl -X 'GET' http://localhost:4000